SwfTable Object

Description

A grid control based on the .NET Windows Forms library.

IMPORTANT

  • Microsoft Data Grid
  • Infragistics UltraWinGrid
  • ComponentOne C1FlexGrid
  • ComponentOne C1TrueDBGrid
  • DevExpress XtraGrid

For a list of supported grid control versions, see the Unified Functional Testing Product Availability Matrix.

Operations

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

Note: You can also view a list and descriptions of the SwfTable 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 ActivateCell Double-clicks the specified cell in a grid.
Method ActivateColumn Double-clicks the specified column header in a grid.
Method ActivateRow Double-clicks the specified row header in a grid.
Method AddRow Adds a new row to the table band using the Add button for the corresponding band.
Method Back Navigates back to the parent table.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks an object.
Method CollapseRow Collapses the specified row.
Method DblClick Double-clicks an 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.
Method ExpandRow Expands the specified row.
Method FireEvent Simulates an event on a .NET object.
Method GetCellData Retrieves the contents of the specified cell in a grid.
Method GetCellProperty Returns the value of a grid cell property.
Method GetErrorProviderText Returns the tooltip text of the error icon associated with the object.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Method GetTextLocation Checks whether the specified text string is contained in the specified window area.
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 GroupBy Groups or ungroups table rows according to the specified column.
Method HideParentRow Hides the parent row, when the child grid is displayed.
Method MakeCellVisible Scrolls the specified cell into view if it is not visible in the grid.
Method MouseMove Moves the mouse pointer to the designated position over the object.
Method OpenCellElement Selects the specified cell and opens a cell's pop-up cell element.
Method OpenCellRelation Opens the child table referenced by the link in the specified cell.
Method OpenSummaryDlg Opens the summary dialog box for the specified column.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method SelectCell Selects (clicks) the specified cell in a grid.
Method SelectColumn Selects (clicks) the specified column header in a grid.
Method SelectRow Selects (clicks) the specified row header in a grid.
Method SetCellData Sets the contents of a cell with the specified string.
Method SetFilter Applies the specified filter string to the specified column.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method SetView Expands the parent rows of the specified view and makes it the current view.
Method ShowParentRow Displays the parent row, when the child grid is displayed.
Method Sort Sorts the table contents according to the specified column.
Common Method ToString Returns a string that represents the 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 ColumnCount Returns the number of columns in the grid.
Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.
Property RowCount Returns the number of rows in the grid.

Back to top

 

ActivateCell Method

Description

Double-clicks the specified cell in a grid.

Syntax

object.ActivateCell Row, Column

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress XtraGrid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

Return Type

None

Example

Back to top

 

ActivateColumn Method

Description

Double-clicks the specified column header in a grid.

Syntax

object.ActivateColumn Column

Arguments

Parameter Description
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the format:
       n;name
where n is the band level (0-based) and name is the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

Return Type

None

Example

Back to top

 

ActivateRow Method

Description

Double-clicks the specified row header in a grid.

Syntax

object.ActivateRow Row

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress XtraGrid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.

Return Type

None

Example

Back to top

 

AddRow Method

Description

Adds a new row to the table band using the Add button for the corresponding band.

Syntax

object.AddRow (AddButtonName, [Row])

Arguments

Parameter Description
AddButtonName Required. A Variant.
The name of the Add button corresponding to the band to which you want to add a row.
Row Optional. A Variant.
The band path that shows where the row is added. Separate band levels with semicolons(;). Row numbers in each band are 0-based.
For example: "4;0;2"

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid controls.

Example

Back to top

 

Back Method

Description

Navigates back to the parent table.

Syntax

object.Back

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls.

Example

Back to top

 

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

Back to top

 

CollapseRow Method

Description

Collapses the specified row.

Syntax

object.CollapseRow (Row)

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For other grids, specify a 0-based number.

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid, Infragistics UltraWinGrid, ComponentOne C1FlexGrid, and ComponentOne C1TrueDBGrid controls.

Example

Back to top

 

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

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

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

Back to top

 

ExpandRow Method

Description

Expands the specified row.

Syntax

object.ExpandRow (Row)

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For other grids, specify a 0-based number.

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid, Infragistics UltraWinGrid, ComponentOne C1FlexGrid, and ComponentOne C1TrueDBGrid controls.

Example

Back to top

 

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

Back to top

 

GetCellData Method

Description

Retrieves the contents of the specified cell in a grid.

Syntax

object.GetCellData (Row, Column)

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress XtraGrid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

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

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress XtraGrid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).
PropertyName Required. A String value.

The name of the property, specified as a string.
Possible values:  

Property Name
Description
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 name 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

 

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

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

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

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

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

Example

Back to top

 

GroupBy Method

Description

Groups or ungroups table rows according to the specified column.

Syntax

object.GroupBy (Column, Bool)

Arguments

Parameter Description
Column Required. A Variant.
The location of the column within the grid.
The value can be the column index (0-based number) or column caption (string).
Bool Required. A Variant.
Indicates whether to group the rows.
Possible Values:
     True: Groups the rows.
     False: Ungroups the rows.
Note: The boolean value can be represented by a constant ( True/False), a string ( "True"/"False") or a number ( 1/0).

Return Type

None.

IMPORTANT

This method is supported only for DevExpress XtraGrid controls.

Example

Back to top

 

HideParentRow Method

Description

Hides the parent row, when the child grid is displayed.

Syntax

object.HideParentRow

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls.

You can use the OpenCellRelation method to display the child table of a selected cell. You can use the ShowParentRow method to display a hidden parent row.

Example

Back to top

 

MakeCellVisible Method

Description

Scrolls the specified cell into view if it is not visible in the grid.

Syntax

object.MakeCellVisible Row, Column

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress XtraGrid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

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

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 Enabled", at: http://www.vmware.com/support/kb/enduser/std_alp.php.

Example

Back to top

 

OpenCellElement Method

Description

Selects the specified cell and opens a cell's pop-up cell element.

Syntax

object.OpenCellElement (Row, Column)

Arguments

Parameter Description
Row Required. A Variant.
The 0-based row number.
Column Required. A Variant.
The location of the column within the grid.
The value can be the column index (0 -based number) or column caption (string).

Return Type

None.

IMPORTANT

This method is supported only for ComponentOne C1FlexGrid and C1TrueDBGrid controls.

Example

Back to top

 

OpenCellRelation Method

Description

Opens the child table referenced by the link in the specified cell.

Syntax

object.OpenCellRelation (Row, Column)

Arguments

Parameter Description
Row Required. A Variant.
The 0-based row number.
Column Required. A Variant.
The 0-based column number.

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls.

Example

Back to top

 

OpenSummaryDlg Method

Description

Opens the summary dialog box for the specified column.

Syntax

object.OpenSummaryDlg (Level, Column)

Arguments

Parameter Description
Level Required. A Variant.
The band level for which you want to open the dialog box.
Column Required. A Variant.
The column header name or the column index (0-based).

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid controls.

Example

Back to top

 

SelectCell Method

Description

Selects (clicks) the specified cell in a grid.

Syntax

object.SelectCell Row, Column

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress XtraGrid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

Return Type

None

Example

Back to top

 

SelectColumn Method

Description

Selects (clicks) the specified column header in a grid.

Syntax

object.SelectColumn Column

Arguments

Parameter Description
Column Required. A Variant.
The location of the column within the grid.
For Microsoft DataGrid, specify the column by its 0-based column index.
For Infragistics UltraWinGrid, use the format:
       n;name
where n is the band level (0-based) and name is the column header name or the column index (0-based).
For other grids, the value can be the column index (number) or column caption (string).

Return Type

None

Example

Back to top

 

SelectRow Method

Description

Selects (clicks) the specified row header in a grid.

Syntax

object.SelectRow Row

Arguments

Parameter Description
Row Required. A Variant.
The location of the row within the grid.
For Infragistics UltraWinGrid, specify the 0-based row number for top level bands. For child bands, specify the row with a string in the format:
        "n1;n2;...nX"
where n is the row number in each band level.
For DevExpress XtraGrid, specify the 0-based row number of the row in the current view.
For other grids, specify a 0-based number.

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, [Type])

Arguments

Parameter Description
Row Required. A Variant.
For ComponentOne C1FlexGrid and C1TrueDBGrid controls:

The 0-based row number.

Column Required. A Variant.
For ComponentOne C1FlexGrid and C1TrueDBGrid controls:

The column index (number) or column caption (string).

Data Required. A String value.
For ComponentOne C1FlexGrid and C1TrueDBGrid controls:

The contents to be entered into the specified cell. For dimmed check boxes, specify the value: NULL (without quotes).

Type Optional. A Boolean value.
For ComponentOne C1FlexGrid and C1TrueDBGrid controls:

Indicates whether the data is entered into the cell by typing.

Possible values:
True: Types the data into the cell one character at a time.
False: (default) Enters the complete string into the cell.

Default value = False

Return Type

None.

IMPORTANT

This method is recorded only after you move the focus from the edited cell to another cell.

For grid controls other than ComponentOne C1FlexGrid and C1TrueDBGrid controls:

Example

Back to top

 

SetFilter Method

Description

Applies the specified filter string to the specified column.

Syntax

object.SetFilter (Level, Column, Value)

Arguments

Parameter Description
Level Required. A Variant.
For DevExpress XtraGrid controls:

The band level.

Column Required. A Variant.
For DevExpress XtraGrid controls:

The column index (number) or column caption (string).

Value Required. A Variant.
For DevExpress XtraGrid controls:

The filter name or a string defining the filter.

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid, DevExpress XtraGrid, ComponentOne C1FlexGrid, and ComponentOne C1TrueDBGrid controls.

For Infragistics UltraWinGrid and ComponentOne C1FlexGrid and C1TrueDBGrid controls: 

Example

Back to top

 

SetView Method

Description

Expands the parent rows of the specified view and makes it the current view.

Syntax

object.SetView (ViewPath)

Arguments

Parameter Description
ViewPath Required. A Variant.
The hierarchical path of the view you want to display in the format:
        "RowX RelationNameA; RowY RelationNameB;"
For example: "3 Orders; 3 OrderDetails"
Row numbers in each table are 0-based.
An empty string denotes the main (top-level) view.

Return Type

None.

IMPORTANT

A SetView "" statement (with an empty string argument) must be used before the first operation on an XtraGrid table.  When you record, this statement is added automatically for the first XtraGrid table in your test. If your test contains steps on more than one XtraGrid table, ensure that you add a SetView "" statement before the first step on each grid.

This method is supported only for DevExpress XtraGrid controls.

Example

Back to top

 

ShowParentRow Method

Description

Displays the parent row, when the child grid is displayed.

Syntax

object.ShowParentRow

Return Type

None.

IMPORTANT

This method is supported only for Microsoft Data Grid controls. You can use the SwfTable.OpenCellRelation method to display the child table of a selected cell. You can use the SwfTable.HideParentRow method to hide a displayed parent row.

Example

Back to top

 

Sort Method

Description

Sorts the table contents according to the specified column.

Syntax

object.Sort (Level, Column, Order)

Arguments

Parameter Description
Level Required. A Variant.
For Infragistics UltraWinGrid controls:

The band level for which you want to open the dialog box.
Column Required. A Variant.
For Infragistics UltraWinGrid controls:

The column header name or the column index (0-based).
Order Required. A Variant.
For Infragistics UltraWinGrid controls:

The sorting order.
Possible values:       
       "Ascending"
       "Descending" (default)
Note: The value may also be a numeric code representing special sort options.

 

Return Type

None.

IMPORTANT

This method is supported only for Infragistics UltraWinGrid, DevExpress XtraGrid, ComponentOne C1FlexGrid, and ComponentOne C1TrueDBGrid controls.

For DevExpress XtraGrid, or ComponentOne grid controls:

The BandLevel argument is not required.
The Column argument describes the location of the column within the grid.

For Microsoft DataGrid, specify the column by its 0-based column index.

For other grids, the value can be the column index (number) or column caption (string).

 

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.

Example

Back to top

 

ColumnCount Property

Description

Returns the number of columns in the grid.

Syntax

object.ColumnCount

Value Type

An integer value.

Property type

Read-only property

IMPORTANT

In UltraWinGrid controls, this property returns the number of columns in the current band.

In DevExpress XtraGrid controls, this property returns the number of columns in the current view.

Tip: You can set the view of an XtraGrid control using the SetView method.

Back to top

 

RowCount Property

Description

Returns the number of rows in the grid.

Syntax

object.RowCount

Value Type

A long integer value.

Property type

Read-only property

IMPORTANT

In UltraWinGrid controls, this property returns the number of rows in the current band.

In DevExpress XtraGrid controls, this property returns the number of rows in the current view.

Tip: You can set the view of an XtraGrid control using the SetView method.

Back to top

See also: