TreeViewFunctions

Last Updated:10/20/2016 04:47:15

Actions for working with TreeView objects


RJ Implementation: For each command, the 5th parameter "TextValue" must be given as full path with separator "->". Example: "Parent->Child"

[How To Read This Reference]
ActivateUnverifiedTextNode
RC RJ
Action to (almost) blindly activate (double-click) a text node.
CaptureTreeDataToFile
RC RJ TC SE2
Copy the current contents of a tree[branch] to a file.
CheckTextNode
RC
Checks a node's state icon (checkbox) according to its associated text value.
ClickPartial
RC RJ TC SE2
Action to click a node according to a partial match of its text value.
ClickTextNode
RC RJ TC SE2
Action to click a node according to its text value.
ClickUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly click a text node.
Collapse
RC RJ TC SE2
Action to collapse a node according to its text value.
CollapsePartial
RC RJ TC SE2
Action to collapse a node according to a partial match of its text value.
CollapsePartialTextNode
RC RJ
Action to collapse a node according to a partial match of its text value.
CollapseTextNode
RC RJ WR TC
Action to collapse a node according to its text value. Use Collapse instead.
CollapseUnverifiedTextNode
RC RJ SE2
Action to blindly collapse a node according to its text value.
CtrlClickUnverifiedTextNode
RJ SE2
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only.
DoubleClickPartial
RC RJ TC SE2
Action to double click a node according to a partial match of its text value.
DoubleClickTextNode
RC RJ TC SE2
Action to double click a node according to its text value.
DoubleClickUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly activate (double-click) a text node.
Expand
RC RJ TC SE2
Action to expand a node according to its text value.
ExpandPartial
RC RJ TC SE2
Action to expand a node according to a partial match of text value.
ExpandPartialTextNode
RC RJ
Action to expand a node according to a partial match of text value.
ExpandTextNode
RC RJ WR TC
Action to expand a node according to its text value. Use Expand instead.
ExpandUnverifiedTextNode
RC RJ SE2
Action to blindly expand a node according to its text value.
PartialMatchTreeDataToFile
RC RJ
Copy the current contents of a tree[branch] to a file according to a partial match of itss text value.
RightClickPartial
RC RJ TC SE2
Action to right click a node according to a partial match of its text value.
RightClickTextNode
RC RJ TC SE2
Action to right click a node according to its text value.
RightClickUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly right-click a text node.
Select
RC RJ TC SE2
Action to select a node according to its text value.
SelectAnotherPartialTextNode
RC RJ
Action to select a node according to a partial match of its text value, in addition to any nodes already selected. Performs selection as if CTRL key were held down during selection.
SelectAnotherTextNode
RC RJ
Action to select a node according to its text value, in addition to any nodes already selected.
SelectAnotherUnverifiedTextNode
RC RJ
Action to blindly select a node according to its text value, in addition to any nodes already selected.
SelectPartial
RC RJ TC SE2
Action to select a node according to a partial match of its text value.
SelectPartialTextNode
RC RJ TC
Action to select a node according to a partial match of its text value. Performs selection as if CTRL key were held down during selection.
SelectPartialTextNodeSpecial
TC
Holds down either Ctrl or Shift while making an item selection with emulating either a Left or Right mouse click. The Selection is made according to a partial match of its text value.
SelectStateIcon
RC
Deprecated For:CheckTextNode
SelectTextNode
RC RJ WR TC
Action to select a node according to its text value.
SelectTextNodeSpecial
TC
Holds down either Ctrl or Shift while making an item selection with emulating either a Left or Right mouse click.
SelectUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly click a text node.
SelectUnverifiedTextNodeRightClick
RC TC
Deprecated For:RightClickUnverifiedTextNode
SetTreeContainsNode
RC RJ TC SE2
Sets a user-defined variable with the result of whether a tree contains the provided node.
SetTreeContainsPartialMatch
RC RJ SE2
Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value.
ShiftClickUnverifiedTextNode
RJ SE2
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only.
UnCheckTextNode
RC
UnChecks a node's state icon (checkbox) according to its associated text value.
VerifyNodeUnselected
RC RJ WR TC SE2
Action to verify a particular text node is NOT selected.
VerifySelectedNode
RC RJ WR TC SE2
Action to verify a particular text node is selected.
VerifyStateIcon
RC
Deprecated For:VerifyTextNodeChecked
VerifyStateIconUnselected
RC
Deprecated For:VerifyTextNodeUnChecked
VerifyTextNodeChecked
RC
Action to verify a particular state icon is selected.
VerifyTextNodeUnChecked
RC
Action to verify a particular state icon is NOT checked.
VerifyTreeContainsNode
RC RJ TC SE2
Verify that a tree contains the provided node.
VerifyTreeContainsPartialMatch
RC RJ TC SE2
Verify that a tree contains the provided node according to a partial match of the node's text value.

TreeViewFunctions::ActivateUnverifiedTextNode
RC RJ

Action to (almost) blindly activate (double-click) a text node.

No attempt is made to verify that the node exists prior to the selection. No attempt to verify the node has been properly selected after the selection.

It should be noted that a click requires the full hierarchical path to the node to be selected. Parent child branches are delimited with '->' as in:
Parent->branch->leaf

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be clicked

    TextValue is the case-sensitive text of the node to be clicked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
[How To Read This Reference]

TreeViewFunctions::CaptureTreeDataToFile
RC RJ TC SE2

Copy the current contents of a tree[branch] to a file.

The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'PartialMatchTreeDataToFile' if you wish to specify case-insensitive substring matches for tree nodes.

By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Fields: [ ]=Optional with Default Value
  1. File
    The name of the file used to store the tree data.

    The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

  2. [ Branch = ]
    The full name of the tree branch to capture.

    The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

    The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'PartialMatchTreeDataToFile' if you wish to specify case-insensitive substring matches for tree nodes.

  3. [ IndentMark = ]
    The character(s) to use in the output file to indent the tree nodes from the parent tree branches.

    The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

  4. [ FileEncoding = ]
    Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.


  5. [ FilterMode = ]
    (Future) Specify a file filter to use to process the text before comparison.


  6. [ FilterOptions = ]
    (Future) Specify filter options to use with the file filter.


Examples:
[How To Read This Reference]

TreeViewFunctions::CheckTextNode
RC

Checks a node's state icon (checkbox) according to its associated text value.

Initially released with .NET support only.
This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be checked.

    TextValue is the case-sensitive text of the node to be checked.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
[How To Read This Reference]

TreeViewFunctions::ClickPartial
RC RJ TC SE2

Action to click a node according to a partial match of its text value.

Partial matching is accomplished through case-insensitive substring matching. Each delimited node of the provided TextValue is compared against the object data using this partial match comparison.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process. Only the final node provided in the TextValue hierarchy is evaluated for duplicity. Intermediate nodes are always found on a "first match" basis.


NOTE:
SE2 : Parameter text is case-sensitive substring of the tree node.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to click.

    TextValue is the case-insensitive text of the node to click. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
[How To Read This Reference]

TreeViewFunctions::ClickTextNode
RC RJ TC SE2

Action to click a node according to its text value.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to click.

    TextValue is the case-sensitive text of the node to click. Parent-Child relationships are separated by "->"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
[How To Read This Reference]

TreeViewFunctions::ClickUnverifiedTextNode
RC RJ TC SE2

Action to (almost) blindly click a text node.

No attempt is made to verify that the node exists prior to the selection. No attempt to verify the node has been properly selected after the selection.

It should be noted that a click requires the full hierarchical path to the node to be selected. Parent child branches are delimited with '->' as in:
Parent->branch->leaf

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.


NOTE:
SE2 : Implementation verifies the existence of the node, does NOT verify if it is selected.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be clicked

    TextValue is the case-sensitive text of the node to be clicked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
[How To Read This Reference]

TreeViewFunctions::Collapse
RC RJ TC SE2

Action to collapse a node according to its text value.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to collapse

    TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
[How To Read This Reference]

TreeViewFunctions::CollapsePartial
RC RJ TC SE2

Action to collapse a node according to a partial match of its text value.

Partial matching is accomplished through case-insensitive substring matching. Each delimited node of the provided TextValue is compared against the object data using this partial match comparison.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process. Only the final node provided in the TextValue hierarchy is evaluated for duplicity. Intermediate nodes are always found on a "first match" basis.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to collapse

    TextValue is the case-insensitive text of the node to collapse. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
[How To Read This Reference]

TreeViewFunctions::CollapsePartialTextNode
RC RJ

Action to collapse a node according to a partial match of its text value.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to collapse

    TextValue is the case-insensitive text of the node to collapse. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Examples:
  • T, WINDOW, AJTree, CollapsePartialTextNode, "Parent"
    This action collapses the "Parent" node.


  • T, WINDOW, AJTree, CollapsePartialTextNode, "parent->child"
    This action collapses the "Child" node found under "Parent".


[How To Read This Reference]

TreeViewFunctions::CollapseTextNode
RC RJ WR TC

Action to collapse a node according to its text value. Use Collapse instead.

This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.
RJ Implementation: Works the same as command Collapse.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to collapse

    TextValue is the case-sensitive text of the node to collapse
    RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, COLLAPSETEXTNODE, "MyNode"
    Collapses the first "MyNode" node.


  • T, WINDOW, TreeView, COLLAPSETEXTNODE, "MyNode", 3
    Collapses the 3rd duplicate "MyNode" node.


  • T, WINDOW, TreeView, COLLAPSETEXTNODE, "MyNode", "Index=3"
    Collapses the 3rd duplicate "MyNode" node.


[How To Read This Reference]

TreeViewFunctions::CollapseUnverifiedTextNode
RC RJ SE2

Action to blindly collapse a node according to its text value.

Generally, no pre- or post- node checks are done. If the tree contains hidden root nodes the user must provide these.
NOTE:
SE2 : Implementation verifies the existence of the node, does NOT verify if it is collapsed.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive full path text of node to collapse

    TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

Examples:
  • T, WINDOW, AJTree, CollapseUnverifiedTextNode, "root->Parent"
    This action blindly collapses the "Parent" node.

    The hidden root node 'root' is provided as required.

  • T, WINDOW, AJTree, CollapseUnverifiedTextNode, "root->Parent->Child"
    This action collapses the "Child" node found under "Parent".

    The hidden root node 'root' is provided as required.

[How To Read This Reference]

TreeViewFunctions::CtrlClickUnverifiedTextNode
RJ SE2

Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to CTRL-click.

    TextValue is the case-sensitive text of the node to CTRL-click. Parent-Child relationships are separated by "->"

Examples:
  • T, WINDOW, AJTree, CtrlClickUnverifiedTextNode, "Parent"
    This action CTRL-clicks the "Parent" node.


  • T, WINDOW, AJTree, CtrlClickUnverifiedTextNode, "Parent->Child"
    This action CTRL-clicks the "Child" node found under "Parent".


[How To Read This Reference]

TreeViewFunctions::DoubleClickPartial
RC RJ TC SE2

Action to double click a node according to a partial match of its text value.

Partial matching is accomplished through case-insensitive substring matching. Each delimited node of the provided TextValue is compared against the object data using this partial match comparison.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process. Only the final node provided in the TextValue hierarchy is evaluated for duplicity. Intermediate nodes are always found on a "first match" basis.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to double click.

    TextValue is the case-insensitive text of the node to double click. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, ATreeView, DoubleClickPartial, "parent"
    Double-Click the first node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, DoubleClickPartial, "parent", "3"
    Double-Click the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, DoubleClickPartial, "parent", "Index=3"
    Double-Click the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, DoubleClickPartial, "parent->child"
    Double-Click the 1st child node containing substring "child" under a parent node containing substring "parent".


  • T, WINDOW, ATreeView, DoubleClickPartial, "parent->child", "3"
    Double-Click the 3rd child node containing substring "child" under a parent node containing substring "parent".


[How To Read This Reference]

TreeViewFunctions::DoubleClickTextNode
RC RJ TC SE2

Action to double click a node according to its text value.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to double click.

    TextValue is the case-sensitive text of the node to double click. Parent-Child relationships are separated by "->"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, ATreeView, DoubleClickTextNode, "Parent"
    Double-click the 1st "Parent" node.


  • T, WINDOW, ATreeView, DoubleClickTextNode, "Parent", 3
    Double-click the 3rd duplicate "Parent" node.


  • T, WINDOW, ATreeView, DoubleClickTextNode, "Parent", "Index=3"
    Double-click the 3rd duplicate "Parent" node.


  • T, WINDOW, ATreeView, DoubleClickTextNode, "Parent->Child"
    Double-click the 1st "Child" node found under "Parent".


  • T, WINDOW, ATreeView, DoubleClickTextNode, "Parent->Child", 3
    Double-click the 3rd duplicate "Child" node found under "Parent".


[How To Read This Reference]

TreeViewFunctions::DoubleClickUnverifiedTextNode
RC RJ TC SE2

Action to (almost) blindly activate (double-click) a text node.

No attempt is made to verify that the node exists prior to the selection. No attempt to verify the node has been properly selected after the selection.

It should be noted that a click requires the full hierarchical path to the node to be selected. Parent child branches are delimited with '->' as in:
Parent->branch->leaf

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.


NOTE:
SE2 : Implementation verifies the existence of the node, does NOT verify if it is selected.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be clicked

    TextValue is the case-sensitive text of the node to be clicked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, DoubleClickUnverifiedTextNode, "MyParent->MyBranch->MyNode"
    Activate (double-click) the first "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, DoubleClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"
    Activate (double-click) the 3rd duplicate "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, DoubleClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"
    Activate (double-click) the 3rd duplicate "MyNode" node on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::Expand
RC RJ TC SE2

Action to expand a node according to its text value.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to expand

    TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, ATreeView, Expand, "Parent"
    Expands the first "Parent" node.


  • T, WINDOW, ATreeView, Expand, "Parent", 3
    Expands the 3rd duplicate "Parent" node.


  • T, WINDOW, ATreeView, Expand, "Parent", "Index=3"
    Expands the 3rd duplicate "Parent" node.


  • T, WINDOW, ATreeView, Expand, "Parent->Child"
    This action expands the "Child" node found under "Parent".


