|
|
Interactivity - Get selected tree item |
Declaration
<AMINTERACT ACTIVITY="get_selected_tree_item" WINDOWTITLE="text" WINDOWCLASS="text" WINDOWHANDLE="text" ACCESSIBILITYENGINE="text (options)" OBJECTPROPERTIES="Toolkit=text,Type=text,Class=text,FrameworkId=text,Name=text,AutomationId=text,Value=text,Role=text,Description=text,X=number,Y=number,Width=number,Height=number,IndexInParent=text,ParentPath=text,Occurrence=number" RESULTVARIABLE="text" RESULTDATASET="text" ITEMLEVELVARIABLE="text" />
Description
Retrieves the currently selected (highlighted) item in a tree view or tree control.
Practical Usage
Used to retrieve the text contents and / or indentation level of the selected (or highlighted) item in a tree view or tree control.
Parameters
General
This activity comprises Automate's Window Dissection technology to facilitate the discovery of existing window objects and controls. To select the target control:
- Make certain the window that contains the desired control is open and in the foreground (in front of all other open windows).
- Drag and release the magnifier icon over the control. If the control is supported by this activity, a green border will appear around it.
- Upon release, the Edit portion of the editor is populated with identified control properties. Individual properties can be enabled / disabled and their values can be further modified. The values for all disabled properties will be lost at the time the activity is saved.
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Populate variable with item name | Text | Yes, if Create and populate dataset is not set | (Empty) | RESULTVARIABLE="theVar" | The name of an existing variable in which to populate with the caption text of the selected item. This parameter is required if the Create and populate database parameter is not set. |
| Create and populate dataset | Text | Yes, if Populate variable with item name is not set | (Empty) | RESULTDATASET="DatasetName" | If enabled, specifies the name of a dataset to be created and populated with information about the selected tree item. For more details regarding this dataset, see Datasets below. If disabled (default), no dataset will not be created. This parameter is required if the Populate variable with item name parameter is not set. |
| Store indentation level in variable | Text | No | (Disabled) | ITEMLEVELVARIABLE="myvar" | If enabled, specifies the name of an already existing variable in which to populate with the level of indentation for the selected item. Indentation levels are specified numerically, 0 being root level. If disabled (default), the item's indentation level is ignored. |
Edit
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| By window title | Text | Yes | (Empty) | WINDOWTITLE="Microsoft Internet Explorer" | If enabled, specifies the title of the window that the control search should be restricted to. If disabled, this parameter is ignored. Click the down arrow to select a title from the drop-down list that appears, or enter a title manually in the provided text box. This parameter supports wildcard characters (that is, * and ?). For example, entering *Internet Explorer* would restrict the search to only windows containing the text "Internet Explorer" in its title. |
| By window class | Text | No | (Empty) | WINDOWCLASS="Outlook Express Browser Class" | If enabled, specifies the class of the window that the control search should be restricted to. If disabled, this parameter is ignored. Click the down arrow to select a window class from the drop-down list that appears, or enter a window class manually in the provided text box. This parameter supports wildcard characters (that is, * and ?). For example, entering *Internet Explorer* would restrict the search to only window classes containing the text "Internet Explorer." |
| By window handle | Number | No | (Empty) | WINDOWHANDLE="555735" | If enabled, specifies the handle of the window that the control search should be restricted to. If disabled or set to 0, this parameter is ignored. Use this parameter as a way to distinguish a particular window from other instances containing an identical title / class. |
| Accessibility engine | Text (options) | No | Auto |
| The
accessibility engine that this activity will use to programmatically
gather accurate information about a user interface in order to
interact with it. The available options are:
|
| Browse | Button | No | -- | -- | Provides the option to manually traverse the list of available controls for a window that was selected either by the magnifier icon, or manually by the By window title property. In some cases, the desired control cannot be selected using the magnifier icon. If this occurs, use the magnifier icon to select any control, and then click Browse. Select the desired control from the list in the Object Browser, and then click OK. The Object properties for the selected control will now be populated. Controls can also be selected without the aid of the magnifier icon by enabling the By window title property, and then manually selecting the window the desired control is located in from the list. After selecting a window, click Browse. Select the desired control from the list in the Object Browser, and then click OK. The Object properties for the selected control will now be populated. NOTE: It is not recommended to select a control without using the magnifier icon. Doing so may result in selecting a control that isn't supported by this activity and cause the step to fail when attempting to run it. |
| Object properties | Text | No | (Varies) | OBJECTPROPERTIES="Toolkit =WindowsAccessibility,Type=data, Class=DockingPane,Name=Line, Value=text,X=300,Y=200" | Contains standard Window Dissection parameters used to describe objects, controls, or text inside a window. This section can be used to define additional characteristics in order to precisely designate a window or matching object. To enable / disable a specific property, check or uncheck its associated check box. To modify the value of a specific property simply enter the desired value in the Value field. |
| Toolkit | Text | No | (Empty) |
| If enabled, specifies that the toolkit (a set of basic building units for graphical user interfaces) will be examined when determining a matching object. If disabled, the toolkit will be ignored. The toolkit that appears is based on the Accessibility engine used:
|
| Type | Text | No | (Empty) | TYPE=PushButton | If enabled, specifies that the object's type (that is, Button, Checkbox, Trackbar) will be examined when determining a matching object. If disabled, the type will be ignored. |
| Class | Text | No | (Empty) | CLASS=SysTreeView32 | If enabled, specifies that the object's class (that is, XTPToolBar, SysTreeView, MDIClient) will be examined when determining a matching object. If disabled, the class will be ignored. |
| FrameworkId | Text | No | (Empty) | FRAMEWORKID=WPF | If enabled, specifies that the object's framework ID (the framework technology used to create the object) will be examined when determining a matching object. If disabled, the framework ID will be ignored. |
| Name | Text | No | (Empty) | NAME=Cancel | If enabled, specifies that the object's name (a unique identifier for an object) will be examined when determining a matching object. If disabled, the name will be ignored. |
| AutomationId | Text | No | (Empty) | AUTOMATIONID=System | If enabled, specifies that the object's automation ID (a unique identifier for an object) will be examined when determining a matching object. If disabled, the automation ID will be ignored. |
| Value | Text | No | (Empty) | VALUE=1 | If enabled, specifies that the object's value (which usually coincides with the Name property) will be examined when determining a matching object. If disabled, the value will be ignored. |
| Role | Text | No | (Empty) | ROLE=desktop pane | If enabled, specifies that the object's role type (the control type provided by the Java Accessibility bridge) will be examined when determining a matching object. If disabled, the role type will be ignored. |
| Description | Text | No | (Empty) | DESCRIPTION=JScrollPane | If enabled, specifies that the object's description (the description given for an object) will be examined when determining a matching object. If disabled, the description will be ignored. |
| X | Number | No | (Empty) | X=80 | If
enabled, specifies that the object's X coordinate (a given
number of pixels along the horizontal axis of a window starting
from the extreme left side) will be examined when determining
a matching object. If disabled, the X coordinate will be
ignored. NOTE: The X and Y coordinates are relative to the specified window as
opposed to the screen. |
| Y | Number | No | (Empty) | Y=90 | If
enabled, specifies that the object's Y coordinate (a given
number of pixels along the vertical axis of a window starting
from the top-most portion) will be examined when determining a
matching object. If disabled, the Y coordinates will be ignored.
NOTE: The X and Y coordinates are relative to the specified window as
opposed to the screen. |
| Width | Number | No | (Empty) | WIDTH=711 | If enabled, specifies that the object's pixel width will be examined when determining a matching object. If disabled, the pixel width will be ignored. |
| Height | Number | No | (Empty) | HEIGHT=421 | If enabled, specifies that the object's pixel height will be examined when determining a matching object. If disabled, the pixel height will be ignored. |
| IndexInParent | Text | No | (Empty) | INDEXINPARENT=1 | If enabled, specifies that the object's index in parent number (the numeric identifier of a child object located within a parent object) will be examined when determining a matching object. If disabled, the index in parent number will be ignored. |
| ParentPath | Text | No | (Empty) | PARENTPATH=50032|50033 | If enabled, specifies that the object's parent path (the sequence of control type identifiers that lead to the object) will be examined when determining a matching object. If disabled, the parent path will be ignored. |
| Occurrence | Number | No | (Empty) | OCCURRENCE=1 | If enabled, specifies that the object's occurrence (the numeric identifier of an object, useful when multiple matching objects are found) will be examined when determining a matching object. If disabled, the occurrence will be ignored. |
Additional Notes
Datasets
A dataset is a multiple column, multiple row container object. This action creates and populates a dataset with the following fields (rows):
| Name | Type | Return Value |
|---|---|---|
| theDataset.Level | Number | Returns the indentation level of the selected tree item. Indentation levels are specified numerically, 0 being root level. |
| theDataset.Text | Text | Returns the caption text of the selected tree item. |
| theDataset.Index | Number | Returns the index (row) of the selected tree item. |
| theDataset.ParentText | Text | Returns the caption text of the selected tree item's parent (returns nothing if there is no parent). |
| theDataset.ParentIndex | Number | Returns the index of the selected tree item's parent (returns nothing if there is no parent). |
| theDataset.IsExpanded | Yes/No | Returns YES if the selected tree item has children and is in an expanded state. Returns NO if in a non-expanded state. |
Example
NOTE:
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
This sample task gets all selected tree items from an object and then creates and populates a dataset with the results.
Copy
<AMINTERACT ACTIVITY="get_selected_tree_item" WINDOWTITLE="RoboHelp HTML - AM8_Help - [Get Selected Tree Item Action *]" OBJECTCLASS="SysTreeView32" OBJECTTYPE="TreeStructure" CHECKOBJECTCLASS="YES" CHECKOBJECTTYPE="YES" CHECKOBJECTPOSITION="YES" OBJECTXPOS="2" OBJECTYPOS="153" RESULTVARIABLE="theVar" RESULTDATASET="theDataset" />