SAPNWBCOKCode Object

Description

An SAP OK Code box in a SAP NWBC desktop application.

IMPORTANT

The SAPNWBCOKCode test object class extends the WpfEdit 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 SAPNWBCOKCode object.

Note: You can also view a list and descriptions of the SAPNWBCOKCode 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, depending on the specified file extension.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Method ClickClicks the object.
Method DblClickDouble-clicks the object.
Method DragPerforms the 'drag' part of a drag-and-drop operation.
Method DropPerforms the 'drop' part of a drag-and-drop operation.
Common Method GetAllROProperties

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

Common Method GetROPropertyReturns the current value of the specified description property from the object in the application.
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 MakeVisibleScrolls the object into view if it is not visible in the parent window.
Method MouseMoveMoves the mouse pointer to the designated position over the object.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs QuickTest to re-identify the object in the application the next time a step refers to this object.
Method SelectSelects the specified item from the prompt list.
Method SetSets the value of the edit box.
Method SetMultiLineSelectionSelects the text in a multi-line edit box.
Method SetSecureSets the encrypted value of the edit box.
Method SetSingleLineSelectionSelects the text in a single-line edit box.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method ShowContextMenuDisplays the control's context menu.
Method SubmitSubmits the entered information.
Common Method ToStringReturns a string that represents the current test object.
Method TypeTypes the specified string in the object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property AutomationElementAccesses the native methods and properties of the AutomationElement object for the corresponding user interface object.
Property AutomationPatternThe object that provides access to the specified Control Pattern for the run-time object.
Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the user interface object.
Property SupportedPatternsReturns all of the currently supported patterns of the object.
Property SupportsTextSelectionIndicates whether the edit box supports text selection.

Back to top

 

Click Method

Description

Clicks the object.

Syntax

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

Arguments

ParameterDescription
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

                    'The following example clicks the SAPNWBCOKCode edit box control.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Click

Back to top

 

DblClick Method

Description

Double-clicks the object.

Syntax

object.DblClick X, Y, [BUTTON]

Arguments

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

                    'The following example double-clicks the SAPNWBCOKCode edit box.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").DblClick

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 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

                    'The following example drags the SAPNWBCOKCode edit box.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Drag 2,2,micLeftBtn

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 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

                    'The following example drops a dragged SAPNWBCOKCode edit box object.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Drop 2,3,MicRightBtn

Back to top

 

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

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

Arguments

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

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 = 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, or the APIs used in your application. 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

                    'The following example retrieves the text found in an SAPNWBCOKCode edit box.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").GetVisibleText

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

                    'The following example makes the SAPNWBCOKCode edit box visible in an application.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").MakeVisible

Back to top

 

MouseMove Method

Description

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

Syntax

object.MouseMove X, Y

Arguments

ParameterDescription
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

Example

                    'The following example uses the MouseMove method to move the mouse pointer to the top
'left corner of the SAPNWBCOKCode edit box object.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").MouseMove 0,0

Back to top

 

Select Method

Description

Selects the specified item from the prompt list.

Syntax

object.Select value

Arguments

ParameterDescription
value Required. A String value.
The value to select from the list.

Return Type

None

IMPORTANT

You must use a Set Method statement before this method.

Example

                    'The following example selects a value from the edit box list.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Select "va01"

Back to top

 

Set Method

Description

Sets the value of the edit box.

Syntax

object.Set text

Arguments

ParameterDescription
text Required. A String value.
The text to be entered in the edit box.

Return Type

None

Example

                    'The following example sets a value in the SAPNWBCOKCode edit box.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Set "va01"

Back to top

 

SetMultiLineSelection Method

Description

Selects the text in a multi-line edit box.

Syntax

object.SetMultiLineSelection LineFrom, ColumnFrom, LineTo, ColumnTo

Arguments

ParameterDescription
LineFrom Required. A Variant.
The line at which the selection starts. The first line is numbered 0.
ColumnFrom Required. A Variant.
The column at which the selection starts (in characters). The first column is numbered 0.
LineTo Required. A Variant.
The line at which the selection ends. The first line is numbered 0.
ColumnTo Required. A Variant.
The column at which the selection ends (in characters). The first column is numbered 0.

Return Type

None

IMPORTANT

To select text in a single-line edit box, use the SetSingleLineSelection Method.

Example

                    'The following example uses the SetMultiSelection method to select text in the SAPNWBCode object.
'The text will be selected from the second line and second column to the third line and third column
'of the SAPNWBCOKCode object.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Set "123" + vbCrLf +"4567" + vbCrLf + "8910"
SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").SetMultiLineSelection 1, 1, 2, 1

Back to top

 

SetSecure Method

Description

Sets the encrypted value of the edit box.

Syntax

object.SetSecure text

Arguments

ParameterDescription
text Required. A String value.
The encrypted text to be entered in the edit field.

Return Type

None

Example

                    'The following example enters an encrypted password in the SAPNWBCOKCode edit box.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").SetSecure "5406aa0a1d3ab142c531ecc374f6"

Back to top

 

SetSingleLineSelection Method

Description

Selects the text in a single-line edit box.

Syntax

object.SetSingleLineSelection ColumnFrom, ColumnTo

Arguments

ParameterDescription
ColumnFrom Required. A Variant.
The column at which the selection starts (in characters). The first column is numbered 0.
ColumnTo Required. A Variant.
The column at which the selection ends (in characters). The first column is numbered 0.

Return Type

None

IMPORTANT

To select text in a multi-line edit box, use the SetMultiLineSelection Method.

Back to top

 

ShowContextMenu Method

Description

Displays the control's context menu.

Syntax

object.ShowContextMenu

Return Type

None

Example

                    'The following example opens the context menu of a button object and selects the 'Copy' item.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").ShowContextMeu
SAPNWBCShellWindow("Index").WpfMenu("WpfMenu").Select "Copy"

Back to top

 

Submit Method

Description

Submits the entered information.

Syntax

object.Submit

Return Type

None

Back to top

 

Type Method

Description

Types the specified string in the object.

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.

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

                    'The following example uses the AutomationElement property to obtain the ClassName
'of the UI control related to the test object.

SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").AutomationElement.Current.ClassName

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

ParameterDescription
NameOrIndex Required. A Variant.
The name or index of the Automation Pattern to access. 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

                    'The following example uses the AutomationPattern property to toggle the state of the
'check box object.

SAPNWBCShellWindow("Index").SAPNWBCToggleButton("Open Favorites Panel").AutomationPattern("Toggle").Toggle

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

                    'The following example uses the SupportedPatterns property to check if the 
'SAPNWBCWindow object supports the Transform pattern. If it does, the window will
'be resized. If it does not, then an error message will be sent to the report.

patterns = SAPNWBCShellWindow("Index").SupportedPatterns
If InStr(1, patterns, "Transform") Then
	SAPNWBCShellWindow("Index").Resize 200, 200
	Else
   Reporter.ReportEvent micWarning, "Index", "The Transform pattern is not supported." End If

Back to top

 

SupportsTextSelection Property

Description

Indicates whether the edit box supports text selection.

Syntax

object.SupportsTextSelection

Value Type

A Boolean value.

Property type

Read-only property

Example

                    'The following example confirms that the edit box supports text selection and then
'copies the first 6 characters from the edit box to the clipboard.

CanSelect = SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").SupportsTextSelection
If CanSelect <> FalseThen
	SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").SetSingleLineSelection 0, 5
	SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Type micCtrlDwn
	SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Type "c"
	SAPNWBCShellWindow("Index").SAPNWBCOKCode("search or enter application").Type micCtrlUp
End If

Back to top

See also: