TestComplete TreeViewFunctions::CaptureTreeDataToFile
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
-
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.
- [ 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.
- [ 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.
- [ 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.
- [ FilterMode = ]
(Future) Specify a file filter to use to process the text before comparison.
- [ FilterOptions = ]
(Future) Specify filter options to use with the file filter.
Examples:
-
T, Browser, aTreeView, CaptureTreeDataToFile, 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, CaptureTreeDataToFile, myDirectory\aFilename.ext, "Parent Bank->Branch Banking and Trust", "_"
Capture the data contents from 'Parent Bank->Branch Banking and Trust' to a file.
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.
-
T, Browser, aTreeView, CaptureTreeDataToFile, aFilename.ext, , , "UTF-8"
Capture the complete nodeset of aTreeView to a file.
Capture the complete nodeset of aTreeView to a file.
Writing file with "UTF-8" encoding.
[How To Read This Reference]
TestComplete TreeViewFunctions::ClickPartial
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
-
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.
- [ 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, ClickPartial, "parent"
Click the first node with the substring "parent"--ignoring text case.
-
T, WINDOW, ATreeView, ClickPartial, "parent", "3"
Click the 3rd node with the substring "parent"--ignoring text case.
-
T, WINDOW, ATreeView, ClickPartial, "parent", "Index=3"
Click the 3rd node with the substring "parent"--ignoring text case.
-
T, WINDOW, ATreeView, ClickPartial, "parent->child"
Click the 1st child node containing substring "child" under a parent node
containing substring "parent".
-
T, WINDOW, ATreeView, ClickPartial, "parent->child", "3"
Click the 3rd child node containing substring "child" under a parent node
containing substring "parent".
[How To Read This Reference]
TestComplete TreeViewFunctions::ClickTextNode
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
-
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 "->"
- [ 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, ClickTextNode, "Parent"
Clicks the first "Parent" node.
-
T, WINDOW, ATreeView, ClickTextNode, "Parent", "3"
Clicks the 3rd "Parent" node.
-
T, WINDOW, ATreeView, ClickTextNode, "Parent", "Index=3"
Clicks the 3rd "Parent" node.
-
T, WINDOW, ATreeView, ClickTextNode, "Parent->Child"
Clicks the first "Child" node found under first "Parent" node.
-
T, WINDOW, ATreeView, ClickTextNode, "Parent->Child", "3"
Clicks the 3rd "Child" node found under first "Parent" node.
[How To Read This Reference]
TestComplete TreeViewFunctions::ClickUnverifiedTextNode
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
-
TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked
- [ 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, ClickUnverifiedTextNode, "MyParent->MyBranch->MyNode"
Single click the first "MyNode" node on the TreeView object.
-
T, WINDOW, TreeView, ClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"
Single click the 3rd duplicate "MyNode" node on the TreeView object.
-
T, WINDOW, TreeView, ClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"
Single click the 3rd duplicate "MyNode" node on the TreeView object.
[How To Read This Reference]
TestComplete TreeViewFunctions::Collapse
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
-
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 "->"
- [ 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, Collapse, "Parent"
Collapses the first "Parent" node.
-
T, WINDOW, ATreeView, Collapse, "Parent", "3"
Collapses the 3rd duplicate "Parent" node.
-
T, WINDOW, ATreeView, Collapse, "Parent", "Index=3"
Collapses the 3rd duplicate "Parent" node.
-
T, WINDOW, ATreeView, Collapse, "Parent->Child"
This action collapses the "Child" node found under "Parent".
-
T, WINDOW, ATreeView, Collapse, "Parent->Child", "3"
Collapses the 3rd duplicate "Child" node found under "Parent".
[How To Read This Reference]
TestComplete TreeViewFunctions::CollapsePartial
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
-
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.
- [ 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, CollapsePartial, "parent"
Collapse the first node with the substring "parent"--ignoring text case.
-
T, WINDOW, ATreeView, CollapsePartial, "parent", "3"
Collapse the 3rd node with the substring "parent"--ignoring text case.
-
T, WINDOW, ATreeView, CollapsePartial, "parent", "Index=3"
Collapse the 3rd node with the substring "parent"--ignoring text case.
-
T, WINDOW, ATreeView, CollapsePartial, "parent->child"
Collapse the 1st child node containing substring "child" under a parent node
containing substring "parent".
-
T, WINDOW, ATreeView, CollapsePartial, "parent->child", "3"
Collapse the 3rd child node containing substring "child" under a parent node
containing substring "parent".
[How To Read This Reference]
TestComplete TreeViewFunctions::CollapseTextNode
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
-
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"
- [ 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]
TestComplete TreeViewFunctions::DoubleClickPartial
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
-
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.
- [ 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]
TestComplete TreeViewFunctions::DoubleClickTextNode
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
-
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 "->"
- [ 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]
TestComplete TreeViewFunctions::DoubleClickUnverifiedTextNode
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
-
TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked
- [ 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]
TestComplete TreeViewFunctions::Expand
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
-
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 "->"
- [ 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]
TestComplete TreeViewFunctions::ExpandPartial
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
-
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.
- [ 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]
TestComplete TreeViewFunctions::ExpandTextNode
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
-
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"
- [ 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]
TestComplete TreeViewFunctions::RightClickPartial
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
-
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.
- [ 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]
TestComplete TreeViewFunctions::RightClickTextNode
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
-
TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked
- [ 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]
TestComplete TreeViewFunctions::RightClickUnverifiedTextNode
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
-
TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked
- [ 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]
TestComplete TreeViewFunctions::Select
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
-
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 "->"
- [ 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]
TestComplete TreeViewFunctions::SelectPartial
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
-
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.
- [ 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]
TestComplete TreeViewFunctions::SelectPartialTextNode
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
-
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:
[How To Read This Reference]
TestComplete TreeViewFunctions::SelectPartialTextNodeSpecial
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
-
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.
- [ 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.
-
SpecialKey
The special key command used in the row selection.
For now, only Control and Shift are supported.
-
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]
TestComplete TreeViewFunctions::SelectTextNode
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
-
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"
- [ 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]
TestComplete TreeViewFunctions::SelectTextNodeSpecial
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
-
TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select.
- [ 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.
-
SpecialKey
The special key command used in the row selection.
For now, only Control and Shift are supported.
-
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]
TestComplete TreeViewFunctions::SelectUnverifiedTextNode
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
-
TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked
- [ 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]
TestComplete TreeViewFunctions::SelectUnverifiedTextNodeRightClick (deprecated for: RightClickUnverifiedTextNode)
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
-
TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked
- [ 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]
TestComplete TreeViewFunctions::SetTreeContainsNode
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
-
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"
-
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:
[How To Read This Reference]
TestComplete TreeViewFunctions::VerifyNodeUnselected
Action to verify a particular text node is NOT selected.
Fields: [ ]=
Optional with Default Value
-
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:
[How To Read This Reference]
TestComplete TreeViewFunctions::VerifySelectedNode
Action to verify a particular text node is selected.
Fields: [ ]=
Optional with Default Value
-
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:
[How To Read This Reference]
TestComplete TreeViewFunctions::VerifyTreeContainsNode
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
-
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:
[How To Read This Reference]
TestComplete TreeViewFunctions::VerifyTreeContainsPartialMatch
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
-
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]