Share via

XMLlist and XMLrecord Properties

  • Article

Certain properties associated with HTML Component (HTC) events, and certain properties of the HTCs themselves, return two different variations of the standard data record format, as nested XML DOM objects starting with an XMLDOMElement object. The two variations are an XMLlist, which contains multiple records, and an XMLrecord, which contains a single record.

The following table shows the circumstances under which the relevant HTCs make use of properties of these forms.

HTC XMLlist and XMLrecord Usage
DynamicTable HTC XMLlist:
  • XMLlist property of the window.event object in OnChange event.

  • XMLlist HTC property.

XMLrecord: Not used.
ListEditor HTC XMLlist:
  • XMLlist property of the window.event object in OnChange event.

  • XMLlist HTC property.

XMLrecord:

  • XMLrecord property of the window.event object in OnEdit event.

  • XMLrecord property of the window.event object in OnNew event.
ListSheet HTC XMLlist:
  • XMLlist HTC property.

XMLrecord:

  • XMLrecord property of the window.event object in OnRowSelect event.

  • XMLrecord property of the window.event object in OnRowUnselect event.

XMLlist Structure

The structure of the XMLlist property is as follows. The top level node is an XMLDOMELement object with its tagName property set to "document".

<document>
    <record>
        <dataid1>data</dataid1>
        <dataid2>data</dataid2>
        . . .
    </record>
    <record>
        <dataid1>data</dataid1>
        <dataid2>data</dataid2>
        . . .
    </record>
    . . .
</document>

When used as a property in the DynamicTable and ListEditor HTCs, both of which allow changes to the data, an additional attribute, named state, is associated with each record element. The state attribute can have four possible values: an empty string indicating that the record is unchanged, "new" indicating that the record is new, "changed" indicating that the record has been changed, and "deleted" indicating that the record has been deleted.

XMLrecord Structure

The structure of the XMLrecord property is as follows. The top level node is an XMLDOMELement object with its tagName property set to "record".

<record>
    <dataid1>data</dataid1>
    <dataid2>data</dataid2>
    . . .
</record>


All rights reserved.