WpfDXGrid Object

Description

A DevExpress Data Grid control in a WPF application.

IMPORTANT

  • Because WPF Automation Elements of the same control type may support a different set of control patterns, the test object methods or properties that UFT One supports for a specific WpfDXGrid test object may be different from the standard set of methods and properties listed in this section. For more information on control patterns, see the WPF Add-in section of the UFT One Help Center.

  • For a list of supported grid control versions, see the UFT One Support Matrix.

Operations

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

Note: You can also view a list and descriptions of the WpfDXGrid 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 ActivateCellDouble-clicks the specified cell in a grid.
Method AddCellToSelection

Selects a cell in addition to previously selected cells.

Method AddRowToSelection

Selects a row in addition to previously selected rows.

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.
Method ClearSelectionDeselects any selected rows or cells in the grid.
Method ClickClicks the object.
Method DblClickDouble-clicks the object.
Method DeselectCell

Deselects the specified cell.

Method DeselectRow

Deselects the specified row.

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.

Method GetCellDataRetrieves the contents of the specified cell in the grid.
Method GetCellPropertyReturns the value of a grid cell property.
Method GetColumnCountReturns the number of columns in the grid.
Method GetColumnNamesReturns the headers of the columns in the grid.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetRowCountReturns the number of rows in the grid.
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.
Method GetVisibleTextReturns the text from the specified area.
Common Method HighlightHighlights the object in the application.
Method IsRowSelectedIndicates whether the specified row is selected.
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 UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectCellSelects (clicks) the specified cell in the grid.
Method SelectRowSelects the specified row.
Method SetCellDataSets the contents of a cell with the specified string.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method ShowContextMenuDisplays the control's context menu.
Common Method ToStringReturns a string that represents the 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 object.
Property SupportedPatternsReturns all of the currently supported patterns of the object.

Back to top

 

ActivateCell Method

Description

Double-clicks the specified cell in a grid.

Syntax

object.ActivateCell row, Column

Arguments

ParameterDescription
row Required. A Variant.
The 0-based number of the row you want to activate.
Column Required. A Variant.
The location of the column within the grid. Use the column header name or the 0-based column number.

Return Type

None

Example

Back to top

 

AddCellToSelection Method

Description

Selects a cell in addition to previously selected cells.

Syntax

object.AddCellToSelection row, Column

Arguments

ParameterDescription
row Required. A Variant.
The 0-based number of the row you want to add to the selection.
Column Required. A Variant.

The location of the column within the grid. Use the column header name or the 0-based column number.

Return Type

None

Example

Back to top

 

AddRowToSelection Method

Description

Selects a row in addition to previously selected rows.

Syntax

object.AddRowToSelection row

Arguments

ParameterDescription
row Required. A Variant.
The 0-based number of the row you want to add to the selection.

Return Type

None

Example

Back to top

 

ClearSelection Method

Description

Deselects any selected rows or cells in the grid.

Syntax

object.ClearSelection

Return Type

None.

Example

Back to top

 

Click Method

Description

Clicks the object.

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


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

Back to top

 

DblClick Method

Description

Double-clicks the object.

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. The default value is the center of the object.
Y Required. 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. 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

 

DeselectCell Method

Description

Deselects the specified cell.

Syntax

objectDeselectCell row, column

Arguments

ParameterDescription
row

Required. A Variant.

The location of the row within the grid. Specify the 0-based number of the row in the current view.

column

Required. A Variant.

The location of the column within the grid. Specify the column header name (string) or the 0-based column number.

Return Type

None.

Example

Back to top

 

DeselectRow Method

Description

Deselects the specified row.

Syntax

object.DeselectRow row

Arguments

ParameterDescription
row

Required. A Variant.

The location of the row within the grid. Specify the 0-based number of the row in the current view.

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

ParameterDescription
X Optional. An integer value.
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.
Default value = -9999
Y Optional. An integer value.
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.
Default value = -9999
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

ParameterDescription
X Optional. 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.
Default value = -9999
Y Optional. 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.
Default value = -9999
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

 

GetCellData Method

Description

Retrieves the contents of the specified cell in the grid.

Syntax

object.GetCellData (row, Column)

Arguments

ParameterDescription
row Required. A Variant.
The 0-based index of the row containing the cell whose data you want to retrieve.
Column Required. A Variant.
The location of the column within the grid. Use the column header name or the 0-based column number.

Return Type

A String value.

Example

Back to top

GetCellProperty Method

Description

Returns the value of a grid cell property.

Syntax

object.GetCellProperty Row, Column, PropertyName

Arguments

ParameterDescription
Row

Required. A Variant.

The 0-based index of the row within the grid.

Column

Required. A Variant. The location of the column within the grid.

Specify the column header name or the 0-based column number.

PropertyName

Required. A String value.

The name of the property, specified as a string.

Possible values:

  • x: The X-coordinate of the specified cell relative to the table.

  • y: The Y-coordinate of the specified cell relative to the table.

  • width: The width of the specified cell.

  • height: The height of the specified cell.

  • value: The content of the specified cell.

  • colname: The column header of the specified cell.

   

Return Type

A Variant.

Returns the value of the specified property.

If the specified PropertyName is not one of the supported properties, a NOT_IMPLEMENTED error occurs.

Example

Back to top

 

GetColumnCount Method

Description

Returns the number of columns in the grid.

Syntax

object.GetColumnCount [includeHiddenColumns]

Arguments

ParameterDescription
includeHiddenColumns

Optional. A Boolean value.

Indicates whether to include the grid's hidden columns in the count. (Default = false)

Return Type

An Integer.

Example

Back to top

 

GetColumnNames Method

Description

Returns the headers of the columns in the grid.

Syntax

object.GetColumnNames [includeHiddenColumns]

Arguments

ParameterDescription
includeHiddenColumns

Optional. A Boolean value.

Indicates whether to include the names of the grid's hidden columns. (Default = false)

Return Type

A list of strings.

Example

Back to top

GetRowCount Method

Description

Returns the number of rows in the grid.

Syntax

object.GetRowCount [includeHiddenRows]

Arguments

ParameterDescription
includeHiddenRows

Optional. A Boolean value.

Indicates whether to include the grid's hidden rows in the count. (Default = false)

Note: When data grouping is applied, group rows are not included in the count if you set the parameter to true.

Return Type

An Integer.

Example

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

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.

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

Back to top

 

IsRowSelected Method

Description

Indicates whether the specified row is selected.

Syntax

object.IsRowSelected row

Arguments

ParameterDescription
row

A row of Variant type.

The location of the row within the grid. Specify the 0-based number of the row.

Return Type

A Boolean value.

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

 

MouseMove Method

Description

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

Syntax

object.MouseMove (X, Y)

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate of the mouse pointer, relative to the upper left corner of the object.
Y Required. An integer value.
The y-coordinate of the mouse pointer, relative to the upper left corner of the object.

Return Type

None.

Example

Back to top

 

SelectCell Method

Description

Selects (clicks) the specified cell in the grid.

Syntax

object.SelectCell row, Column

Arguments

ParameterDescription
row Required. A Variant.
The 0-based index of the row containing the cell you want to select.
Column Required. A Variant.
The location of the column within the grid. Use the column header name or the 0-based column number.

Return Type

None

Example

Back to top

 

SelectRow Method

Description

Selects the specified row.

Syntax

object.SelectRow Row

Arguments

ParameterDescription
Row

Required. A Variant.

The location of the row within the grid.

Specify the 0-based number of the row in the current view.

Return Type

None

Example

Back to top

 

SetCellData Method

Description

Sets the contents of a cell with the specified string.

Syntax

object.SetCellData row, Column, data

Arguments

ParameterDescription
row Required. A Variant.
The 0-based index of the row containing the cell data you want to set.
Column Required. A Variant.
The location of the column within the grid. Use the column header name or the 0-based column number.
data Required. A String value.
The contents to be entered into the specified cell.

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

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

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 Windows Presentation Foundation UI Automation element. The returned object provides access to the common methods and properties specific to the element's control type. For more information, see the WPF Add-in section of the UFT One Help Center.

You can use the AutomationPattern 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 Windows Presentation Foundation user interface objects.

For more information, see the WPF Add-in section of the UFT One Help Center.

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

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 that provides access to a specific instance of a Control Pattern. For more information, see the WPF Add-in section of the UFT One Help Center.

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 Windows Presentation Foundation user interface objects.

For more information, see the WPF Add-in section of the UFT One Help Center.

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