Get Text Action

Declaration

<AMGETTEXT RESULTVARIABLE="text" WINDOWTITLE="text" WINDOWCLASS="text" WINDOWHANDLE="number" OBJECTCLASS="text" OBJECTTYPE="text" OBJECTNAME="text" OBJECTVALUE="text" OBJECTXPOS="text" OBJECTYPOS="text" CHECKOBJECTCLASS="yes/no" CHECKOBJECTTYPE="yes/no" CHECKOBJECTNAME="yes/no" CHECKOBJECTVALUE="yes/no" CHECKOBJECTPOSITION="yes/no">

See Also

Get Text Action-Setting Properties, Set Text Action, Send Keystrokes Action, Select Item Action, Select List Item Action

Description

Extracts the text contents of a control on a window. To select an object from an existing window, either use the "Browse..." button or drag the AutoMate icon to the area on the screen. You can only select objects that contain text. To search for partial window titles, use wildcard characters * and ?.

Practical Usage

Used to retrieve the contents of a text control on a Window. Using the Get Text action is superior to using the Clipboard <AMCLIPBOARDCOPY> action or other methods (where it is able to be used) because it communicates with the target control natively and the application is not required to be in the foreground for the event to occur.

Important: Only standard Windows text controls will work with the Get Text Action, many applications use images or other controls that may act like a text control but they are not a native Windows control - the Set Text action will not work with these controls. In these cases other actions must be used to retrieve the text such as Clipboard <AMCLIPBOARDCOPY> action.

Parameters

General Tab

After selecting the target control by dragging the AutoMate icon, click the Edit button under "Object Description" to access these properties:

Variable

Variable, Required
MARKUP: RESULTVARIABLE="VARNAME"

Specifies name of the AutoMate variable that should be populated with the contents of the desired control at runtime.

Get Text From

Text, Optional default "auto"
MARKUP: TEXTPROPERTY="name"

Every control in Windows has both a "name" and "value" property. For example, in Internet Explorer a "link" control returns the text displayed on the page for the Name property, and the target URL for the value property. These options allow the user to control which property should be retrieved when "getting" the text.

The available options are:

Window Title

Text, Required
MARKUP: WINDOWTITLE="Microsoft Internet Explorer"

Specifies the title of the Window that the control search should be restricted to. The value is case-insensitive. NOTE: A Window title is required because without this parameter the action would have to search every control of every single Window on the system which would take an unacceptable amount of time. This parameter supports wildcards (* and ?), for example "*Internet Explorer* would include all Windows containing that text. Note: If this parameter is left blank, the action assumes it is searching for a Window title that is blank - to ignore the Window title, use *.

Window Class

Text, Required
MARKUP: WINDOWCLASS="Outlook Express Browser Class"

Specifies the class of the Window to act on. The value is case-insensitive. This parameter supports wildcards (* and ?), for example "*Internet Explorer* would include all window classes containing that text. Note: If this parameter is left blank, the action assumes it is searching for a Window class that is blank - to ignore the WIndow class, use *.

Window Handle

Number, Optional - Default - 0
MARKUP: WINDOWHANDLE="555735"

Specifies the handle of the Window to act on. If set to 0 or omitted the parameter is ignored.

Type Must Be

Yes/No, Optional Default NO
MARKUP: CHECKOBJECTTYPE="YES"

Specifies that the type parameter will be checked against the control when determining a matching control. When set to NO the type of the control is ignored.

Type

Text, Optional Default ""
MARKUP: OBJECTTYPE="PushButton"

Specifies the type of control that should be checked/unchecked/toggled. The parameter is ignored if "Type must be" is set to NO.

Class Must Be

Yes/No, Optional Default NO
MARKUP: CHECKOBJECTCLASS="YES"

Specifies that the class parameter will be checked against the control when determining a matching control. When set to NO the class of the control is ignored.

Class

Text, Optional Default ""
MARKUP: OBJECTCLASS="SysTreeView32"

Specifies the class of the target control. The parameter is ignored if "Class Must be" is set to no.

Name Must Be

Yes/No, Optional Default NO
MARKUP: CHECKOBJECTNAME="YES"

Specifies that the name parameter will be checked against the control when determining a matching control. When set to NO the name of the control is ignored.

Name

Text, Optional Default ""
MARKUP: OBJECTNAME="Cancel"

Specifies the name of the target control. The parameter is ignored if "Name must be" is set to NO

Value Must Be

Yes/No, Optional Default NO
MARKUP: CHECKOBJECTVALUE="YES"

Specifies that the value parameter will be checked against the control when determining a matching control. When set to NO the value of the control is ignored.

Value

Text, Optional Default ""
MARKUP: OBJECTVALUE="1"

Specifies the value of the target control. The parameter is ignored if "Value must be" is set to NO

Position Must Be

Yes/No, Optional Default NO
MARKUP: CHECKOBJECTPOSITION="YES"

Specifies that the Position X and Position Y parameter will be checked against the position of the control when determining a matching control. When set to NO the position of the control is ignored. The X and Y coordinates specified are relative to the Window specified in the Window Title Parameter (not the screen).

Position X

Text, Optional Default ""
MARKUP: OBJECTXPOS="80"

Specifies the X coordinate position of the control relative to the Window specified in the Window Title Parameter. The parameter is ignored if "Position must be" is set to NO.

Position Y

Text, Optional Default ""
MARKUP: OBJECTYPOS="90"

Specifies the Y coordinate position of the control relative to the Window specified in the Window Title Parameter. The parameter is ignored if "Position must be" is set to NO.

Notes

Window Dissection™ Technology

This action contains a subset of Network Automation's unique "Window Dissection Technology".

Click here for more information.

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMGETTEXT WINDOWTITLE="Run" RESULTVARIABLE="varname" OBJECTCLASS="Edit" OBJECTTYPE="SelectableText" OBJECTXPOS="57" OBJECTYPOS="63" CHECKOBJECTCLASS="YES" CHECKOBJECTTYPE="YES" CHECKOBJECTPOSITION="YES">