Search
Grid Members
Constructors Properties Methods Events
 


Represents a grid view control.

The following tables list the members exposed by the Grid type.

 Public Constructors

  Name Description

Grid

Initializes a new instance of the Grid class.

 Public Properties

  Name Description

activeEditor

Gets the active grid cell editor.

allowAppend

Gets or sets a value, indicating whether to show a new empty row at the bottom of the grid and a 'New row' option in the row context menu.

allowCellSelect

Gets or sets a value, indicating whether single cell selection is enabled.

allowDelete

Gets or sets a value, indicating whether to show a 'Delete row' option in the row context menu.

allowEdit

Gets or sets a value, indicating whether inplace editing is enabled.

dataTable

Gets a reference to the grid data table DOM element.

focusedCell

Gets the active grid cell.

header

Gets a reference to the grid header DOM element.

model

Gets or sets the data model of this Grid.

scrollRow

Gets or sets the index of the first visible row.

selectedCells

Gets the selected cells.

selectedRowIndices

Gets the indices of selected rows.

sortAscending

Gets a value, indicating whether the sorting is in Ascending order.

sortedColumn

Gets the index of the column, by which the data is sorted.

 Public Methods

  Name Description

addRow

Adds a row.

adjust

Recalculates grid's dimensions.

attach

Control.attach override.

bringIntoView

Ensures that the specified row is visible.

detach

Control.detach override.

disposeActiveEditor

Disposes the active grid cell editor.

disposeContextMenu

Disposes the current context menu.

draw

Control.draw override.

focusCell

Sets the focus to the cell at the specified position.

getCellElement

Gets the DOM element of the cell in the specified coordinates.

getColumnWidth

Gets the width of the specified grid column.

getKeyRow

Gets the row with the specified key.

getRowElement

Gets the DOM element of the specified row.

getRowKey

Gets the key of the row at the specified index.

isRowVisible

Checks if the row at the specified index is currently visible.

rebind

Refreshes the Grid after external modifications to the grid model.

refresh

Repaints the grid contents.

refreshRows

Repaints a range of rows.

removeRows

Removes a range of rows.

selectCell

Selects the cell at the specified position.

selectRows

Selects the rows in the specified range.

setColumnWidth

Sets the width of the specified grid column.

sortByColumn

Sorts by the specified column and sort direction.

 Public Events

  Name Description

cellFocused

Raised when a cell is focused.

cellFocusing

Raised before a cell is focused.

cellSelected

Raised when a cell is selected.

cellSelecting

Raised before a cell is selected.

customDrawCell

Raised when a cell's contents are about to be rendered, to allow custom drawing.

customDrawHeader

Raised when a header cell's contents are about to be rendered, to allow custom drawing.

rowCommand

Raised when a command is executed on a row.

rowCreated

Raised when a new row is created.

rowCreating

Raised before a new row is created.

rowDeleted

Raised when a row is deleted.

rowDeleting

Raised before a row is deleted.

rowRendered

Raised when a row is rendered.

rowSelected

Raised when a row is selected.

rowSelecting

Raised before a row is selected.

rowUpdated

Raised when a row is updated.

rowUpdating

Raised before a row is updated.

 See Also