XtraGrid

WinForms. XtraGrid

XtraGrid

Constructor

new XtraGrid()

A DevExpress XtraGrid object.

Methods

activateCell(row, columnHeader) → {Promise.<void>}

Double-clicks the specified cell in this grid.
Parameters:
NameTypeDescription
rownumber0-based row number.
columnHeaderstringThe column caption.
Returns:
a promise that is fulfilled when the activateCell operation ends.
Type
Promise.<void>

activateColumn(columnOrColumnHeader) → {Promise.<void>}

Double-clicks the specified column header in this grid.
Parameters:
NameTypeDescription
columnOrColumnHeaderstringThe 0-based column number or column caption.
Returns:
a promise that is fulfilled when the activateColumn operation ends.
Type
Promise.<void>

columnCount() → {Promise.<number>}

Get the number of columns
Returns:
a promise that is fulfilled with the number of columns
Type
Promise.<number>

getCell(row, columnOrColumnHeader) → {WinForms.TableCell}

Returns the specified cell.
Parameters:
NameTypeDescription
rownumber0-based row number.
columnOrColumnHeaderstring | number0-based column index or column caption.
Returns:
the TableCell.
Type
WinForms.TableCell

groupRows(columnOrColumnHeader) → {Promise.<void>}

Groups table rows according to the specified column.
Parameters:
NameTypeDescription
columnOrColumnHeaderstring | numberThe 0-based column index or column caption.
Returns:
a promise that is fulfilled when the groupRows operation ends.
Type
Promise.<void>

makeCellVisible(row, columnHeader) → {Promise.<void>}

Scrolls the specified cell into view.
Parameters:
NameTypeDescription
rownumberThe 0-based row number.
columnHeaderstringThe column caption.
Returns:
a promise that is fulfilled when the makeCellVisible operation ends.
Type
Promise.<void>

rowCount() → {Promise.<number>}

Get the number of rows
Returns:
a promise that is fulfilled with the number of rows
Type
Promise.<number>

selectCell(row, columnHeader) → {Promise.<void>}

Selects the specified cell in this grid.
Parameters:
NameTypeDescription
rownumber0-based row number.
columnHeaderstringThe column caption.
Returns:
a promise that is fulfilled when the selectCell operation ends.
Type
Promise.<void>

selectColumn(columnOrColumnHeader) → {Promise.<void>}

Selects column by column index or column caption.
Parameters:
NameTypeDescription
columnOrColumnHeaderstringThe 0-based column index or column caption.
Returns:
a promise that is fulfilled when the selectColumn operation ends.
Type
Promise.<void>

setFilter(columnOrColumnHeader, filter) → {Promise.<void>}

Applies the specified filter string to the specified column.
Parameters:
NameTypeDescription
columnOrColumnHeaderstring | numberThe 0-based column index or column caption.
filterstringA value in the column to be used as the filter
Returns:
a promise that is fulfilled when the setFilter operation ends.
Type
Promise.<void>

setView(viewPath[opt]) → {Promise.<void>}

Expands the parent rows of the specified view and makes it the current view.
Parameters:
NameTypeAttributesDescription
viewPathArray.<number, string>

optional

repeatable

The hierarchical path of the view to display, expressed using Tuples in the format: [0-based row number, relation name].

If called without parameters the main (top-level) view is used.

Example: gridcontrol1.customGrid().xtraGrid().setView([0, "CustOrders"], [3, "OrderDetails"]);

Returns:
a promise that is fulfilled when the setView operation ends.
Type
Promise.<void>

sort(columnOrColumnHeader) → {Promise.<void>}

Sorts this table by the specified column (ascending).
Parameters:
NameTypeDescription
columnOrColumnHeaderstring | numberThe 0-based column index or column caption.
Returns:
a promise that is fulfilled when the sort operation ends.
Type
Promise.<void>

sortDescending(columnOrColumnHeader) → {Promise.<void>}

Sorts this table by the specified column (descending).
Parameters:
NameTypeDescription
columnOrColumnHeaderstring | numberThe 0-based column index or column caption.
Returns:
a promise that is fulfilled when the sort operation ends.
Type
Promise.<void>

tableTestObject() → {WinForms.Table}

Returns the Table test object this custom grid was accessed from.
Returns:
the tableTestObject.
Type
WinForms.Table

ungroupRows(columnOrColumnHeader) → {Promise.<void>}

Ungroups table rows according to the specified column.
Parameters:
NameTypeDescription
columnOrColumnHeaderstring | number0-based column index or column caption.
Returns:
a promise that is fulfilled when the ungroupRows operation ends.
Type
Promise.<void>