Primitive Class Methods

In this section, the Primitive class methods are presented in alphabetical order.

Syntax

GetEnumName(index)

Description

Use this method to return the name of the enumerated value.

Parameters

Field or Control

Definition

index

Specifies the index of the enumerated value.

Returns

A string representing the enumerated value.

Syntax

GetParent()

Description

Use this method to return the parent object of the primitive element.

Parameters

None.

Returns

A Collection object or a Compound object.

Syntax

GetPath()

Description

Use this method to return the absolute path to the primitive within the document's structure.

For example, for the Name primitive of the ShipTo compound of the PuchaseOrder document, GetPath would return the following absolute path:

PurchaseOrder/ShipTo/Name

Parameters

None.

Returns

A string representing the absolute path to the primitive.