Window - Close
Declaration
<AMWINDOW ACTIVITY="close" WINDOWTITLE="text" WINDOWCLASS="text" WINDOWHANDLE="number" ACCESSIBILITYENGINE="text (options) 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" WINDOWTITLEVARIABLE="text" WINDOWCLASSVARIABLE="text" WINDOWHANDLEVARIABLE="text" RESULTDATASET="text" CLOSETYPE="text (options)" />
Description
Closes an open window. If the window is the main window of an application, that application will be closed. Window title, class, handle, and other properties may be used to specify the window. If more than one window matches the properties entered, all matching windows are acted on. By default only visible windows are affected, but properties can be set to include hidden windows.
Practical usage
Generally used to close an open application or clear a dialog. If the application does not have a main window, the End process activity may alternatively be used to close it.
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 close. 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 close. 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" in its class. |
By window handle | Number | No | (Empty) | WINDOWHANDLE="555735" | If enabled, indicates the handle of the window to close. 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 closure | Text (options) | No | Request |
|
Specifies
whether the window will be requested to close, giving the application
the opportunity to clean up and prompt to save, or be forced to
close, which will cause the application to close abruptly without
cleaning up, which could cause the application to lose data. The
available options are:
|
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. This parameter is 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 closed. |
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 closed. |
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 closed. |
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 closed. 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 closed. |
theDataset.Class | Text | Returns the class of the window that was closed. |
theDataset.Handle | Number | Returns the handle of the window that was closed. |
Examples
- 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.
Example 1
This simple 2 step task uses the Run activity to open Internet Explorer then executes a Close windows activity to close the open browser window. Note that if other Internet Explorer windows were open during runtime, those windows will be closed as well.
<AMRUN FILE="iexplore" />
<AMWINDOW ACTIVITY="close" WINDOWTITLE="*internet explorer*" />
Example 2
This task uses an Open Web Page activity to open the www.google.com URL. A Close Window activity set to close any window with the text "google" in its title will then close the browser window. Finally, a message box will display the title, handle and class of the window that was closed.
<AMVARIABLE NAME="theHandle" VALUE="" />
<AMVARIABLE NAME="theClass" VALUE="" />
<AMVARIABLE NAME="theTitle" VALUE="" />
<AMBROWSER URL="www.google.com" />
<AMWINDOW ACTIVITY="close" WINDOWTITLE="*google*" WINDOWTITLEVARIABLE="varTitle" WINDOWCLASSVARIABLE="theClass" WINDOWHANDLEVARIABLE="varHandle" />
<AMSHOWDIALOG>Title of closed window - %theTitle%Class of closed window - %theClass%Handle of closed window - %theHandle%</AMSHOWDIALOG>