Object Model Reference for GUI Testing > SAPNWBC > Activate Method

SAPNWBCShellWindow Object

Description

A shell window control in SAP NWBC Desktop.

IMPORTANT

The SAPNWBCShellWindow test object class extends the WpfWindow test object class and inherits many of its operations and description properties.

Operations

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

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

Method Activate Activates the window.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the object.
Method Close Closes the window.
Method ClosePage Closes a tab page.
Method DblClick Double-clicks the object.
Method Drag Performs the 'drag' part of a drag-and-drop operation.
Method Drop Performs the 'drop' part of a drag-and-drop operation.
Common Method GetROProperty Returns the current value of the specified description properties from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method GetVisibleText Returns the text from the specified area.
Method MakeVisible Scrolls the object into view if it is not visible in the parent window.
Method Maximize Maximizes the window to fill the entire screen.
Method Minimize Minimizes the window to an icon.
Method MouseMove Moves the mouse pointer to the designated position over the object.
Method Move Moves the window to the specified absolute location on the screen.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs QuickTest to re-identify the object in the application the next time a step refers to this object.
Method Resize Resizes the window to the specified dimensions.
Method Restore Restores the window to its previous size.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method ShowContextMenu Displays the control's context menu.
Common Method ToString Returns a string that represents the current test object.
Method Type Types the specified string in the object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property AutomationElement Accesses the native methods and properties of the AutomationElement object for the corresponding user interface object.
Property AutomationPattern The object that provides access to the specified Control Pattern for the run-time object.
Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the user interface object.
Property SupportedPatterns Returns all of the currently supported patterns of the object.

 

Back to top

Activate Method

Description

Activates the window.

Syntax

object.Activate [BUTTON]

Arguments

Parameter Description
BUTTON Optional. A predefined constant or number.
The mouse button used to click the window.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

Click Method

Description

Clicks the object.

Syntax

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

Arguments

Parameter Description
X Optional. A Variant.
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.
Y Optional. A Variant.

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. micNoCoordinate indicates the center of the object.

BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

Close Method

Description

Closes the window.

Syntax

object.Close

Return Type

None

Example


 

Back to top

ClosePage Method

Description

Closes a tab page.

Syntax

object.ClosePage value

Arguments

Parameter Description
value Required. A Variant.
The tab to close. You can specify the tab name or the index using the format #N. The index begins with 1.

Return Type

None

Example


 

Back to top

DblClick Method

Description

Double-clicks the object.

Syntax

object.DblClick X, Y, [BUTTON]

Arguments

Parameter Description
X Required. A Variant.
The x-coordinate of the double-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.
Y Required. A Variant.

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. micNoCoordinate indicates the center 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


 

Back to top

Drag Method

Description

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

Syntax

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

Arguments

Parameter Description
X Optional. A Variant.
The x-coordinate 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 Optional. A Variant.
The y-coordinate 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


 

Back to top

Drop Method

Description

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

Syntax

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

Arguments

Parameter Description
X Optional. A Variant.
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 Optional. A Variant.
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


 

Back to top

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

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

Arguments

Parameter Description
Left Optional. An integer value.
The left coordinate of the search area within the object's window.
Default value = 0
Top Optional. An integer value.
The top coordinate of the search area within the object's window.
Default value = 0
Right Optional. An integer value.
The right coordinate of the search area within the object's window.
Default value = 0
Bottom Optional. An integer value.
The bottom coordinate of the search area within the object's window.
Default value = 0

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 opposite corners of a rectangle.

Note:

The GetVisibleText method may behave differently in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, the APIs used in your application, and so on. Therefore, when possible, it is highly recommended to use the GetROProperty method or the Object property to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetVisibleText method.

Example


 

Back to top

MakeVisible Method

Description

Scrolls the object into view if it is not visible in the parent window.

Syntax

object.MakeVisible

Return Type

None

Example


 

Back to top

Maximize Method

Description

Maximizes the window to fill the entire screen.

Syntax

object.Maximize

Return Type

None

Example


 

Back to top

Minimize Method

Description

Minimizes the window to an icon.

Syntax

object.Minimize

Return Type

None

Example


 

Back to top

MouseMove Method

Description

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

Syntax

object.MouseMove X, Y

Arguments

Parameter Description
X Required. A Variant.
The x-coordinate of the mouse pointer, relative to the upper left corner of the object.
Y Required. A Variant.
The y-coordinate of the mouse pointer, relative to the upper left corner of the object.

Return Type

None

IMPORTANT

The MouseMove method may behave unexpectedly in a VMWare environment.

Workaround: Add the following line to the VMWare configuration file (<VM name>.vmx): vmmouse.present = "FALSE"

For more information, refer to the VMware support article, number 1691 - "Unexpected Cursor Behavior in Windows Virtual Machine with "Snap To" Mouse Control Panel Option Enables", at http://www.vmware.com/support/kb/enduser/std_alp.php.


 

Back to top

Move Method

Description

Moves the window to the specified absolute location on the screen.

Syntax

object.Move X, Y

Arguments

Parameter Description
X Required. A Variant.
The new horizontal pixel location for the top left corner of the window.
Y Required. A Variant.
The new vertical pixel location for the top left corner of the window.

Return Type

None

Example


 

Back to top

Resize Method

Description

Resizes the window to the specified dimensions.

Syntax

object.Resize Width, Height

Arguments

Parameter Description
Width Required. A Variant.
The new width of the window, in pixels.
Height Required. A Variant.
The new height of the window, in pixels.

Return Type

None

Example


 

Back to top

Restore Method

Description

Restores the window to its previous size.

Syntax

object.Restore

Return Type

None

Example


 

Back to top

ShowContextMenu Method

Description

Displays the control's context menu.

Syntax

object.ShowContextMenu

Return Type

None

Example


 

Back to top

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.


 

Back to top

AutomationElement Property

Description

Accesses the native methods and properties of the AutomationElement object for the corresponding user interface object.

Syntax

object.AutomationElement

Value Type

An Object.

Property type

Read-only property

IMPORTANT

The AutomationElement property returns an object that represents a SAP NWBC Desktop Automation element. The returned object provides access to the common methods and properties specific to the element's control type.

You can use the Automation Pattern property to access the properties and methods provided by UI Automation for a specific instance of a Control Pattern of the element's control type.

You can use the Object property to access the properties and methods of SAPNWBC user interface objects.

Example


 

Back to top

AutomationPattern Property

Description

The object that provides access to the specified Control Pattern for the run-time object.

Syntax

object.AutomationPattern (NameOrIndex)

Arguments

Parameter Description
NameOrIndex Required. A Variant.
The name or index of the Automation Pattern to acces. When specifying the index, the first item in the list of supported patterns is numbered 0.

Value Type

An Object.

Property type

Read-only property

IMPORTANT

The AutomationPattern property returns an object the provides access to a specific instance of a ControlPattern.

Tip: Use the SupportedPatterns Property to access a list of the currently supported patterns for the object.

You can use the AutomationElement property to access the common methods and properties provided by UI Automation that are specific to the element's control type.

You can use the Object property to access the properties and methods of SAPNWBC user interface objects.

Example


 

Back to top

SupportedPatterns Property

Description

Returns all of the currently supported patterns of the object.

Syntax

object.SupportedPatterns

Value Type

A String value.

Property type

Read-only property

IMPORTANT

A control may not always support the same set of control patterns. For example, a multiline edit box supports vertical scrolling only if the number of lines it contains exceeds its viewable area. Scrolling is disabled when enough text is removed so that scrolling is not required.

Example


Back to top

See also: