SetEnable Method (HTMLCONTROL)

10.9, PLBCMP GUI Only

The SetClass method changes the data-plbenable attribute in a HTML element contained in a HTMLCONTROL object. The method sets thedata-plbenable attribute in 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 Numeric Variable that always returns zero.

Id

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

value

Required. A Character String Variable or literal that has the value string of on or off.

flags

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

Flags Affected: OVER, ZERO

Note the following:

1. This method sets 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 ZERO flag is always set TRUE.

4. The OVER flag is always set FALSE.

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

6. The valid values for the {value} parameter are on or off.

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

8. The {return} value will always be zero.

Example of SetEnable 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 SetEnable method changes the data-plbenable value using the following instruction:

     HtmlControl.SetEnable Using *ID="MyEdit",*Enable="off" 

In this example, the new HTML element is updated as follows:

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

See Also: HTMLCONTROL Method Syntax