Property

Description

Operations

Return type

ColumnCount

Returns the number of column objects in a Data Grid.

Get

Integer

Cols

Returns the number of columns.

Get

Integer

Focused

Returns whether or not the cell is focused.

Get

Boolean

MultiSelect

Returns a value that indicates whether the user can select more than one cell, row, or column of a Data Grid at a time.

Get

Boolean

RowCount

Returns the number of row objects in a Data Grid.

Get

Integer

Rows

Returns the number of rows.

Get

Integer

SelectedCell

Returns the coordinates for the cell selected in a Data Grid.

Get

DataGridCell

SelectedCells

Returns the cell coordinates for the collection of cells selected by the user.

Get

DataTable

SelectedRow

Returns the row number for the Data Grid row selected by the user.

Get

Integer

SelectedRows

Returns the row numbers for the collection of Data Grid rows selected by the user.

Get

DataTable

Text

Contains the text of the selected cell.

Get

String

Event

Description

Arguments

CellClicked

Event occurs upon completion of a mouse-down+mouse-up action on a Data Grid cell that cannot be interrupted prior to the target application knowing of the event.

 Integer Row, Integer Column, String ColumnHeader, String CellText;

CellClicking

Event occurs upon completion of a mouse-down+mouse-up action on a Data Grid cell that can be interrupted and logic injected prior to the target application knowing of the event.

String ColumnHeader, String CellText;

 Integer Row, Integer Column;

CellDoubleClicked

Event occurs upon completion of the second of two rapid mouse-down+mouse-up actions on a Data Grid cell location that cannot be interrupted prior to the target application knowing of the event.

Integer Row, Integer Column, String ColumnHeader, String CellText;

CellDoubleClicking

Event occurs upon completion of the second of two rapid mouse-down+mouse-up actions on a Data Grid cell location that can be interrupted and logic injected prior to the target application knowing of the event.

String ColumnHeader, String CellText;

Integer Row, Integer Column;

CellRightClicked

Event occurs upon completion of a right-mouse button down+up action on a Data Grid cell location that cannot be interrupted prior to the target application knowing of the event.

Integer Row, Integer Column, String ColumnHeader, String CellText;

CellRightClicking

Event occurs upon completion of a right-mouse button down+up action on a Data Grid cell location that can be interrupted and logic injected prior to the target application knowing of the event.

String ColumnHeader, String CellText;

Integer Row, Integer Column;

CellRightDoubleClicked

Event occurs upon completion of the second of two rapid right-mouse button down+up actions on a Data Grid cell location that cannot be interrupted prior to the target application knowing of the event.

Integer Row, Integer Column, String ColumnHeader, String CellText;

CellRightDoubleClicking

Event occurs upon completion of two rapid right-mouse button down+up actions on a Data Grid cell location that can be interrupted and logic injected prior to the target application knowing of the event.

String ColumnHeader, String CellText;

Integer Row, Integer Column;

SelectionChanged

Event occurs when the current Data Grid selection changes.

None

Method

Description

Parameter

Return Type

ClickCell

Simulates a mouse-down+mouse-up action on a Data Grid cell location identified by parameters such as row and column number, and selects the entire cell.

Integer Row, Integer Column;

Integer Row, String ColumnName;

Void

ClickCellByText

Simulates a mouse-down+mouse-up action on a Data Grid cell location identified by String parameters, and selects the entire cell.

String ColumnName, String SearchValue;

Void

ClickRow

Simulates a mouse-down+mouse-up action and, selects an entire row in a Data Grid.

Integer Row;

Void

DoubleClickCell

Simulates two rapid mouse-down+mouse-up actions on a Data Grid cell location, and selects the entire cell.

Integer Row, Integer Column;

Integer Row, String ColumnName;

Void

DoubleClickCellByText

Simulates two rapid mouse-down+mouse-up actions on a Data Grid cell location identified by String parameters, and selects the entire cell.

String ColumnName, String SearchValue;

Void

DoubleClickRow

Simulates two rapid mouse-down+mouse-up actions, and selects an entire row in a Data Grid.

Integer Row;

Void

GetBackCellColor

Returns the background color of a cell. The default is zero (0) or default. It only returns a non-zero value if the color has been specifically changed for that cell.

Integer Row, Integer Column, Integer Color

Void

GetCellText

Returns the text inside of a cell.

Integer Row, Integer Column, String Value;

Void

GetCellValue

Returns the contents of a specified cell in a Data Grid.

Integer Row, Integer Column;

Integer Row, String ColumnName;

String

PerformClick

Simulates a click of the mouse to the selected cell.

Void

Void

PerformClickCell

Simulates a click of the mouse to a specified cell.

Integer Row, Integer Column

Void

PerformDoubleClick

Simulates a double click of the mouse on whatever cell is selected.

Void

Void

PerformDoubleClickCell

Simulates a double click of the mouse to a specified cell.

Integer Row, Integer Column

Void

RightClickCell

Simulates a right-mouse button down+up action on a Data Grid cell location, and selects the entire cell.

Integer Row, Integer Column;

Integer Row, String ColumnName;

Void

RightClickCellByText

Simulates a right-mouse button down+up action on a Data Grid cell location identified by String parameters, and selects the entire cell.

String ColumnName, String SearchValue;

Void

RightClickRow

Simulates a right-mouse button down+up action, and selects an entire row in a Data Grid.

Integer Row;

Void

RightDoubleClickCell

Simulates two rapid right-mouse button down+up actions on a Data Grid cell location, and selects the entire cell.

Integer Row, Integer Column;

Integer Row, String ColumnName;

Void

RightDoubleClickCellByText

Simulates two rapid right-mouse button down+up actions on a Data Grid cell location identified by String parameters, and selects the entire cell.

String ColumnName, String SearchValue;

Void

RightDoubleClickRow

Simulates two rapid right-mouse button down+up actions, and selects an entire row in a Data Grid.

Integer Row;

Void

SetCellValue

Populates a specified cell in a Data Grid with a string value.

Integer Row, Integer Column, String Value;

Integer Row, String ColumnName, String Value;

Void

SelectCell

Selects a cell in a data grid.

Integer Row, Integer Column;

Integer Row, String ColumnName;

DataGridCell Cell;

Void

SelectCells

Selects one or more cells in a data grid.

DataTable Cells;

Void

SelectRow

Selects a row in a data grid.

Integer Row;

Void

SelectRowByText

Selects a row in a data grid identified by String parameters.

String ColumnName, String SearchValue;

Void

SelectRows

Selects one or more rows in a data grid.

String of comma-delimited Rows;

Void