VbScrollBar Object

Description

A Visual Basic scroll bar.

Operations

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

Note: You can also view a list and descriptions of the VbScrollBar 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

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ClickClicks the window.
Method DblClickDouble-clicks the window.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag and drop operation.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetTextLocationChecks whether the specified text string is contained in the specified window area.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method GetVisibleTextReturns the text from the specified area.
Method MouseMoveMoves the mouse pointer to the designated position inside the window.
Method NextLineMoves the scroll bar downward, or to the right, the specified number of lines.
Method NextPageMoves the scroll bar downward, or to the right, the specified number of pages.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PrevLineMoves the scroll bar upward, or to the left, the specified number of lines.
Method PrevPageMoves the scroll bar upward, or to the left, the specified number of pages.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SetSets the scroll bar position.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Method TypeTypes the specified string in the window.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the Visual Basic object.

Back to top

 

Click Method

Description

Clicks the window.

Syntax

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

Arguments

ParameterDescription
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 (-9999) 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

                    'The following example uses the Click method to click a right mouse
'button at coordinates 47, 131 on the OK button.

VbWindow("frmLogin").VbButton("OK").Click 47, 131,

Back to top

 

DblClick Method

Description

Double-clicks the window.

Syntax

object.DblClick X, Y, [BUTTON]

Arguments

ParameterDescription
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

                    'The following example uses the DblClick method to double-click a
'right mouse button at coordinates 73, 120 on "SysListView32"
'object.

VbWindow("frmMain").VbListView("SysListView32").DblClick 73, 120, 1

Back to top

 

Drag Method

Description

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

Syntax

object.Drag X, Y, [BUTTON]

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate within the object 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 y-coordinate within the object 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

                    'The following example uses the Drag method to drag and drop an object in the
'InsertOrder frame.

VbWindow("frmMain").VbFrame("Insert Order").Drag 10, 20
VbWindow("frmMain").VbFrame("Insert Order").Drop 30, 40
                    'The following example uses the Drag method to drag the object
'from coordinates 10, 20 within the Test window and drop the object
'at coordinates 30, 40 within the OtherWindow window.

VbWindow("Test").Drag 10, 20
VbWindow("OtherWindow").Drop 30, 40

Back to top

 

Drop Method

Description

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

Syntax

object.Drop X, Y, [BUTTON]

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate 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 y-coordinate 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 mouse button that is released to drop the object.
Default value = micLeftBtn

Return Type

None

Example

                    'The following example uses the Drop method to drag and drop the
'InsertOrder frame.

VbWindow("frmMain").VbFrame("Insert Order").Drag 10, 20
VbWindow("frmMain").VbFrame("Insert Order").Drop 30, 40
                    'The following example uses the Drop method to drag the object
'from coordinates 10, 20 within the Test window and drop the
'object at coordinates 30, 40 within the OtherWindow.

VbWindow("Test").Drag 10, 20
VbWindow("OtherWindow").Drop 30, 40

Back to top

 

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

ParameterDescription
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.
Top Required. A Variant.
The top coordinate of the search area within the window or screen.
Right Required. A Variant.
The right coordinate of the search area within the window or screen.
Bottom Required. A Variant.
The bottom coordinate of the search area within the window or screen.

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.

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 tab > Text Recognition pane).
  • 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 UFT One 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 UFT One 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

                    'The following example uses the GetTextLocation method to retrieve
'all of the text within the object.

l = -1
t = -1
r = -1
b = -1
result = VbWindow("frmMain").VbEdit("txtName").GetTextLocation("2002", l, t, r, b)
If result Then
 MsgBox "Text found. Coordinates:" & l & "," & t & "," & r & "," & b
End If

Back to top

 

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

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

Arguments

ParameterDescription
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 within 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 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.

The method returns the retrieved text, if any.  Additionally, if text is found, the exact coordinates of the text are returned to the Left, Top, Right, and Bottom arguments.

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 pane).
  • 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 UFT One 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 UFT One 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

                    'The following example uses the GetVisibleText method to retrieve