[How To Read This Reference]

TreeViewFunctions::ExpandPartial
RC RJ TC SE2

Action to expand a node according to a partial match of text value.

Partial matching is accomplished through case-insensitive substring matching. Each delimited node of the provided TextValue is compared against the object data using this partial match comparison.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process. Only the final node provided in the TextValue is evaluated for duplicity. Intermediate nodes are always found on a "first match" basis.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to match.

    TextValue is the case-insensitive text of the node. Parent-Child relationships are separated by "->". For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, ATreeView, ExpandPartial, "parent"
    Expands the first node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, ExpandPartial, "parent", "3"
    Expands the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, ExpandPartial, "parent", "Index=3"
    Expands the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, ExpandPartial, "parent->child"
    Expands the 1st child node containing substring "child" under a parent node containing substring "parent".


  • T, WINDOW, ATreeView, ExpandPartial, "parent->child", "3"
    Expands the 3rd child node containing substring "child" under a parent node containing substring "parent".


[How To Read This Reference]

TreeViewFunctions::ExpandPartialTextNode
RC RJ

Action to expand a node according to a partial match of text value.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to match.

    TextValue is the case-insensitive text of the node. Parent-Child relationships are separated by "->". For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Examples:
  • T, WINDOW, AJTree, ExpandPartialTextNode, "parent"
    This action successfully expands the "My New Parent" node.


  • T, WINDOW, AJTree, ExpandPartialTextNode, "parent->child"
    This action successfully expands the "My Stepchild" node found under "My New Parent".


[How To Read This Reference]

TreeViewFunctions::ExpandTextNode
RC RJ WR TC

Action to expand a node according to its text value. Use Expand instead.

This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.
RJ Implementation: Works the same as command Expand.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to expand

    TextValue is the case-sensitive text of the node to expand.
    RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, EXPANDTEXTNODE, "MyNode"
    Expands the first "MyNode" node.


  • T, WINDOW, TreeView, EXPANDTEXTNODE, "MyNode", "3"
    Expands the 3rd node with duplicate text "MyNode".


  • T, WINDOW, TreeView, EXPANDTEXTNODE, "MyNode", "Index=3"
    Expands the 3rd node with duplicate text "MyNode".


[How To Read This Reference]

TreeViewFunctions::ExpandUnverifiedTextNode
RC RJ SE2

Action to blindly expand a node according to its text value.

Generally, no pre- or post- node checks are done. If the tree contains hidden root nodes the user must provide these.
NOTE:
SE2 : Implementation verifies the existence of the node, does NOT verify if it is expanded.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive full path text of node to expand

    TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->". If the tree contains hidden root nodes the user must provide these.

Examples:
  • T, WINDOW, AJTree, ExpandUnverifiedTextNode, "root->Parent"
    This action blindly expands the "root->Parent" node.

    The hidden root node 'root' is provided as required.

  • T, WINDOW, AJTree, ExpandUnverifiedTextNode, "root->Parent->Child"
    This action blindly expands the "Child" node found under "Parent".

    The hidden root node 'root' is provided as required.

[How To Read This Reference]

TreeViewFunctions::PartialMatchTreeDataToFile
RC RJ

Copy the current contents of a tree[branch] to a file according to a partial match of itss text value.

The search of the path to the node is a case-insensitive substring match of each node. Use 'CaptureTreeDataToFile' if you wish to specify case-sensitive exact matches for tree nodes.

By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Fields: [ ]=Optional with Default Value
  1. File
    The name of the file used to store the tree data.

    The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

  2. [ Branch = ]
    The full name of the tree branch to capture.

    The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

    The search of the path to the node is a case-insensitive substring match of each node. Use 'CaptureTreeDataToFile' if you wish to specify case-sensitive exact matches for tree nodes.

  3. [ IndentMark = ]
    The character(s) to use in the output file to indent the tree nodes from the parent tree branches.

    The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

  4. [ FilterMode = ]
    (Future) Specify a file filter to use to process the text before comparison.


  5. [ FilterOptions = ]
    (Future) Specify filter options to use with the file filter.


Examples:
  • T, Browser, aTreeView, PartialMatchTreeDataToFile, aFilename.ext
    Capture the complete nodeset of aTreeView to a file.

    Data is stored in [project]\Datapool\Test\aFilename.ext file using tab chars to indent the nodes and branches. Because no Branch was specified, the data for the whole tree is captured.
    Note the unused reserved fields for FileFilter and FilterOptions were omitted.

  • T, Browser, aJavaTree, PartialMatchTreeDataToFile, myDirectory\aFilename.ext, "parent->branch", "_"
    Capture the data contents from the first child node of 'parent' containing 'branch' to a file.

    Thus, this could be a match for "Parent Bank->Branch Banking and Trust"
    Data is stored in [project]\myDirectory\aFilename.ext file using "_" chars to indent the nodes and branches. Because a Branch was specified, only nodes from that branch are captured.
    Note the unused reserved fields for FileFilter and FilterOptions were omitted.

