Properties of FB_XmlItemsUtility

Overview

Name

Data type

Access

Description

IsElementSelected

BOOL

Read

Indicates TRUE if an element is selected.

A call of this property returns Ok.

NameOfParentElement

STRING[Gc_uiXmlLengthOfString]

Read

Provides the name of the parent element of the selected element.

If the name of the parent element is a null string, either no element is selected or the element is the root element and has no parent. Use the property IsElementSelected to validate a null string value.

A call of this property returns either Ok, ElementNotFound, or NoElementSelected.

NameOfSelectedElement

STRING[Gc_uiXmlLengthOfString]

Read

Provides the name of the selected element.

If the name of the element is a null string, no element is selected.

A call of this property returns either Ok or NoElementSelected.

NumberOfAttributes

INT

Read

Provides the number of attributes of the selected element.

If the returned value is -1, no element is selected.

A call of this property returns either Ok or NoElementSelected.

NumberOfChildElements

INT

Read

Provides the number of child elements of the selected element.

If the returned value is -1, no element is selected.

A call of this property returns either Ok or NoElementSelected.

NumberOfParentElements

INT

Read

Provides the number of parent elements of the selected element.

If the returned value is -1, no element is selected.

A call of this property returns either Ok or NoElementSelected.

Result

ET_Result

Read

Provides the result of the recently called method or property.

A call of this property does not affect the result itself.

ValueOfSelectedElement

STRING[Gc_uiXmlLengthOfString]

Read/write

Retrieves or sets the value of the selected element.

If the returned value is a null string, either no element is selected or the element has no value. Use the property IsElementSelected to validate a null string value.

A call of this property returns either Ok or NoElementSelected.