AttributeDefs

AttributeDefs

The element definition’s attribute definitions.

BannerText

string

Property of element definition object, FO_ElementDef. Users can set, change or query the banner text associated with an element definition object.

Comment

string

Text string of the comment.

InitStructurePattern

string

The initial structure pattern; for table elements, a comma delimited string that specifies the necessary child elements to automatically insert.

ElementDefType

int

Type of formatter object represented by the element with element definition.Constants.FV_FO_CONTAINER (1) identifies a container element. Other values identify object (non-container) elements.

The value is one of:

•Constants.FV_FO_UNSPECI­FIED (0)

•Constants.FV_FO_CON­TAINER (1)

•Constants.FV_FO_SYS_VAR (2)

•Constants.FV_FO_XREF (3)

•Constants.FV_FO_MARKER (4)

•Constants.FV_FO_FOOT­NOTE (5)

•Constants.FV_FO_GRAPHIC (6)

•Constants.FV_FO_EQN (7)

•Constants.FV_FO_TBL (8)

•Constants.FV_FO_TBL_TITLE (9)

•Constants.FV_FO_TBL_­HEADING (10)

•Constants.FV_FO_TBL_BODY (11)

•Constants.FV_FO_TBL_­FOOTING (12)

•Constants.FV_FO_TBL_ROW (13)

•Constants.FV_FO_TBL_CELL (14)

ElementInCatalog

int

1 if the element is in the Element Catalog.

ElementPgfFormat

string

The name of the paragraph format applied to the element.

Exclusions

Strings

List of excluded elements.

FirstPgfRules

Objects

The IDs of the first paragraph format rules (FO_FmtRule IDs).

note:    To set the format rules for an element definition, use NewFmtRuleObject().

GeneralRule

string

Text of the element’s general rule.

GeneralRuleErrorOffsets

Ints

Contains the error offsets (two positions are specified only if the content rule is ambiguous).

Inclusions

Strings

List of included elements.

LastPgfRules

Objects

The IDs of the last paragraph format rules (FO_FmtRule IDs).

Name

string

Name of the element definition.

NextElementDefInDoc

ElementDef

Next element definition in the document’s list of element definitions (FO_ElementDef ID).

ObjectFmtRules

Objects

The IDs of the object format rules (FO_FmtRule IDs).

PrefixRules

Objects

The IDs of the prefix format rules (FO_FmtRule IDs).

SuffixRules

Objects

The IDs of the suffix format rules (FO_FmtRule IDs).

TextFmtRules

Objects

The IDs of the text format rules (FO_FmtRule IDs).

ValidHighestLevel

int

1 if the element can be used as the highest-level element for a flow.

ElementDataType

int

Retrieves/sets the data type of Element. The possible values are one of:

•Constants.FV_DT_UNSPECI­FIED(0)

•Constants.FV_DT_IN­TEGER(1)

•Constants.FV_DT_FLOAT(2)

AllowedDataRange

Defines the permissible range of values for the values defined in the ElementDataType property.

DescriptiveTag

string

A small description about the element. If the user specifies this in the EDD, then the element description can be viewed in the Element Catalog of the structured document.

ElementDescription

string

Reserved for future use.

AlsoInsert

Strings

The list of the tags of child elements that are automatically inserted when an element is initially added.

AlsoInserts

TypedVal

The list of list of the tags of child elements that are automatically inserted when an element is initially added.

For example: Setting the AlsoInsertsproperty of element definition of A to [[a1, a11],[a2, a21]], will automatically insert all child elements of A [a1, a2, a11 and a21] when A is inserted.