[How To Read This Reference]

TreeViewFunctions::RightClickPartial
RC RJ TC SE2

Action to right click a node according to a partial match of its text value.

Partial matching is accomplished through case-insensitive substring matching. Each delimited node of the provided TextValue is compared against the object data using this partial match comparison.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process. Only the final node provided in the TextValue hierarchy is evaluated for duplicity. Intermediate nodes are always found on a "first match" basis.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to right click.

    TextValue is the case-insensitive text of the node to right click. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, ATreeView, RightClickPartial, "parent"
    Right-Click the first node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, RightClickPartial, "parent", "3"
    Right-Click the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, RightClickPartial, "parent", "Index=3"
    Right-Click the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, RightClickPartial, "parent->child"
    Right-Click the 1st child node containing substring "child" under a parent node containing substring "parent".


  • T, WINDOW, ATreeView, RightClickPartial, "parent->child", "3"
    Right-Click the 3rd child node containing substring "child" under a parent node containing substring "parent".


[How To Read This Reference]

TreeViewFunctions::RightClickTextNode
RC RJ TC SE2

Action to right click a node according to its text value.

It should be noted that a right click requires the full hierarchical path to the node to be selected. Parent child branches are delimited with '->' as in: Parent->branch->leaf

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be clicked

    TextValue is the case-sensitive text of the node to be clicked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, RightClickTextNode, "MyParent->MyBranch->MyNode"
    Single right-click the first "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, RightClickTextNode, "MyParent->MyBranch->MyNode", "3"
    Single right-click the 3rd duplicate "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, RightClickTextNode, "MyParent->MyBranch->MyNode", "Index=3"
    Single right-click the 3rd duplicate "MyNode" node on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::RightClickUnverifiedTextNode
RC RJ TC SE2

Action to (almost) blindly right-click a text node.

No attempt is made to verify that the node exists prior to the selection. No attempt to verify the node has been properly selected after the selection.

It should be noted that a click requires the full hierarchical path to the node to be selected. Parent child branches are delimited with '->' as in:
Parent->branch->leaf

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.


NOTE:
SE2 : Implementation verifies the existence of the node, does NOT verify if it is selected.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be clicked

    TextValue is the case-sensitive text of the node to be clicked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, RightClickUnverifiedTextNode, "MyParent->MyBranch->MyNode"
    Single Right-Click the first "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, RightClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"
    Single Right-Click the 3rd duplicate "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, RightClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"
    Single Right-Click the 3rd duplicate "MyNode" node on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::Select
RC RJ TC SE2

Action to select a node according to its text value.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.
RJ Implementation: Works the same as command Click.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to select.

    TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, ATreeView, Select, "Parent"
    Selects the 1st "Parent" node.


  • T, WINDOW, ATreeView, Select, "Parent", 3
    Selects the 3rd duplicate "Parent" node.


  • T, WINDOW, ATreeView, Select, "Parent", "Index=3"
    Selects the 3rd duplicate "Parent" node.


  • T, WINDOW, ATreeView, Select, "Parent->Child"
    Selects the first "Child" node found under "Parent".


  • T, WINDOW, ATreeView, Select, "Parent->Child", "3"
    Selects the 3rd duplicate "Child" node found under "Parent".


[How To Read This Reference]

TreeViewFunctions::SelectAnotherPartialTextNode
RC RJ

Action to select a node according to a partial match of its text value, in addition to any nodes already selected. Performs selection as if CTRL key were held down during selection.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to select.

    TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Examples:
  • T, WINDOW, AJTree, SelectAnotherPartialTextNode, "parent"
    This action selects the "My New Parent" node.


  • T, WINDOW, AJTree, SelectAnotherPartialTextNode, "parent->child"
    This action selects the "My Stepchild" node found under "My New Parent".


[How To Read This Reference]

TreeViewFunctions::SelectAnotherTextNode
RC RJ

Action to select a node according to its text value, in addition to any nodes already selected.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to select.

    TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

Examples:
  • T, WINDOW, AJTree, SelectAnotherTextNode, "Parent"
    This action selects the "Parent" node.


  • T, WINDOW, AJTree, SelectAnotherTextNode, "Parent->Child"
    This action selects the "Child" node found under "Parent".


[How To Read This Reference]

TreeViewFunctions::SelectAnotherUnverifiedTextNode
RC RJ

Action to blindly select a node according to its text value, in addition to any nodes already selected.

Generally, no pre- or post- node checks are done. If the tree contains hidden root nodes the user must provide these.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive full path text of node to select.

    TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

Examples:
  • T, WINDOW, AJTree, SelectAnotherUnverifiedTextNode, "root->Parent"
    This action blindly selects the "Parent" node.

    The hidden root node is provided as required.

  • T, WINDOW, AJTree, SelectAnotherUnverifiedTextNode, "root->Parent->Child"
    This action blindly selects the "Child" node found under "Parent".

    The hidden root node is provided as required.

[How To Read This Reference]

TreeViewFunctions::SelectPartial
RC RJ TC SE2

Action to select a node according to a partial match of its text value.

Partial matching is accomplished through case-insensitive substring matching. Each delimited node of the provided TextValue is compared against the object data using this partial match comparison.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process. Only the final node provided in the TextValue hierarchy is evaluated for duplicity. Intermediate nodes are always found on a "first match" basis.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to select.

    TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, ATreeView, SelectPartial, "parent"
    Select the first node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, SelectPartial, "parent", "3"
    Select the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, SelectPartial, "parent", "Index=3"
    Select the 3rd node with the substring "parent"--ignoring text case.


  • T, WINDOW, ATreeView, SelectPartial, "parent->child"
    Select the 1st child node containing substring "child" under a parent node containing substring "parent".


  • T, WINDOW, ATreeView, SelectPartial, "parent->child", "3"
    Select the 3rd child node containing substring "child" under a parent node containing substring "parent".


[How To Read This Reference]

TreeViewFunctions::SelectPartialTextNode
RC RJ TC

Action to select a node according to a partial match of its text value. Performs selection as if CTRL key were held down during selection.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text of node to select.

    TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Examples:
  • T, WINDOW, AJTree, SelectPartialTextNode, "parent"
    This action selects the "My New Parent" node.


  • T, WINDOW, AJTree, SelectPartialTextNode, "parent->child"
    This action selects the "My Stepchild" node found under "My New Parent".


[How To Read This Reference]

TreeViewFunctions::SelectPartialTextNodeSpecial
TC

Holds down either Ctrl or Shift while making an item selection with emulating either a Left or Right mouse click. The Selection is made according to a partial match of its text value.

This keyword can be used to select multiple items.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-Insensitive text (can be a part of whole text) of node to select.

    TextValue is the case-insensitive text (can be a part of whole text) of the node to select.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



  3. SpecialKey
    The special key command used in the row selection. For now, only Control and Shift are supported.


  4. MouseClick
    The type of mouse click needed. For now, only Left and Right are supported.


Examples:
  • T, WINDOW, ATreeView, SelectPartialTextNodeSpecial, "parent", , Shift, Left
    Make mouse-left-click on the first node with the substring "parent"--ignoring text case, in the same time the key 'Shift' is pressed down.


  • T, WINDOW, ATreeView, SelectPartialTextNodeSpecial, "parent", , Control, Left
    Make mouse-left-click on the first node with the substring "parent"--ignoring text case, in the same time the key 'Ctrl' is pressed down.


[How To Read This Reference]

TreeViewFunctions::SelectStateIcon (deprecated for: CheckTextNode)
RC

Select/check a node's state icon (checkbox) according to its associated text value.

This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be selected/checked.

    TextValue is the case-sensitive text of the node to be selected/checked.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, SELECTSTATEICON, "MyNode"
    Selects/checks the first "MyNode" node state icon (checkbox) on the TreeView object.


  • T, WINDOW, TreeView, SELECTSTATEICON, "MyNode", 3
    Selects/Checks the 3rd duplicate "MyNode" node state icon (checkbox) on the TreeView object.


  • T, WINDOW, TreeView, SELECTSTATEICON, "MyNode", "Index=3"
    Selects/Checks the 3rd duplicate "MyNode" node state icon (checkbox) on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::SelectTextNode
RC RJ WR TC

Action to select a node according to its text value.

This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.
RJ Implementation: Works the same as command Select.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be selected.

    TextValue is the case-sensitive text of the node to be selected.
    RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, SELECTTEXTNODE, "MyNode"
    Selects the first "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, SELECTTEXTNODE, "MyNode", 3
    Selects the 3rd duplicate "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, SELECTTEXTNODE, "MyNode", "Index=3"
    Selects the 3rd duplicate "MyNode" node on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::SelectTextNodeSpecial
TC

Holds down either Ctrl or Shift while making an item selection with emulating either a Left or Right mouse click.

This keyword can be used to select multiple items.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to select.

    TextValue is the case-sensitive text of the node to select.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



  3. SpecialKey
    The special key command used in the row selection. For now, only Control and Shift are supported.


  4. MouseClick
    The type of mouse click needed. For now, only Left and Right are supported.


Examples:
  • T, WINDOW, ATreeView, SelectTextNodeSpecial, "Parent", , Shift, Left
    Make mouse-left-click on the first node with the text "Parent" exactly matched, in the same time the key 'Shift' is pressed down.


  • T, WINDOW, ATreeView, SelectTextNodeSpecial, "Parent", , Control, Left
    Make mouse-left-click on the first node with the text "Parent" exactly matched, in the same time the key 'Ctrl' is pressed down.


[How To Read This Reference]

TreeViewFunctions::SelectUnverifiedTextNode
RC RJ TC SE2

Action to (almost) blindly click a text node.

No attempt is made to verify that the node exists prior to the selection. No attempt to verify the node has been properly selected after the selection.

It should be noted that a click requires the full hierarchical path to the node to be selected. Parent child branches are delimited with '->' as in:
Parent->branch->leaf

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.


NOTE:
SE2 : Implementation verifies the existence of the node, does NOT verify if it is selected.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be clicked

    TextValue is the case-sensitive text of the node to be clicked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, SelectUnverifiedTextNode, "MyParent->MyBranch->MyNode"
    Single click the first "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, SelectUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"
    Single click the 3rd duplicate "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, SelectUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"
    Single click the 3rd duplicate "MyNode" node on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::SelectUnverifiedTextNodeRightClick (deprecated for: RightClickUnverifiedTextNode)
RC TC

Skips many pre- and post-verification checks for right-clicks. Deprecated. Use RightClick instead.

We have also made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be clicked

    TextValue is the case-sensitive text of the node to be clicked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, SelectUnverifiedTextNodeRightClick, "MyParent->MyBranch->MyNode"
    Single right-click the first "MyNode" node on the TreeView object.


  • T, WINDOW, TreeView, SelectUnverifiedTextNodeRightClick, "MyParent->MyBranch->MyNode", "3"
    Single right-click the 3rd duplicate "MyNode" node on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::SetTreeContainsNode
RC RJ TC SE2

Sets a user-defined variable with the result of whether a tree contains the provided node.

The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'SetTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.



Fields: [ ]=Optional with Default Value
  1. Node
    The name of the node to verify.

    The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'SetTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.
    RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

  2. ResultVar
    The name of the variable which gets assigned the result.

    The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

Examples:
  • T, Browser, aTreeView, SetTreeContainsNode, "Parent Bank->Branch Banking and Trust", isFound
    Variable isFound will be set to 'TRUE' if the node 'Parent Bank->Branch Banking and Trust' is found in aTreeView. If not found, isFound will be set to 'FALSE'.


[How To Read This Reference]

TreeViewFunctions::SetTreeContainsPartialMatch
RC RJ SE2

Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value.

The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'SetTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.



Fields: [ ]=Optional with Default Value
  1. Node
    The name of the node to verify.

    The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'SetTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.
    RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

  2. ResultVar
    The name of the variable which gets assigned the result.

    The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

Examples:
  • T, Browser, aTreeView, SetTreeContainsPartialMatch, "parent->branch", isFound
    Variable isFound will be set to 'TRUE' if a child node of 'parent' containing 'branch' is found in aTreeView. If not found, isFound will be set to 'FALSE'.

    Thus, this could be a match for 'Parent Bank->Branch Banking and Trust'.

[How To Read This Reference]

TreeViewFunctions::ShiftClickUnverifiedTextNode
RJ SE2

Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to SHIFT-click.

    TextValue is the case-sensitive text of the node to SHIFT-click. Parent-Child relationships are separated by "->"

Examples:
  • T, WINDOW, AJTree, ShiftClickUnverifiedTextNode, "Parent"
    This action SHIFT-clicks the "Parent" node.


  • T, WINDOW, AJTree, ShiftClickUnverifiedTextNode, "Parent->Child"
    This action SHIFT-clicks the "Child" node found under "Parent".


[How To Read This Reference]

TreeViewFunctions::UnCheckTextNode
RC

UnChecks a node's state icon (checkbox) according to its associated text value.

Initially released with .NET support only.
This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of the node to be unchecked.

    TextValue is the case-sensitive text of the node to be unchecked.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, UnCheckTextNode, "MyNode"
    UnChecks the first "MyNode" node state icon (checkbox) on the TreeView object.


  • T, WINDOW, TreeView, UnCheckTextNode, "MyNode", 3
    UnChecks the 3rd duplicate "MyNode" node state icon (checkbox) on the TreeView object.


  • T, WINDOW, TreeView, UnCheckTextNode, "MyNode", "Index=3"
    UnChecks the 3rd duplicate "MyNode" node state icon (checkbox) on the TreeView object.


[How To Read This Reference]

TreeViewFunctions::VerifyNodeUnselected
RC RJ WR TC SE2

Action to verify a particular text node is NOT selected.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to be verified NOT selected

    TextValue is the case-sensitive text of the node to be verified NOT selected
    RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

Examples:
  • T, WINDOW, TreeView, VERIFYNODEUNSELECTED, "MyNode"
    This action verifies the "MyNode" node on the TreeView object is NOT selected


[How To Read This Reference]

TreeViewFunctions::VerifySelectedNode
RC RJ WR TC SE2

Action to verify a particular text node is selected.


Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to be verified selected

    TextValue is the case-sensitive text of the node to be verified selected
    RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

Examples:
  • T, WINDOW, TreeView, VERIFYSELECTEDNODE, "MyNode"
    This action verifies the "MyNode" node on the TreeView object is selected


[How To Read This Reference]

TreeViewFunctions::VerifyStateIcon (deprecated for: VerifyTextNodeChecked)
RC

Action to verify a particular state icon is selected/Checked.

Use VerifyTextNodeChecked instead (if supported).

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of state icon to be verified selected

    TextValue is the case-sensitive text of the state icon to be verified selected/checked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, VERIFYSTATEICON, "MyNode"
    Verifies the first "MyNode" node on the TreeView object is selected/checked.


  • T, WINDOW, TreeView, VERIFYSTATEICON, "MyNode", "3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is selected/checked.


  • T, WINDOW, TreeView, VERIFYSTATEICON, "MyNode", "Index=3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is selected/checked.


[How To Read This Reference]

TreeViewFunctions::VerifyStateIconUnselected (deprecated for: VerifyTextNodeUnChecked)
RC

Action to verify a particular state icon is NOT selected.

Use VerifyTextNodeUnChecked instead (if supported).

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of state icon to be verified NOT selected/checked

    TextValue is the case-sensitive text of the state icon to be verified NOT selected/checked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, VERIFYSTATEICONUNSELECTED, "MyNode"
    Verifies the first "MyNode" node on the TreeView object is NOT selected/checked.


  • T, WINDOW, TreeView, VERIFYSTATEICONUNSELECTED, "MyNode", "3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is NOT selected/checked.


  • T, WINDOW, TreeView, VERIFYSTATEICONUNSELECTED, "MyNode", "Index=3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is NOT selected/checked.


[How To Read This Reference]

TreeViewFunctions::VerifyTextNodeChecked
RC

Action to verify a particular state icon is selected.

Initially released with .NET support only.
This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of state icon to be verified selected/checked

    TextValue is the case-sensitive text of the state icon to be verified selected/checked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, VerifyTextNodeChecked, "MyNode"
    Verifies the first "MyNode" node on the TreeView object is selected/checked.


  • T, WINDOW, TreeView, VerifyTextNodeChecked, "MyNode", "3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is selected/checked.


  • T, WINDOW, TreeView, VerifyTextNodeChecked, "MyNode", "Index=3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is selected/checked.


[How To Read This Reference]

TreeViewFunctions::VerifyTextNodeUnChecked
RC

Action to verify a particular state icon is NOT checked.

Initially released with .NET support only.
This command might not function correctly when there are duplicate nodes in the tree. However, we have made it possible to attempt to select the Nth duplicate item with the optional MatchIndex parameter for those trees which we can properly process.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of state icon to be verified NOT checked

    TextValue is the case-sensitive text of the state icon to be verified NOT checked

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"

    If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.



Examples:
  • T, WINDOW, TreeView, VerifyTextNodeUnChecked, "MyNode"
    Verifies the first "MyNode" node on the TreeView object is NOT checked.


  • T, WINDOW, TreeView, VerifyTextNodeUnChecked, "MyNode", "3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is NOT checked.


  • T, WINDOW, TreeView, VerifyTextNodeUnChecked, "MyNode", "Index=3"
    Verifies the 3rd duplicate "MyNode" node on the TreeView object is NOT checked.


[How To Read This Reference]

TreeViewFunctions::VerifyTreeContainsNode
RC RJ TC SE2

Verify that a tree contains the provided node.

The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'VerifyTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.



Fields: [ ]=Optional with Default Value
  1. Node
    The name of the node to verify.

    The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'VerifyTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.

Examples:
  • T, Browser, aTreeView, VerifyTreeContainsNode, "Parent Bank->Branch Banking and Trust"
    Verify the node 'Parent Bank->Branch Banking and Trust' is found in aTreeView.


[How To Read This Reference]

TreeViewFunctions::VerifyTreeContainsPartialMatch
RC RJ TC SE2

Verify that a tree contains the provided node according to a partial match of the node's text value.

The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'VerifyTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.



Fields: [ ]=Optional with Default Value
  1. Node
    The name of the node to verify.

    The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'VerifyTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.

Examples:
  • T, Browser, aTreeView, VerifyTreeContainsNode, "parent->branch"
    Verify that a child node of 'parent' containing 'branch' is found in aTreeView.

    Thus, this could be a match for 'Parent Bank->Branch Banking and Trust'.

[How To Read This Reference]