Node Object

Build 1501 on 14/Nov/2017  This topic last edited on: 21/Nov/2014, at 10:44

The node object provides control over an individual node (element) in the article tree.

Methods and properties

Basics

Label Method Returns the label of the node
Id Method Returns the internal unique id of the node.
Level Method Returns the level of the node.
IsMultiple Method Returns true if the node is part of a sequence of multiple nodes of the same type.
Number Method Returns the sequential number of the node.
TypeId Method Returns the type id of the node, or 0 if on root
TypeName Method Returns the type name of the node, or 'article' if on root.

Geometry

Depth MethodReturns the justification depth of the text of the node expressed in thousandths of point.
WordsInArea Method Returns the estimated number of words fitting in the geometry of the text of the node.
IsLinked Method Returns true if the text of the node is linked to a page.
LinkedStatus Method Returns the node's linked/linkable status.

Parent node

GetChild Method Returns a node object corresponding to the child of the node.

Get text

GetTxt Method Returns a text object, belonging to the node.
HasTxt Method Returns true if the node belongs to a text.
TedText Property Returns the text contained in the node complete with all its tags and special characters.
Text Property Returns the plain ASCII text contained in the node.

Text statistics

NC Method Returns the number of characters in the text of the node.
NL MethodReturns the number of lines in the text of the node.
NNP MethodReturns the number of non-fitting paragraphs in the text of the node.
NP MethodReturns the number of paragraphs in the text of the node.
NW Method Returns the number of words in the text of the node.
OverfullN Method Returns the number of overfull lines in the text of the node.
Depth Method Returns the justification depth of the text of the node.
OverH Method Returns the overset depth of the text of the node.
OverN Method Returns the number of overset lines in the text of the node.
JustErrorN Method Returns the number of justification errors in the text of the node.

Schema data

TypeContent Method Returns the value of the content in the GN4 schema for the given type.
TypeDescription Method Returns the type decription of the node in the GN4 schema.
TypeKind Method Returns the value of the typeKind in the GN4 schema for the given type.
TypeLink Method Returns the value of the typeLink in the GN4 schema for the given type.
TypeModel Method Returns the type model.
TypeReference Method Returns the value of the reference in the GN4 schema for the given type.
TypeTextElement Method Returns the type text element.

See also

To create a Node object