MetaDatapage

Properties

Name Type Description
Attributes MetaCollection Returns the node's attribute collection. (See the Metadata Attributes reference.)

Count

Integer

Returns the number of child nodes.

Fields MetaCollection

Returns the node's field collection.

Index

Integer

Gets the index of the node in its parent.

NodeType TNodeType Returns the node type of the current Node.
Note that the TNodeType type is not defined in an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use.

Parent

Node

Returns the parent node of the current node.

Selected

Bool

Indicates whether or not the Node is set to be printed.

SelectedCount

Integer

Returns the number child nodes selected to be output. (See also: Including or excluding nodes from the output.)

SelectedState

Integer

Returns an integer indicating whether the node is selected or not, taking its parents into account.
0: The node is not selected.
1: The node is selected but one of its parents is not.
2: The node and all of its parents are selected.

Methods

Name Return type Description

Add(Integer Index)

Node

Adds a new child node to the current node.

AttributeByIndex(Integer Index)

String Returns the specified attribute's value.

AttributeByName(const String Name)

String Returns the value of the attribute of the specified name.

Clear()

 

Deletes all the child nodes as well as the attributes and fields.

Copy()

 

Places a copy of the node in the metadata clipboard.

Cut()   Removes the node and places it in the metadata clipboard.

Delete()

 

Deletes the node.

FieldByIndex(Integer Index)

String

Returns the specified field's value.

FieldByName(const String Name)

String

Returns the value of field of the specified name.

FieldByNameIndex(const String Name, Integer Index)

String

Returns the value of the N'th field of the specified name.

IndexInDocument()

Integer

Returns the index of this page in its parent document, taking all the pages from all the datapages into account.

IndexInGroup()

Integer

Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account.

IndexInJob()

Integer

Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account.

Item(Integer Index)

Node

Returns the child (node) item located at the specified index.

Page(Integer Index), see , see Item(Integer Index)

 

Returns the MetaPage at the specified index.

Paste()

Node

Inserts the clipboard's content as the last child of the current node.

PasteAt(Integer Index)

Node

Inserts the clipboard's content as a child node at the specified index.

Select(TSelectWhat SelectWhat)

 

Selects the child nodes according to the SelectWhat parameter.
The TSelectWhat type is not defined in an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use.

SelectedIndexInDocument()

Integer

Index of the page among all the selected pages in its parent Document.

SelectedIndexInGroup()

Integer

Index of the page among all the selected pages in its parent Group.

SelectedIndexInJob()

Integer

Index of the page among all the selected pages in the Job.

Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3)

 

Sorts the sub-nodes according to a number of criteria.