Skip to main content

General Windows properties

Suggest edit Updated on November 10, 2021
Pega Robot Studio v21 Preview

Use the Windows properties to define Windows controls in your automation.

PropertyDescription
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
BoundsRectangleGets or sets the size and location of the control including its non-client elements, in pixels, relative to the parent control. (Rectangle)
ClientRectangleGets the rectangle that represents the client area of the control.
EnabledGets or sets a value that indicates whether the control can respond to user interaction. (Boolean)
FullNameGets the fully qualified name of the control, such as CRM.txtName. (String)
FocusedGets a value that indicates whether the control has input focus. (Boolean)
HeightGets or sets the height of the control. (Int32)
IsCreatedIndicates whether the control has been created (matched). (Boolean)
IsDisposedProperty included for as part of system references. It is not, however, used in automations.
KeyGets or sets the unique Key value for the control. This property is used for applications that contain cloned targets. For more information, see Cloned Controls. (String)
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. (Int32)
LocationGets or sets the location that represents the top left area of the control. (Point)
MaskEventTextSee the Configure Monitored Events topic for more information on this property.
MaskEventValueSee the Configure Monitored Events topic for more information on this property.
NameGets or sets the name assigned to the control. (String)
NextKeySets the key value that will be assigned to the next clone created. This property is used for applications that contain cloned targets.For more information, see Cloned Controls. (String)
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container's client area. (Int32)
ScreenRectangleGets the rectangle that represents the screen area of the control.
SizeGets or sets the size of the control. (Size)
TargetNameGets the name that was assigned to the target
TargetTypeGets assembly and type for the control, such as OpenSpan.Adapters.Windows.Targets.TextBox. (TargetType)
Text

Gets or sets the text associated with this control. (String)

Note: This property will not return anything for Common List Controls as these controls do not have a Text property.

ThisA reference to the control object. (Object)
TimeoutSpecifies the timeout interval for the Created event in milliseconds. (Int32)
TopGets the visibility of the control. (Boolean)
UniqueID

Gets the identity of the control. Here is an example:

WindowsAdapter-8CC89A3AD46E95C\RichTextBox-8CC89A3D72635FC

UnmatchOnHidden

Sets the matching status of application controls when they are hidden at runtime.

Set this property to True to have the control become unmatched when hidden (it will be automatically rematched when the target is shown). Set to False to have the control remain matched when hidden.

Note that if this property is set to True and the control is hidden, you cannot use the Rematch or RematchChildren methods to rematch the hidden target. For more information, see Working with Hidden Forms.

UseKeysUse this property to specify whether clones of this control can be created when multiple matching targets are found. For more information, see Cloned Controls. Set to True to enable creating clones. The default is False. (Boolean)
VisibleSets or gets a True/False value that indicates whether the control is displayed.
WaitHandleAllows callers to wait for the component's creation signal when using the WaitAny or WaitAll components. Type: WaitHandle
WidthGets or sets the width of the control. (Int32)

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us