Compound Class Methods
In this section, the Compound class methods are presented in alphabetical order.
Syntax
Clear()
Description
Use the Clear method to reset all of the primitives of the Compound object as follows:
Boolean primitives: False
Decimal and integer primitives: 0
String primitives: An empty string
Parameters
None.
Returns
A Boolean value: True if the method executed successfully, False otherwise.
Example
&Document = &Map.GetDocument();
&COM = &Document.DocumentElement;
&bRet = &COM.Clear();
Syntax
GetParent()
Description
Use this method to return the parent object of the compound element.
Parameters
None.
Returns
A Collection object or a Compound object.
Syntax
GetPath()
Description
Use this method to return the absolute path to the compound element within the document's structure.
For example, for the Items compound of the PuchaseOrder document, GetPath would return the following absolute path:
PurchaseOrder/Item_Collection/ItemsParameters
None.
Returns
A string representing the absolute path to the compound element.
Syntax
GetPropertyByIndex(index)
Description
Use this method to return a property of the compound element as an object.
Parameters
None.
|
Field or Control |
Definition |
|---|---|
| index |
Specifies the index number of the property as an integer. |
Returns
A Collection object, a Compound object, or a Primitive object.
Syntax
GetPropertyByName(prop_name)
Description
Use this method to return a property of the compound element as an object.
Parameters
|
Field or Control |
Definition |
|---|---|
| prop_name |
Specifies the name of the property as a string. |
Returns
A Collection object, a Compound object, or a Primitive object.
Syntax
GetUniqueKey()
Description
Use this method to return the key information for this compound—that is, the package name, document name, and document version.
Parameters
None.
Returns
An array of string with three elements: package name, document name, and document version.