Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

General Web component methods

Updated on October 19, 2022


DestroyTooltipDeletes a tool tip from a control to which it has been assigned.

Un-matches 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.

Rematch or RematchChildren should only be used when there is an issue that prevents matching from working correctly.

DisableDisables the control so the user cannot interact with it.
EnableEnables the control for user interaction, if it was previously disabled.
FocusCauses the control to receive the focus and executes the code specified by the GotFocus event.
GetClonesReturns 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.
GetEventInitiates 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 control. Select the event, and then create a proxy from the GetEvent result.

Removes the control from view.

Avoid using this method when automating applications because some applications and controls must be on an active desktop and visible.

HideTooltipCauses the tool tip for the control to be hidden from view.
IsKeyAssignedReturns True if a key has been set for the control. This method applies when the UseKeys property is True, indicating that cloned controls are created for multiple target instances. For more information, see Cloned controls and the UseKeys property.
PerformClickSimulates a click by causing the Click event to fire.
PerformDoubleClickSimulates a double-click by causing the DoubleClick event to fire.
RaiseEventFires a specified event on the control. HtmlEvent evt.
RematchRefreshes matching on the cell control and all controls under the cell. 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. Boolean.
RematchChildrenRefreshes matching on all objects under the cell control. Set the detach property to True to unmatch all targets before attempting to rematch. Boolean detach.
RemoveFocusRemoves the focus from the control.
ResetStateReserved for .NET use.
SetNextKeySets 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 and the UseKeys property.
ShowMakes the control visible after the Hide method has been called. See the UnmatchOnHidden property to understand how hiding an application changes control matching.
ShowTooltipCreates a tool tip for the control. There are five overloads of this method (1, 2, 3, 5, 7 parameters).

Parameters are String text, String title, ToolTipAnchorPosition anchorPosition, Color textColor, Color backgroundColor, Int32 maxWidth, and ToolTipIcon icon.

WaitForCreate (2 methods)Waits for the control to be created (matched), based on the following parameters:
  • Returns True if the cell is created before the WaitTimeout period elapses. Otherwise, it returns False.
  • Waits for the control to be created (matched). Returns True if the cell is created before the specified number of milliseconds has elapsed. Otherwise, it returns False.

For more information, see WaitAll and WaitAny components.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us