Window - Move
Declaration
<AMWINDOW ACTIVITY="move" WINDOWTITLE="text" WINDOWCLASS="text" WINDOWHANDLE="number" CONTAINSOBJECT="YES/NO" OBJECTPROPERTYSETS="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" ALLOWHIDDEN=YES/NO />
Description
Moves a window to the selected position on the screen. Window title, class, handle, and other properties may be used to specify the window.
Practical usage
Commonly used to move a window to a certain location on the screen in order to make room for other windows or to ensure mouse clicks line up properly.
Parameters
General
This activity comprises Automate Desktop's Window Dissection technology to facilitate the discovery of existing windows and their controls. To select the target window:
- Make certain the window is open and in the foreground (in front of all other open windows).
- Drag and release the magnifier icon over the window. If the window is supported by this activity, a green border will appear around it.
- Upon releasing the icon, identified window properties are populated onto the editor. These properties can be enabled / disabled or further modified.
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
By window title | Text | Yes | (Empty) | WINDOWTITLE="*Explorer" | If enabled, indicates the title of the window to move. If disabled, the window title will be ignored. This parameter supports wildcard characters (that is, * or ?). For example, entering *Notepad* would include any window with the word Notepad in its title. |
By window class | Text | No | (Empty) | WINDOWCLASS="Outlook Browser" | If enabled, indicates the class of the window to move. If disabled, the window class will be ignored. A window class is a set of attributes that the system uses as a template to create a window. Every window is a member of a class and all window classes are process specific. This parameter supports wildcard characters (that is, * or ?). For example, entering *IE* would include any window containing IE its class. |
By window handle | Number | No | (Empty) | WINDOWHANDLE="555735" | If enabled, indicates the handle of the window to move. If disabled, the window handle will be ignored. A window handle is numeric code that uniquely identifies a window. This parameter supports wildcard characters (that is, * or ?). |
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:
|
Window placement | Text (options) | Yes | Upper_left | POSITION="lower_right | Specifies
the new screen location in which to move the window to. The available
options are:
|
Window coordinates [left] | Number | Yes if placement set to custom location | (Empty) | X="640" | The X (left) pixel coordinate location on the screen in which to move the window. This parameter is active only if the Window placement parameter is set to Custom location. |
Window coordinates [top] | Number | Yes if placement set to custom location | (Empty) | Y="580" | The Y (top) pixel coordinate location on the screen in which to move the window. This parameter is active only if the Window placement parameter is set to Custom location. |
Window contents
If multiple windows with the same title exists, it may be necessary to use Automate Desktop's Object Editor to specify additional criteria, such as unique objects, controls or properties, in order to distinguish one window from another. To identify additional elements, enable Window must contain the following objects, and then click Add to open the Object Editor dialog. Thereafter, do one of the following:
- Drag and release the magnifier icon over the desired object or control. The Object properties grid becomes populated with a list of name / value pairs unique to that object. Individual values can be enabled / disabled according to preference.
- Click Browse to traverse the list of available objects / controls for the selected window. Select the desired object from the Window contents column, and then click OK. The Object properties grid becomes populated with a list of defined properties unique to that object. Individual values can be enabled or disabled according to preference.
Available object properties are described below:
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
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=42 | 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. |
Advanced
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Include hidden windows | Yes/No | No | Yes | ALLOWHIDDEN="YES" | If selected, hidden (non-visible) windows will be included in the window search. Disabled by default. |
Populate variable with window title | Text | No | (Empty) | WINDOWTITLEVARIABLE="theTitle" | If enabled, specifies the name of an existing variable that should be populated with the title of the window that was moved. |
Populate variable with window class | Text | No | (Empty) | WINDOWCLASSVARIABLE="theClass" | If enabled, specifies the name of an existing variable that should be populated with the class of the window that was moved. |
Populate variable with window handle | Text | No | (Empty) | WINDOWHANDLEVARIABLE="theHandle" | If enabled, specifies the name of an existing variable that should be populated with the handle of the window that was moved. |
Create and populate dataset | Text | No | (Empty) | RESULTDATASET="DatasetName" | If enabled, specifies the name of a dataset to be created and populated with information about the window that was moved. More on the fields that this dataset creates can be found under Datasets below. |
Additional notes
Datasets
A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. The table below describes these fields (assuming the dataset name assigned was theDataset).
Name | Type | Return Value |
---|---|---|
theDataset.Title | Text | Returns the window title of the window that was moved. |
theDataset.Class | Text | Returns the class of the window that was moved. |
theDataset.Handle | Number | Returns the handle of the window that was moved. |
Example
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task performs various window related activities on a Notepad window. Details are illustrated during task execution.
<AMRUN FILE="Notepad" />
<AMSHOWDIALOG MESSAGE="The next step will minimize the Notepad window." />
<AMWINDOW ACTIVITY="minimize" WINDOWTITLE="*notepad*" />
<AMSHOWDIALOG MESSAGE="The next step will maximize the Notepad window." />
<AMWINDOW ACTIVITY="maximize" WINDOWTITLE="*notepad*" />
<AMSHOWDIALOG MESSAGE="The next step will restore the Notepad window to its original size." />
<AMWINDOW ACTIVITY="restore" WINDOWTITLE="*notepad*" />
<AMSHOWDIALOG MESSAGE="The next step will move the Notepad window to the upper left corner of the screen." />
<AMWINDOW ACTIVITY="move" WINDOWTITLE="*notepad*" />
<AMSHOWDIALOG MESSAGE="The last step will close the Notepad window." />
<AMWINDOW ACTIVITY="close" WINDOWTITLE="*notepad*" />