XML Form Object Model Class Hierarchy

The XML Form Object Model consists of models that each contain a set of objects. Each object is derived from one of the set of classes that define common properties and methods. An object inherits these common properties and methods but may also add properties and methods that are unique to that object, relative to other objects derived from the same class.

As with traditional class structures, each class inherits properties and methods from its parent class. Objects, in turn, inherit from the parent class from which they derive.

Each model uses a hierarchy of objects. Objects do not inherit properties and methods from other objects, but instead inherit directly from the class hierarchy. The hierarchy of objects within a model represents the XML structure of that model.

object class

The object class is the base class from which all other classes, objects, and models are either directly or indirectly derived.

Class hierarchy

Parent class

Current class

Objects derived from this class

None

object

dataWindow

eventPseudoModel

hostPseudoModel

layoutPseudoModel

signaturePseudoModel

Properties

Name

Description

Type

Access

className

Determines the name of the class of this object.

String

Get

Methods

None

list class

The list class represents a list of nodes.

Class hierarchy

Parent class

Current class

Objects derived from this class

object class

list

None

Properties

Name

Description

Type

Access

length

Specifies the number of objects in the list.

Integer

Read

Methods

Name

Description

Returns

append

Appends a node to the end of the node list.

Empty

insert

Inserts a node before a specific node in the node list.

Empty

item

Describes a zero-based index into the collection.

Object

remove

Removes a node from the node list.

Empty

treeList class

The treeList class represents a list of tree nodes.

Class hierarchy

Parent class

Current class

Objects derived from this class

list

treeList

None

Properties

None

Methods

Name

Description

Returns

namedItem

Gets the first child of this node with the given name.

Object

tree class

The tree class represents the structure from which the node class class is derived.

Class hierarchy

Parent class

Current class

Objects derived from this class

object class

tree

None

Properties

Name

Description

Type

Access

all

Returns a collection of like-named, in-scope nodes.

Object

Read

classAll

Returns a collection of like-class, in-scope nodes.

Object

Read

classIndex

Returns the position of this object in its collection of like-class, in-scope objects.

Integer

Read

index

Returns the position of this node in its collection of like-named, in-scope nodes.

Integer

Read

name

Specifies an identifier that may be used to specify this object or event in script expressions.

String

Read /Write

nodes

Returns a list of all child objects of the current object.

Object

Read

parent

Returns the parent object of the current object.

Object

Read

somExpression

Reads the reference syntax expression for this node.

String

Read

Methods

Name

Description

Returns

resolveNode

Evaluates the specified reference syntax expression, beginning with the current XML form object model object, and returns the value of the object specified in the reference syntax expression.

Object

resolveNodes

Evaluates the specified reference syntax expression, beginning with the current XML form object model object, and returns the value of the object or objects specified in the reference syntax expression.

Object

node class

The node class represents the primary data type for XML Form Object Model objects.

Properties

Name

Description

Type

Access

id

Specifies a generic user-defined XML ID type.

String

Read /Write

isContainer

Specifies whether this object is a container object.

Boolean

Read

isNull

Indicates whether the current data value is the null value.

Boolean

Read

model

Specifies the model for the current object.

Object

Read

ns

Returns the namespace for the object.

String

Read

oneOfChild

Retrieves or sets that child object in the case where a parent object can only have one of a particular child object.

Object

Read /Write

Methods

Name

Description

Returns

applyXSL

Applies an XSL transformation to the XML representation of the current node. It is equivalent to calling saveXML and transforming the result with the specified XSL document.

String

assignNode

Evaluates the reference syntax expression using the current context and sets the value of the found node. If the node doesn’t exist, it can be created.

Object

clone

Makes a copy of an object.

Object

getAttribute

Gets a specified property value.

String

getElement

Returns a specified child object.

Object

isPropertySpecified

Checks if a specific property has been defined for this node.

Boolean

loadXML

Loads and appends a specified XML document to the current object.

Empty

saveFilteredXML

Saves the current node to a string, but includes only a subset of the child nodes.

String

saveXML

Saves the XML structure of the current “node class” on pagevii to a string.

String

setAttribute

Sets the value of a specified property.

Empty

setElement

Sets a specified object to be the current object.

Empty

container class

The container class provides container objects for the form model.

Class hierarchy

Properties

None

Methods

Name

Description

Returns

getDelta

Gets a delta script object for a specific property.

Object

getDeltas

Recursively gets all the delta script objects for this container object and all its descendants.

Object

content class

The content class provides content objects for the form and template models. Form designs and completed forms are visually composed of objects that represent content, such as images and text.

Class hierarchy

Parent class

Current class

Objects derived from this class

node class

content

boolean

date

dateTime

decimal

exData

float

integer

text

time

Properties

None

Methods

None

model class

The model class is the base class for the root objects of each model.

Class hierarchy

Parent class

Current class

Objects derived from this class

node class

model

connectionSet

dataModel

form

template

sourceSet

xfa

Properties

Name

Description

Type

Access

aliasNode

Specifies the object that is represented by the alias for this model.

Object

Read /Write

context (deprecated)

Specifies the current object, which is the starting object for the “resolveNode” on pagecccli and “resolveNodes” on pageccclii methods.

Object

Read /Write

Methods

Name

Description

Returns

clearErrorList

Removes all items from the current error log.

Empty

createNode

Creates a new node based on a valid class name.

Object

isCompatibleNS

Determines if a specified namespace is functionally equivalent, that is compatible, with the namespace of this model. It determines if the two namespaces are equivalent, even though the strings that represent them may not be identical.

Boolean

textNode class

The textNode class represents objects that store textual data directly instead of using the #text object derived from the node class class.

Properties

Name

Description

Type

Access

{default}

Represents the actual value stored by an object.

String

Read /Write

value

Specifies the value of the current object.

String

Read /Write

Methods

None

// Ethnio survey code removed