GetEnable Method (HTMLCONTROL)

10.9, PLBCMP GUI Only

The GetEnable method retrieves the data-plbenable attribute from a HTML element contained in a HTMLCONTROL object. The method gets the data-plbenable attribute from the HTML element that has an id attribute that matches the id parameter. This method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A HTMLCONTROL that is accessed.

return

Optional. A Character String Variable that returns a string from a HTML element.

Id

Required. A Character String Variable or literal that contains the HTML element id attribute.

flags

Optional. A Numeric Variable or decimal value that specifies a bit mask value that controls the behavior of this method.

Flags Affected: EOS

Note the following:

1. This method retrieves the data-plbenable attribute value from a HTML element contained in a HTMLCONTROL object.

2. When the 'data-plbenable' is set to on, the PL/B ENABLED property enables or disables those HTML objects.

3. The EOS flag is set if the returned data string is larger than the DIM variable used to receive the data.

4. The {id} is a value that determines the HTML element used for data retrieval. The {id} string is matched against the id attribute of the HTML element.

5. The {flags} parameter is a bitmask value that forces specialized behaviors for the execution of this method.

6. The {return} string contains the value of the attribute.

Example of GetEnable Method:

For a HTMLCONTROL that contains a HTML element as follows:

<input type='text' class='myClass' data-plbenable='on' data-plbevent='change keypress click focus' id='MyEdit'>

This PL/B GetEnable method returns a value using the following instruction:

     HtmlControl.GetEnable Giving MyValue Using *ID="MyEdit" 

In this example, the data-plbenable HTML attribute is retrieved from the HTML element with the id attribute of "MyEdit".

The MyValue variable returns a string as follows:

     on

See Also: HTMLCONTROL Method Syntax