SwfObject Object

Description

A standard .NET Windows Forms object.

Operations

The sections below list the built-in methods and properties that you can use as operations for the SwfObject object.

Note: You can also view a list and descriptions of the SwfObject description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

CaptureBitmap	Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Check	Checks whether the actual value of an item matches the expected value.
CheckProperty	Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
ChildObjects	Returns the collection of child objects contained within the object.
GetAllROProperties	Returns the collection of properties and current values from the object in the application.
Click	Clicks an object.
DblClick	Double-clicks an object
Drag	Performs the 'drag' part of a drag-and-drop operation.
Drop	Performs the 'drop' part of a drag-and-drop operation.
FireEvent	Simulates an event on a .NET object.
GetErrorProviderText	Returns the tooltip text of the error icon associated with the object.
GetROProperty	Returns the current value of the description property from the object in the application.
GetTextLocation	Checks whether the specified text string is contained in the specified window area.
GetTOProperties	Returns the collection of properties and values used to identify the object.
GetTOProperty	Returns the value of the specified description property from the test object description.
Highlight	Highlights the object in the application.
GetVisibleText	Returns the text from the specified area.
HScroll	Horizontally scrolls an object that has embedded scroll bars.
MouseMove	Moves the mouse pointer to the designated position over the object.
Output	Retrieves the current value of an item and stores it in a specified location.
RefreshObject	Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object.
SetTOProperty	Sets the value of the specified description property in the test object description.
ToString	Returns a string that represents the test object.
Type	Types the specified string in the object.
VScroll	Vertically scrolls an object that has embedded scroll bars.
WaitProperty	Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Exist	Checks whether the object currently exists in the open application.
Object	Accesses the native methods and properties of the object.

Click Method

Description

Clicks an object.

Syntax

object.Click [X], [Y], [BUTTON]

Arguments

Parameter	Description
X	Optional. An integer value. The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999
Y	Optional. An integer value. The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Tip: You can enter micNoCoordinate for the x and y argument values if you want to enter a value for the button argument without specifying x- and y- coordinates for the click. Default value = -9999
BUTTON	Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn

Return Type

None

Example

DblClick Method

Description

Double-clicks an object

Syntax

object.DblClick X, Y, [BUTTON]

Arguments

Parameter	Description
X	Required. An integer value. The x-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object.
Y	Required. An integer value. The y-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON	Optional. A predefined constant or number. The mouse button used to double-click the object. Default value = micLeftBtn

Return Type

None

Example

Drag Method

Description

Performs the 'drag' part of a drag-and-drop operation.

Syntax

object.Drag X, Y, [BUTTON]

Arguments

Parameter	Description
X	Required. An integer value. The coordinates within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
Y	Required. An integer value. The coordinates within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON	Optional. A predefined constant or number. The mouse button used to drag the object. Default value = micLeftBtn

Return Type

None

Example

Drop Method

Description

Performs the 'drop' part of a drag-and-drop operation.

Syntax

object.Drop X, Y, [BUTTON]

Arguments

Parameter	Description
X	Required. An integer value. The coordinates of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
Y	Required. An integer value. The coordinates of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON	Optional. A predefined constant or number. The button that is released to drop the object. Default value = micLeftBtn

Return Type

None

Example

FireEvent Method

Description

Simulates an event on a .NET object.

Syntax

object.FireEvent (EventName)

Arguments

Parameter	Description
EventName	Required. A Variant. The name of the event to simulate. The list of possible events depends on the object.
	Required. None The Args argument is passed to the constructor of the event's EventArgs object or the implementing class. Enter the values in a comma separated list. If no event arguments are required, you do not need to supply a value for the argument.

Return Type

None.

IMPORTANT

The event is sent to all listeners of the .NET object and does not affect the .NET object itself. For example, simulating a click event does not actually perform the click.

Example

GetErrorProviderText Method

Description

Returns the tooltip text of the error icon associated with the object.

Syntax

object.GetErrorProviderText

Return Type

A String value.

If no error provider control currently exists for the object, the method returns an empty string.

Example

GetTextLocation Method

Description

Checks whether the specified text string is contained in the specified window area.

Syntax

object.GetTextLocation (TextToFind, Left, Top, Right, Bottom, [MatchWholeWordOnly])

Arguments

Parameter	Description
TextToFind	Required. A String value. The text string you want to locate.
Left	Required. A Variant. The left coordinate of the search area within the window or screen, as a long integer.
Top	Required. A Variant. The top coordinate of the search area within the window or screen, as a long integer.
Right	Required. A Variant. The right coordinate of the search area within the window or screen, as a long integer.
Bottom	Required. A Variant. The bottom coordinate of the search area within the window or screen, as a long integer. Note: Set the Left, Top, Right, and Bottom coordinates to -1 to search for the text string within the object's entire window.
MatchWholeWordOnly	Optional. A Boolean value. If True, the method searches for occurrences that are whole words only and not part of a larger word. If False, the method does not restrict the results to occurrences that are whole words only. Default value = True

Return Type

A Boolean value.

Indicates whether the text was found in the specified coordinates. Additionally, if the text is found, this method returns the coordinates of the rectangle containing the first instance of the text into the Left, Top, Right, and Bottom arguments.

IMPORTANT

The text to capture must be visible in the application window when the step runs.
This method returns True only if the TextToFind argument value is found within a single line in the specified area. The text search restarts on each line of text.
If the TextToFind argument value includes a space, then this method searches for that text as whole words, regardless of the value set in the MatchWholeWords argument. For example, if you search for "a b" and the text "bla bla" exists, the method will still return False. However, if the MatchWholeWords argument is set to False, then a search for "la" in an area where "bla bla" exists, would return True.
If the text is found (return value = True) and if the Left, Top, Right, and Bottom arguments are supplied as variables, then the method also returns the exact coordinates of the specified text to the supplied arguments (the returned coordinates overwrite the supplied ones).
The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing node > Text Recognition node).
The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty Method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetTextLocation method.
By default, when OpenText Functional Testing captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If OpenText Functional Testing cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).

Example

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

object.GetVisibleText ([Left], [Top], [Right], [Bottom])

Arguments

Parameter	Description
Left	Optional. A long integer value. The left coordinate of the search area within the object's window. Default value = -1
Top	Optional. A long integer value. The top coordinate of the search area the object's window. Default value = -1
Right	Optional. A long integer value. The right coordinate of the search area within the object's window. Default value = -1
Bottom	Optional. A long integer value. The bottom coordinate of the search area a within the object's window. Note: If the Left, Top, Right, and Bottom arguments are not specified, the method returns all of the text within the visible part of the specified object. Default value = -1

Return Type

A String value.

IMPORTANT

The text to capture must be visible in the application window when the step runs.
The area is defined by pairs of coordinates that designate two diagonally opposite corners of a rectangle.
The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition node).
The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty Method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetVisibleText method.
By default, when OpenText Functional Testing captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If OpenText Functional Testing cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).

Example

HScroll Method

Description

Horizontally scrolls an object that has embedded scroll bars.

Syntax

object.HScroll (Option, [Item])

Arguments

Parameter

Description

Option

Required. A long integer value.
Indicates the direction and increment-type to scroll. See the Constants table, below.

Constant		Value	Description
	micLineNext	0	Scrolls X lines forwards, where X is specified by the Item argument.
	micLinePrev	1	Scrolls X lines backwards, where X is specified by the Item argument.
	micPageNext	2	Scrolls X pages forward, where X is specified by the Item argument.
	micPagePrev	3	Scrolls X pages backward, where X is specified by the Item argument.
	micScrollStart	4	Scrolls to the beginning of the scrollbar.
	micScrollEnd	5	Scrolls to the end of the scrollbar.
	micSetPos	6	Scrolls to the position specified by the Item argument.

Item

Optional. A long integer value.

For micLineNext, micLinePrev, micPageNext, micPagePrev, this value specifies the quantity of lines or pages to scroll.
For micSetPos, this value specifies the exact position of the scroll bar.
When specifying micScrollEnd or micScrollStart, do not specify a value for this argument.

Default value = 1

Return Type

None.

IMPORTANT

An embedded scroll bar is a scroll bar that uses WS_VSCROLL and/or WS_HSCROLL styles. This scroll bar is not a separate control and therefore is not recognized as a SwfScrollBar object.

Example

MouseMove Method

Description

Moves the mouse pointer to the designated position over the object.

Syntax

object.MouseMove X, Y

Arguments

Parameter	Description
X	Required. An integer value. The position of the mouse pointer, expressed as x-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.
Y	Required. An integer value. The position of the mouse pointer, expressed as y-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.

Return Type

None

Example

Type Method

Description

Types the specified string in the object.

Syntax

