GetHTML Method (HTMLCONTROL)

10.9, PLBCMP GUI Only

The GetHTML method retrieves the inner HTML from a HTML element contained in a HTMLCONTROL object. The method gets the inner HTML 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 containing the inner HTML 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,OVER, ZERO

Note the following:

1. This method retrieves the inner HTML value from a HTML element contained in a HTMLCONTROL object.

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

3. The OVER and ZERO Condition Flags are always cleared.

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.

Example of GetHTML Method:

For a HTMLCONTROL that contains a HTML element as follows:

<div id=MyDiv'><p>Hello</p></div>

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

     HtmlControl.GetHTML Giving MyValue Using *ID="MyDiv" 

In this example, the inner HTML value is retrieved from the HTML element with the id attribute of "MyDiv".

The MyValue variable returns a string as follows:

     <p>Hello</p>

See Also: HTMLCONTROL Method Syntax