AnyWin Class

Description

AnyWin is the class for any window.

In Silk Test Classic the word window is used generally to refer to any object or widget in a GUI. Therefore, a pushbutton, scroll bar, and check box are all considered windows, as are dialogs, menus, and menu items.

Inheritance

AnyWin does not derive from any class; several classes derive from it.

Functions, Methods, and Properties

AnyWin has the following functions, methods, and properties:

CaptureBitmap Method
Saves a bitmap image to a file and returns the absolute or relative path of the captured bitmap.
Click Method (AnyWin PushButton)
Clicks either a window or a pushbutton.
DoubleClick Method
Double-clicks a mouse button on the window.
DynamicInvoke Method (AnyWin)
Dynamically invokes a method.
DynamicInvokeMethods Method (AnyWin)
Dynamically invokes a sequence of nested methods starting at this window.
Exists Method
Tests whether a window exists.
ExtendedClick Method
Performs a click with one or more key modifiers.
ExtendedDoubleClick Method
Performs a double-click with one or more key modifiers.
ExtendedPressMouse Method
Presses the mouse with one or more key modifiers.
ExtendedReleaseMouse Method
Releases the mouse with one or more key modifiers.
Find Method
Finds an object specified by an XPath locator or an object map identifier.
FindAll Function
Finds all objects specified by an XPath locator.
GenerateLocator Function
Returns a list of locators for the control on which the method is called.
GetAgentType Function
Returns the Silk Test agent type, Classic Agent or Open Agent, for the specified window declaration.
GetAppId Function
Returns the identifier of the application displaying the window.
GetBitmapCRC Function
Returns the CRC value of a bitmap captured from the screen.
GetCaption Function
Returns the caption form of the tag for HTML objects, or the text associated with the object for non-HTML objects.
GetChildren Function
Returns the names of the children of the window declaration for the Classic Agent or the handles of the children of the window in the UI for the Open Agent.
GetClass Function
Returns the class of the window.
GetContents Function (AnyWin)
Returns the contents of the window.
GetDynamicMethodList Function (AnyWin)
Returns a list of methods (including their signature) that can be dynamically invoked on this object.
GetHandle Function
Returns the internal handle of the window.
GetID Function
Returns the identifier of the window.
GetIndex Function
Returns the index of the window.
GetLocators Function
Returns a list of locator strings for the window.
GetManyProperties Function
Returns the values for a list of properties or returns all the properties for the specified window.
GetName Function
Returns the name of the window declaration or XML object for the Classic Agent or the handle of the window in the UI for the Open Agent.
GetParent Function
Returns the parent of the window.
GetProperty Function (AnyWin)
Returns the value of a property of an object.
GetPropertyList Function (AnyWin)
Returns the list of properties for an object.
GetRect Function (AnyWin)
Returns the size and position of the window.
GetTag Function
Returns the fully qualified tag for a window, where the tag is the one actually used to identify the window.
HighlightObject Method
Highlights an object when a script is replayed.
ImageClickFile Method (AnyWin)
Clicks on the specified image.
ImageExistsFile Method (AnyWin)
Returns whether the specified image exists.
IsActive Function
Tests whether the window is the active window.
IsDefined Function
Tests whether or not a specified definition exists.
IsEnabled Function
Tests whether the window is enabled.
IsOfClass Function
Tests whether an object is of the specified class.
IsVisible Function
Tests whether an object is visible—that is, it has not been designated as a hidden object.
MoveMouse Method
Moves the pointer to the specified location in the window.
MultiClick Method
Generates multiple mouse clicks on the window.
OpenContextMenu Method
Opens a context menu at the specified position.
OpenContextSelect Method
Opens a context menu at the specified position and selects the specified menu item.
PressKeys Method
Presses (but does not release) a set of keys or mouse buttons.
PressMouse Method
Presses (but does not release) a mouse button in the window.
ReleaseKeys Method
Releases a set of keys or mouse buttons.
ReleaseMouse Method
Releases a mouse button in the window.
Resolve Function
Finds an object using the locator in the window declaration.
ResolveAll Function
Finds all objects specified by the locator or tag in the window declaration.
SetEnabled Method
Enables or disables a control.
SetParentActive Method
Sets the parent application active.
SetProperty Method
Sets the value of a property of an object.
SetVisible Method
Makes a control visible or invisible.
TextCapture Method (AnyWin)
Returns the text in the client area of the window.
TextClick Method (AnyWin)
Clicks on the specified text string within this window.
TextExists Method (AnyWin)
Returns whether the specified text exists.
TextRectangle Method (AnyWin)
Returns the object-relative rectangle of the specified text or an empty rectangle if the specified text does not exist.
TypeKeys Method (AnyWin)
Sends a set of keystrokes to the window when used with the Open Agent or a set of keystrokes or mouse button presses to the window when used with the Classic Agent.
TypePasswordKeys Method
Sends an encrypted password to a control.
VerifyActive Method
Verifies that the window is active.
VerifyBitmap Method
Verifies that the screen image matches a saved bitmap of the image.
VerifyEnabled Method
Verifies that a window is enabled or disabled.
VerifyProperties Method
Verifies that the properties of the specified window and its child windows are as expected.
VerifyText Method (AnyWin)
The VerifyText method for the AnyWin class is obsolete.
WaitBitmap Method
Waits for a screen image to match a saved bitmap within a timeout interval, and returns the time it took for the bitmap to appear.
WaitForChildDisappearance Method
Waits until the child object specified by the locator parameter no longer exists or the timeout value is reached.
WaitForDisappearance Method
Waits until an object no longer exists or the timeout value is reached.
WaitForObject Method
Waits for an object that matches the specified XPath locator.
WaitForProperty Method
Waits until the specified property returns the specified value or until the timeout is reached.
WaitForPropertyNotEquals Method (AnyWin)
Waits until the specified property has a value that is different to the specified value or until the timeout is reached.
WaitForScreenshotStable Method (AnyWin)
Waits until the object is visually stable and does not change its position, by comparing screenshots taken with the specified interval.
AppId Property
The identification number of the application containing the window.
Background Property
Reads the background color of a control.
bActive Property
Whether the window is active.
bApiClick Property
Whether Silk Test Classic issues API-based clicks or Agent-based clicks to improve the reliability of recorded and scripted clicks in HTML applications.
bEnabled Property
Enables or disables a window or control.
bExists Property
States whether or not a window exists.
Class Property
The class of the window.
Foreground Property
Reads the foreground color of a control.
hWnd Property
The internal handle of a window.
iIndex Property
The index of the window.
lwChildren Property
The child windows of the window, not including window parts.
Rect Property
The size and position of the window (relative to the parent window).
sCaption Property
The caption (title) of the window.
sFont Property
Reads or writes the font name of a control.
sID Property
The GUI identifier of the window (used internally).
sName Property
The 4Test identifier for the window (assigned in the declaration).
WndTag Property
The window tag of a window.
wParent Property
The parent of the window.

Parent topic: General Core Classes