object.Type KeyboardInput

Arguments

Parameter

Description

KeyboardInput

Required. A String value.

The text string and/or constants representing non-alphanumeric keys.

The following constants are available:

Constant	Action
micCtrlDwn	Presses the Ctrl key.
micCtrlUp	Releases the Ctrl key.
micLCtrlDwn	Presses the left Ctrl key.
micLCtrlUp	Releases the left Ctrl key.
micRCtrlDwn	Presses the right Ctrl key.
micRCtrlUp	Releases the right Ctrl key.
micAltDwn	Presses the Alt key.
micAltUp	Releases the Alt key.
micLAltDwn	Presses the left Alt key.
micLAltUp	Releases the left Alt key.
micRAltDwn	Presses the right Alt key.
micRAltUp	Releases the right Alt key.
micShiftDwn	Presses the Shift key.
micShiftUp	Releases the Shift key.
micLShiftDwn	Presses the left Shift key.
micLShiftUp	Releases the left Shift key.
micRShiftDwn	Presses the right Shift key.
micRShiftUp	Releases the right Shift key.
micIns	Presses the Insert key.
micDel	Presses the Delete key.
micHome	Presses the Home key.
micEnd	Presses the End key.
micPgUp	Presses the Page Up key.
micPgDwn	Presses the Page Down key.
micUp	Presses the Up Arrow key.
micDwn	Presses the Down Arrow key.
micLeft	Presses the Left Arrow key.
micRight	Presses the Right Arrow key.
micEsc	Presses the Esc key.
micBack	Presses the Backspace key.
micReturn	Presses the Return key.
micTab	Presses the Tab key.
micBreak	Presses the Break key.
micPause	Presses the Pause key.
micPrintScr	Presses the Print Screen key.
micWinLogoDwn	Presses the Windows Logo key.
micWinLogoUp	Releases the Windows Logo key.
micLWinLogoDwn	Presses the left Windows Logo key.
micLWinLogoUp	Releases the left Windows Logo key.
micRWinLogoDwn	Presses the right Windows Logo key.
micRWinLogoUp	Releases the right Windows Logo key.
micAppKey	Presses the Application key.
micF1	Presses the F1 key.
micF2	Presses the F2 key.
micF3	Presses the F3 key.
micF4	Presses the F4 key.
micF5	Presses the F5 key.
micF6	Presses the F6 key.
micF7	Presses the F7 key.
micF8	Presses the F8 key.
micF9	Presses the F9 key.
micF10	Presses the F10 key.
micF11	Presses the F11 key.
micF12	Presses the F12 key.
micNumLockOn	Turns on the Num Lock.
micCapsLockOn	Turns on the Caps Lock.
micScrollOn	Turns on the Scroll Lock.
micNumLockOff	Turns off the Num Lock.
micCapsLockOff	Turns off the Caps Lock.
micScrollOff	Turns off the Scroll Lock.

Return Type

None

IMPORTANT

Although the Type method is supported for most objects, if you enter a Type statement for an object in which a user cannot enter text, the method has no visual effect.

Example

VScroll Method

Description

Vertically scrolls an object that has embedded scroll bars.

Syntax

object.VScroll (Option, [Item])

Arguments

Parameter

Description

Option

Required. A long integer value.
Indicates the direction and increment-type to scroll. See the Constants table, below.

Constant		Value	Description
	micLineNext	0	Scrolls X lines down, where X is specified by the Item argument.
	micLinePrev	1	Scrolls X lines up, where X is specified by the Item argument.
	micPageNext	2	Scrolls X pages down, where X is specified by the Item argument.
	micPagePrev	3	Scrolls X pages up, where X is specified by the Item argument.
	micScrollStart	4	Scrolls to the top of the scrollbar.
	micScrollEnd	5	Scrolls to the bottom of the scrollbar.
	micSetPos	6	Scrolls to the position specified by the Item argument.

Item

Optional. A long integer value.

For micLineNext, micLinePrev, micPageNext, micPagePrev, this value specifies the quantity of lines or pages to scroll.
For micSetPos, this value specifies the exact position of the scroll bar.
When specifying micScrollEnd or micScrollStart, do not specify a value for this argument.

Default value = 1

Return Type

None.

IMPORTANT

An embedded scroll bar is a scroll bar that uses WS_VSCROLL and/or WS_HSCROLL styles. This scroll bar is not a separate control and therefore is not recognized as SwfScrollBar object.