Class: GuideNode

GuideNode


new GuideNode()

Base Class for all the Adaptive Form Objects in Scripting API. All the objects inherit from this class

Since:
  • 6.0

Members


<readonly, non-null> name :string

Name of the node

Type:
  • string
Since:
  • 6.0

<readonly, non-null> somExpression :string

SOM Expression of the Node.

In Adaptive Forms SOM is a model to access fields and Panels. The SOM Expression provides easy access to the Fields and Objects through a straightforward syntax

Type:
  • string
Since:
  • 6.0
Example
Considering the heirarchy,
-- guide
  -- panel1
  ---- field2
  ---- panel2
  ------ field3
the som Expression of field3 will be guide[0].panel1[0].panel2[0].field3[0]. The 0 here represents
the same name sibling index of that particular item in its parent. If panel2 has an additional child field3 as
  ---- panel2
  ------- field3
  ------- field3
The second field3 would have the somExpression guide[0].panel1[0].panel2[0].field3[1]

<readonly, nullable> title :string

Title of the element, localized as per the locale of the form.

Returns the localized version of the title. In case of Fields it is the Caption of the Field.

Type:
  • string
Since:
  • 6.0

<readonly, nullable> nonLocalizedTitle :string

Non Localized Title of the element.

Type:
  • string
Since:
  • 6.0

<readonly, non-null> panel :Panel

Parent panel in which the Node is added

Type:
Since:
  • 6.0

<readonly, non-null> index :number

Index of the Node among its siblings having the same name as itself

Every node in the Adaptive Form field has an index depending on the number of same named siblings that the node has before it. I

Type:
  • number
Since:
  • 6.0

<readonly> visible :boolean

Visiblity of the Node. True if it's visible otherwise false.

The API always returns true for Node objects. The visibility of only Scriptable objects can be changed.

Type:
  • boolean
Since:
  • 6.0

<readonly> enabled :boolean

Specify whether the component is enabled or not.

The API always returns true for Node objects. The visibility of only Scriptable objects can be changed.

Type:
  • boolean
Since:
  • 6.0

Methods


prepare()

Prepares the Node by executing its scripts, managing its dependencies with other nodes.

Since:
  • 6.0

visit(callback, context)

Executes a callback on the element and its children.

The callback is called for the element and all its children.

Parameters:
Name Type Description
callback GuideNode~VisitorCallback
context Object

this parameter to be used

Since:
  • 6.0

Type Definitions


VisitorCallback(node)

Callback to be passed to the visitor function

Parameters:
Name Type Description
node GuideNode

Node on which the GuideNode#visit was called