Control Class

Description

The class for any control in a window.

Inheritance Hierarchy

BaseGuiTestObject
- Control
  - CBanner
  - CheckBox
  - ComboBox
  - CoolBar
  - CTabFolder
  - DataGrid
  - DomainUpDown
  - ElementHost
  - ExpandBar
  - FormsHost
  - Group
  - Header
  - Label
  - Link
  - ListBox
  - ListView
  - MenuStrip
  - MonthCalendar
  - Pager
  - ProgressBar
  - PushButton
  - RadioList
  - Sash
  - SashForm
  - Scale
  - ScrollableControl
  - ScrollBar
  - ScrolledComposite
  - Spinner
  - StatusBar
  - SWTBrowser
  - SWTDateTime
  - TabControl
  - Table
  - TextField
  - ToggleButton
  - ToolBar
  - Tree
  - UpDown
  - ViewForm

Syntax

'Declaration
Public Class Control _
Inherits BaseGuiTestObject

Properties

Name	Description
Background	The background color of the GUI object. (Inherited from GuiTestObject)
Enabled	Whether the GUI object is enabled. (Inherited from GuiTestObject)
Font	The font type of the GUI object. (Inherited from GuiTestObject)
Foreground	The foreground color of the GUI object. (Inherited from GuiTestObject)
NativeHandle	The native window handle for the object. (Inherited from INativeWindow)
Text	The text of the control. (Inherited from TestObject)
Value	The value of the control, e.g.: text in a text control. (Inherited from TestObject)
Visible	Whether the object is visible. You can only locate visible objects, so by default the value is always `true`. However, you might need this property when an already located object in the application under test gets invisible during replay. (Inherited from GuiTestObject)

Methods

Name	Description
CaptureBitmap	Saves a bitmap image of this object to a file. If you do not specify an absolute file name, the bitmap is saved to the default bitmap location on the machine that runs the Agent, which is %LOCALAPPDATA%/Silk/SilkTest/capturedBitmaps. The captured bitmap's pixels are stored in 32bit RGB order; when parsing the image the 4th byte (alpha channel) of every pixel must be ignored as it is used only for padding. In .NET, the constant System.Drawing.Imaging.PixelFormat.Format32bppRgb can be used for this purpose. (Inherited from TestObject)
Click	Clicks on the object. (Inherited from IClickable)
DoubleClick	Double-clicks a mouse button on the object. (Inherited from IClickable)
Exists	Checks if any child object matching the locator exists for an object in the application under test. If the `timeout` parameter is passed the agent retries finding until the given timeout expires. If no timeout is specified and no object is found initially `false` is returned immediately. (Inherited from TestObject)
Exists	Checks if an object exists in the application under test. (Inherited from TestObject)
Find	Finds an object specified by an XPath locator. (Inherited from TestObject)
FindAll	Finds all objects specified by an XPath locator. (Inherited from TestObject)
GenerateLocator	Returns a locator for this object. (Inherited from TestObject)
GetChildren	Returns the child objects of this object. (Inherited from TestObject)
GetDynamicMethodList	Returns a list of methods (including their signature) that can be dynamically invoked on this TestObject. (Inherited from TestObject)
GetHorizontalBar	Returns the horizontal scroll bar for this control. (Inherited from IScrollable)
GetParent	Looks up the parent of this object in the test application. (Inherited from TestObject)
GetProperty	Returns the value of the specified property. (Inherited from TestObject)
GetPropertyList	Returns a list of property names that can be retrieved for the given object. (Inherited from TestObject)
GetRect	Returns the size and position of this object. Per default the returned coordinates are relative to the parent window that contains this object. (Inherited from TestObject)
GetVerticalBar	Returns the vertical scroll bar for this control. (Inherited from IScrollable)
HighlightObject	Highlights this object. (Inherited from TestObject)
ImageClick	Clicks on specified image asset. (Inherited from TestObject)
ImageClickFile	Clicks on the specified image. (Inherited from TestObject)
ImageExists	Returns whether the specified image asset exists. (Inherited from TestObject)
ImageExistsFile	Returns whether the specified image exists. (Inherited from TestObject)
ImageRectangle	Returns the object-relative rectangle of the specified image asset. (Inherited from TestObject)
ImageRectangleFile	Returns the object-relative rectangle of the specified image. (Inherited from TestObject)
Invoke	Dynamically invokes a method on the test object. (Inherited from TestObject)
InvokeMethods	Dynamically invokes a sequence of methods starting at this TestObject. (Inherited from TestObject)
IsFocused	Return whether the control has focus. (Inherited from IFocusable)
MouseMove	Moves the pointer to the specified location in the object. This method is not supported for mobile Web applications. (Inherited from IClickable)
OpenContextMenu	Opens a context menu at the specified position. (Inherited from BaseGuiTestObject)
PressKeys	Presses (but does not release) a set of keys or mouse buttons. (Inherited from IKeyable)
PressMouse	Presses (but does not release) a mouse button in the object. This method is not supported for mobile Web applications. (Inherited from IClickable)
ReleaseKeys	Releases a set of keys or mouse buttons. (Inherited from IKeyable)
ReleaseMouse	Releases a mouse button. This method is not supported for mobile Web applications. (Inherited from IClickable)
SetFocus	Gives focus to the control. (Inherited from IFocusable)
SetProperty	Sets the value of the specified property. (Inherited from TestObject)
StartScreenRecording	Starts screen recording (Inherited from TestObject)
StopScreenRecording	Stops screen recording (Inherited from TestObject)
TextCapture	Returns the text in this object's visible area. (Inherited from TestObject)
TextClick	Clicks in the center of the specified text. (Inherited from TestObject)
TextExists	Returns whether the specified text exists. (Inherited from TestObject)
TextRectangle	Returns the object-relative rectangle of the specified text. (Inherited from TestObject)
TypeKeys	Sends a set of keystrokes to the object. (Inherited from IKeyable)
TypePasswordKeys	Types an encrypted password into an object, for example a text field. (Inherited from IKeyable)
WaitForChildDisappearance	Waits until the specified child object does not exist or until the timeout is reached. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForDisappearance	Waits until the object does not exist or until the timeout is reached. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForObject	Waits for an object that matches the specified locator. If no object matches within an timeout an ObjectNotFoundException is thrown. The default timeout is 5 seconds and you can change the timeout by setting the value of the option `OPT_WAIT_RESOLVE_OBJDEF`. Use WaitForObject if the AUT takes a long time to display a specific object, for example when a transaction is processed before showing any results. By default, an action in the UI does not require a WaitForObject, because of the built-in synchronization. If you receive random timeout errors during normal script execution, consider increasing the default timeout instead of adding WaitForObject statements to your scripts. (Inherited from TestObject)
WaitForProperty	Waits until the specified property has the specified value or until the timeout is reached.If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForPropertyNotEquals	Waits until the specified property has a value that is different to the specified value or until the timeout is reached.If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForScreenshotStable	Waits until the control is visually stable and does not change its position, by comparing screenshots taken with the specified interval. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_SCREENSHOT_STABLE will be used. The default interval is 200 milliseconds. An exception is thrown if the timeout is reached. (Inherited from TestObject)