Method and attribute summary

The following table summarizes the attributes and methods associated with the X-document object. For complete reference entries, see ABL Reference.

Table 1. X-document attribute and method summary
This attribute or method . . . Lets you . . .
INITIALIZE-DOCUMENT-TYPE( ) method

ENCODING attribute
Initialize document and set prolog information.
SCHEMA-PATH attribute Specify a search path for the Document Type Definition (DTD) or any other external entities. If you provide a DTD (or an XML Schema document), then ABL can perform the appropriate validation on reads and writes of the DOM tree.
PUBLIC-ID attribute

SYSTEM-ID attribute
Determine the logical (public) name or system name of the document's DTD.
NAMESPACE-PREFIX attribute

NAMESPACE-URI attribute
Set namespace information at the document level.
SCHEMA-LOCATION attribute

ADD-SCHEMA-LOCATION( ) method
The SCHEMA-LOCATION attribute lets you specify a whitespace separated list of namespace and XML Schema location pairs. The ADD-SCHEMA-LOCATION( ) method allows you to add another pair to this list. X-document uses each XML Schema specified to validate XML elements with matching namespaces.
NONAMESPACE-SCHEMA-LOCATION attribute Specify a single namespace and XML Schema location pair. X-document uses the XML Schema specified to validate XML elements that do not specify a namespace.
SUPPRESS-NAMESPACE-PROCESSING attribute Disable namespace processing.
LOAD( ) method Create a complete DOM tree from an XML source document.
NAME attribute

SUBTYPE attribute
NAME is the name of the XML document.SUBTYPE is always DOCUMENT.
APPEND-CHILD( ) method

CREATE-NODE( ) method

CREATE-NODE-NAMESPACE( ) method

IMPORT-NODE( ) method

INSERT-BEFORE( ) method

REMOVE-CHILD( ) method

REPLACE-CHILD( ) method
Programmatically build or modify a DOM tree.
GET-DOCUMENT-ELEMENT( ) method

NUM-CHILDREN attribute

GET-CHILD( ) method
Traverse the DOM tree.
SAVE( ) method Write the DOM tree to an XML document.
TYPE attribute Get the type of the object, which is always X-DOCUMENT.
HANDLE attribute

INSTANTIATING-PROCEDURE attribute

UNIQUE-ID attribute
Get or set information concerning this particular X-document object.
ENTITY-EXPANSION-LIMIT attribute Set the maximum number of entity substitutions the XML parser will permit in a document.
STRICT-ENTITY-RESOLUTION attribute Set whether or not the XML parser will attempt to resolve an external entity if the entity is located outside of the directories in the SCHEMA-PATH attribute.

The following table describes the attributes and methods that comprise the functionality of the X-noderef object. For complete reference entries, see ABL Reference.

Table 2. X-noderef attribute and method summary
This attribute or method . . . Lets you . . .
ATTRIBUTE-NAMES attribute

GET-ATTRIBUTE( ) method

GET-ATTRIBUTE-NODE( ) method

REMOVE-ATTRIBUTE( ) method

SET-ATTRIBUTE( ) method

SET-ATTRIBUTE-NODE( ) method
Manage the relationships this node has with attribute nodes.Since a DOM attribute node is not a child of the element it is associated with, you must explicitly create the relationship from a node of subtype ELEMENT to the node of subtype ATTRIBUTE.
APPEND-CHILD( ) method

CHILD-NUM attribute

GET-CHILD( ) method

GET-PARENT( ) method

INSERT-BEFORE( ) method

NUM-CHILDREN attribute

REPLACE-CHILD( ) method

REMOVE-CHILD( ) method
Manage the parent-child relationships this node has with other nodes.
LOCAL-NAME attribute

NAMESPACE-PREFIX attribute

NAMESPACE-URI attribute
Manage node namespaces.
NODE-VALUE attribute

LONGCHAR-TO-NODE-VALUE( ) method

NODE-VALUE-TO-LONGCHAR( ) method

MEMPTR-TO-NODE-VALUE( ) method

NODE-VALUE-TO-MEMPTR( ) method
Set the content of the node and retrieve that content in various data formats.
OWNER-DOCUMENT attribute Get the name of the X-document object the current X-noderef is associated with.
CLONE-NODE( ) method Perform a copy of an existing node to the current node, or perform a deep copy of the subtree that this node parents.
NORMALIZE( ) method Remove empty text nodes, merge adjacent text nodes, and clean up whitespace in ATTRIBUTE nodes such that the output of the DOM tree conforms to the XML specifications.
DELETE-NODE( ) method Disconnects and removes this node and all of its descendent nodes from its associated X-document object.
NAME attribute

SUBTYPE attribute
These attributes let you determine node type. The subtype is the DOM node type of the X-noderef object. The value of the NAME attribute and the NODE-VALUE attribute depend on the SUBTYPE attribute. See Table  for more information.
TYPE attribute Get the type or the object, which is always X-NODEREF.
HANDLE attribute

INSTANTIATING-PROCEDURE attribute

UNIQUE-ID attribute
Get or set information concerning this particular X-document object.