'the text from the "Test" window. If the returned string contains
'the "login:" sub-string, the Type method is used to type the
'"guest" string in the window.

TestText = VbWindow("Test").GetVisibleText
If InStr(1, TestText, "login:", 1) > 0 Then
VbWindow("Test").Type "guest"
End If
                    'The following example uses the GetVisibleText method to retrieve
'the text within the specified coordinates. If the returned string
'is not "Catalog", the ReportEvent method is used to report a
'failed step.

theText = VbWindow("frmMain").VbLabel("Name").GetVisibleText(16, 25, 56, 92)
If theText <> "Catalog" Then
 Reporter.ReportEvent micFail, "Traders", "Text check failed"
End If

Back to top

 

MouseMove Method

Description

Moves the mouse pointer to the designated position inside the window.

Syntax

object.MouseMove X, Y

Arguments

ParameterDescription
X Required. An integer value.
The position of the mouse pointer, expressed as an x (pixel) coordinate. 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 a y (pixel) coordinate. Note that the specified coordinates are relative to the upper left corner of the object.

Return Type

None

Example

                    'The following example uses the MouseMove method to move the mouse
'pointer to the position (20, 30) inside the "Insert Order" button.

VbWindow("frmMain").VbButton("Insert Order").MouseMove 20, 30

Back to top

 

NextLine Method

Description

Moves the scroll bar downward, or to the right, the specified number of lines.

Syntax

object.NextLine [Item]

Arguments

ParameterDescription
Item Optional. A long integer value.
The number of lines to move the scroll bar. Default = 1.
Default value = 1

Return Type

None

Example

                    'The following example uses the NextLine method to move the scroll bar 7 lines down.

VbWindow("frmMain").VbScrollBar("ScrollBar").NextLine 7

Back to top

 

NextPage Method

Description

Moves the scroll bar downward, or to the right, the specified number of pages.

Syntax

object.NextPage [Item]

Arguments

ParameterDescription
Item Optional. A long integer value.
The number of pages to move the scroll bar. Default = 1.
Default value = 1

Return Type

None

Example

                    'The following example uses the NextPage method to move the scroll bar
'7 pages down.

VbWindow("frmMain").VbScrollBar("ScrollBar").NextPage 7

Back to top

 

PrevLine Method

Description

Moves the scroll bar upward, or to the left, the specified number of lines.

Syntax

object.PrevLine [Item]

Arguments

ParameterDescription
Item Optional. A long integer value.
The number of lines to move the scroll bar. Default = 1.
Default value = 1

Return Type

None

Example

                    'The following example uses the PrevLine method to move the scroll bar
'5 lines up.

VbWindow("frmMain").VbScrollBar("ScrollBar").PrevLine 5

Back to top

 

PrevPage Method

Description

Moves the scroll bar upward, or to the left, the specified number of pages.

Syntax

object.PrevPage [Item]

Arguments

ParameterDescription
Item Optional. A long integer value.
The number of pages to move the scroll bar. Default = 1.
Default value = 1

Return Type

None

Example

                    'The following example uses the PrevPage method to move the scroll bar
'up 5 pages.

VbWindow("frmMain").VbScrollBar("ScrollBar").PrevPage 5

Back to top

 

Set Method

Description

Sets the scroll bar position.

Syntax

object.Set Position

Arguments

ParameterDescription
Position Required. A Variant.
The scroll bar position to be set.

Return Type

None

Example

                    'The following example uses the Set method to set the scroll bar to
'position 77

VbWindow("frmMain").VbScrollBar("ScrollBar").Set 77

Back to top

 

Type Method

Description

Types the specified string in the window.

Syntax

object.Type KeyboardInput

Arguments

ParameterDescription
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

                    'The following example uses the Type method to press the "OK" button
'by pressing the "Enter" key.
VbWindow("frmLogin").VbButton("OK").Type micReturn

Back to top

See also: