General Windows methods
Use General Windows methods to define actions in your automation.
Unmatches this control from the target that it is matched to.
This method is used when an automation might need to force a
control to un-match before calling the Rematch or
RematchChildren method to re-match controls. Note: Rematch or RematchChildren should only be used when
there is an issue that prevents matching from working correctly.
Removes the control from view. Removes the cell from view. See
UnMatchOnHidden to understand how hiding an application changes
control matching. Note: Avoid using this method when automating applications
because some applications and controls must be on an active
desktop and visible. Simulates a click by causing the Click event to fire. The event
is fired asynchronously. The system executes asynchronous clicks on a separate thread.
Control returns to the calling thread immediately. The PerformClick method relies on native injection to work and
this is not available when you use the Chrome Universal Web
Adapter to interrogate the Chrome browser. You can, however, use
this methods to interrogate controls on the webpage being
displayed, just not Chrome browser controls, such as Refresh,
Minimize, and Maximize. Simulates a click by causing the Click event to fire. Click is
performed at the x and y location specified by the parameters.
The event is fired asynchronously. The system executes asynchronous clicks on a separate thread.
Control returns to the calling thread immediately. The PerformClick method relies on native injection to work and
this is not available when you use the Chrome Universal Web
Adapter to interrogate the Chrome browser. You can, however, use
this methods to interrogate controls on the webpage being
displayed, just not Chrome browser controls, such as Refresh,
Minimize, and Maximize. Simulates a double-click by causing the DoubleClick event to
fire. Event is fired asynchronously. The system executes asynchronous clicks on a separate thread.
Control returns to the calling thread immediately. Simulates a double-click by causing the DoubleClick event to
fire. Click is performed at the x and y location specified by
the parameters. The event is fired asynchronously. The system executes asynchronous clicks on a separate thread.
Control returns to the calling thread immediately. Simulates a right-click by causing the RightClick event to fire.
The event is fired asynchronously. The system executes asynchronous clicks on a separate thread.
Control returns to the calling thread immediately. Simulates a right-click by causing the RightClick event to fire.
RightClick is performed at the x and y location specified by the
parameters. The event is fired asynchronously. The system executes asynchronous clicks on a separate thread.
Control returns to the calling thread immediately. Simulates a click by causing the Click event to fire. The event
is fired synchronously. Simulates a click by causing the Click event to fire. The event
is fired synchronously. Simulates a click by causing the Click event to fire. The event
is fired synchronously. Note: This method is not implemented for Java version 1.4 - 1.6
controls. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a click by causing the Click event to fire. Click is
performed at the x and y location specified by the parameters.
The event is fired synchronously. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a click by causing the Click event to fire. Click is
performed at the x and y location specified by the parameters.
The event is fired synchronously. Note: This method is not implemented for Java version 1.4 - 1.6
controls. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a double-click by causing the DoubleClick event to
fire. The event is fired synchronously. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a double-click by causing the DoubleClick event to
fire. The event is fired synchronously. Note: This method is not implemented for Java version 1.4
- 1.6 controls. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a double-click by causing the DoubleClick event to
fire. Click is performed at the x and y location specified by
the parameters. The event is fired synchronously. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a double-click by causing the DoubleClick event to
fire. Click is performed at the x and y location specified by
the parameters. The event is fired synchronously. Note: This method is not implemented for Java version 1.4 - 1.6
controls. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a right-click by causing the RightClick event to fire.
The event is fired synchronously. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a right-click by causing the RightClick event to fire.
The event is fired synchronously. Note: This method is not implemented for Java version 1.4 - 1.6
controls. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a right-click by causing the RightClick event to fire.
Click is performed at the x and y location specified by the
parameters. The event is fired synchronously. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Simulates a right-click by causing the RightClick event to fire.
Click is performed at the x and y location specified by the
parameters. The event is fired synchronously. Note: This method is not implemented for Java version 1.4
- 1.6 controls. Synchronous clicks are executed on the calling thread. The method
waits for all click messages to be processed. Method Description Parameters Return Activate Activates the control and gives it focus within the Studio
project. None Void DestroyTooltip Deletes a tool tip from a control to which it has been assigned. None Void Detach None Void Focus Causes the element to receive the focus and executes the code
specified by the GotFocus event. None Void GetClones Returns a collection of cloned objects. Use the GetClones method
in combination with a ListLoop component to iterate over the list of
cloned objects to extract individual list items. None None GetEvent Initiates downstream logic pending the occurrence of a particular
event. Click the Name parameter in the GetEvent design block to view
a list of events applicable for the component. Select the event, and
then create a proxy from the GetEvent result. For more information,
see Get Event for Windows Controls and Forms. EventName name Event GetHandle Use to return the handle of a window. This method returns an
IntPtr window handle of this target. This method is available for
all Windows controls. None Int32 GetText Use to get a large text buffer from a control. Int32 bufferSize String Hide None Void HideTooltip Causes the tool tip for the control to be hidden from view. None Void IsKeyAssigned Verifies that Key is assigned. String key Boolean PerformClick None Void PerformClick Int32 x, Int32 y Void PerformDoubleClick None Void PerformDoubleClick Int32 x, Int32 y Void PerformRightClick None Void PerformRightClick Int32 x, Int32 y Void PerformSynchronousClick None Void PerformSynchronousClick Int32 timeout Void PerformSynchronousClick Int32 x, Int32 y Void PerformSynchronousClick Int32 timeout, Int32 x, Int32 y Void PerformSynchronousDoubleClick None Void PerformSynchronousDoubleClick Int32 timeout Void PerformSynchronousDoubleClick Int32 x, Int32 y Void PerformSynchronousDoubleClick Int32 timeout, Int32 x, Int32 y Void PerformSynchronousRightClick None Void PerformSynchronousRightClick Int32 timeout Void PerformSynchronousRightClick Int32 x, Int32 y Void PerformSynchronousRightClick Int32 timeout, Int32 x, Int32 y Void Rematch Refreshes matching on the control and all child controls. If the
control is currently matched, Studio detaches (unmatches) the
control and children before attempting to rematch. If the control is
currently unmatched, you can only call Rematch if the parent is
matched. None Void RematchChildren Refreshes matching on all objects under the control. Set the
detach property to True to unmatch all targets before attempting to
rematch. Boolean detach Void ResetState Resets all component properties to their initial values. None Void SendKeys Sends a key command to a control. For more information, see
SendKeys method. String keys Boolean focus Void SetNextKey Sets the key for the control when the UseKeys property is True,
indicating that clones of this control can be created when multiple
matching targets are found. For more information, see Cloned
Controls. String key Void Show Makes the control visible after the Hide method has been called.
See UnMatchOnHidden to understand how hiding an application changes
control matching. None Void ShowContextMenu Displays a context menu associated with the control. None Void ShowContextMenu Displays a context menu associated with the control. The menu is
displayed at the x and y location, as specified by the parameters. Int32 x, Int32 y Void ShowTooltip Creates a tool tip for the control. There are five overloads of
this method (1, 2, 3, 5, 7 parameters). For more information, see
Using the ShowToolTip Method. String text, String title, ToolTipAnchorPosition anchorPosition,
Color textColor, Color backgroundColor, Int32 maxWidth, ToolTipIcon
icon Void WaitForCreate Waits for the control to be created (matched). Returns True if
the control is created before the WaitTimeout period elapses.
Otherwise, it returns False. For more information, see Wait For
Create. None Boolean WaitForCreate Waits for the control to be created (matched). Returns True if
the control is created before the specified number of milliseconds
has elapsed. Otherwise, it returns False. For more information, see
Wait For Create. Int32 milliseconds Boolean
Previous topic General Windows properties Next topic General Windows events