Grid Properties
Name | Type | Default | Description |
---|---|---|---|
Appearance | GridAppearance | N/A | An object containing settings related to the grid's appearance. |
Behavior | GridBehavior | N/A | An object containing settings related to the grid's behavior. |
Layout | GridLayout | N/A | An object containing settings related to the grid's layout. |
Locale | string | "en" | Sets or gets the language. Used in conjunction with the property messages. |
Clipboard | GridClipboard | N/A | The clipboard property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations.. |
Columns | IEnumerable<IGridColumn> | [] | The columns property is used to describe all columns displayed in the grid. |
ColumnMenu | GridColumnMenu | N/A | Column Menu is the drop-down menu displayed after clicking the column header's drop-down button, which is displayed when you hover the column header. It allows you to customize column settings. For example: Sort, Filter or Group the Grid by the current column. |
ColumnGroups | IEnumerable<IGridColumnGroup> | N/A | Describes the settings of the column groups. |
ConditionalFormatting | IEnumerable<IGridConditionalFormatting> | N/A | Sets or gets details about conditional formatting to be applied to the Grid's cells. |
Charting | GridCharting | N/A | Sets the Grid Charting Data Visualization. |
CheckBoxes | GridCheckBoxes | N/A | Sets the TreeGrid checkboxes. |
DataExport | GridDataExport | N/A | Sets the Grid Data Export options. |
DataSource | object | N/A | Sets the grid's data source. The value of dataSource can be an instance of IEnumerable<object> or an Array. |
DataSourceSettings | GridDataSourceSettings | N/A | Sets the grid's data source settings when the dataSource property is set to an Array or URL. |
Editing | GridEditing | N/A | Describes the grid's editing settings. |
Filtering | GridFiltering | N/A | Describes the grid's filtering settings. |
Grouping | GridGrouping | N/A | Describes the grid's grouping settings. |
Messages | object | N/A | Sets the messages values. |
OnCellValue | Action<object> | N/A | Callback function, which is called when the Grid needs a cell value to render it. When you implement this function, you can override the default cell value rendering. |
OnCellUpdate | Action<object> | N/A | Callback function, which is called when a cell value will be updated. This function is useful if you want to make Ajax call to a server to validate the cell changes. If the changes are validated, invoke the confirm function. |
OnCellRender | Action<object> | N/A | Callback function, which is called when a cell is rendered. This function is useful if you want to customize GridCell properties, before the cell is rendered. |
OnBeforeInit | Action<object> | N/A | Callback function() called before the grid has been initialized and the Grid's Virtual DOM is not created. |
OnInit | Action<object> | N/A | Callback function() called when the grid is initializing and the Grid's Virtual DOM is created. |
OnAfterInit | Action<object> | N/A | Callback function() called after the grid has been initialized and the Grid's Virtual DOM is created. |
OnChartInit | object | N/A | Callback function(chart: Smart.Chart) called when the chart has been initialized. You can use this function to customize the Chart element settings. |
OnRender | object | N/A | Callback function() called when the grid has been rendered. |
OnKey | Action<object> | N/A | Callback function(event: KeyboardEvent) called when the grid is on focus and a keyboard key is pressed. |
OnRowInit | Action<object> | N/A | Callback function, which is called when a row is initializing. This function can be used to customize the row settings. |
OnRowDetailInit | Action<object> | N/A | Callback function, which is called when a row detail is initializing. Row details are displayed below the row's data or in a separate dialog. |
OnRowDetailUpdated | Action<object> | N/A | Callback function, which is called when a row detail is udpating. |
OnRowInserted | Action<object> | N/A | Callback function which is called when a row has been inserted. |
OnRowRemoved | Action<object> | N/A | Callback function, which is called when a row has been removed. |
OnRowUpdate | Action<object> | N/A | Callback function, which is called when row's cell values will be updated. This function is useful if you want to make Ajax call to a server to validate the edit changes. If the changes are validated, invoke the confirm function. |
OnRowUpdated | Action<object> | N/A | Callback function, called when a row has been updated. |
OnColumnInit | Action<object> | N/A | Callback function, which is called when a column has been initialized. This function can be used to customize the column settings. |
OnColumnInserted | Action<object> | N/A | Callback function, which called when a column has been inserted. |
OnColumnRemoved | Action<object> | N/A | Callback function, which is called when a column has been removed. |
OnColumnUpdated | Action<object> | N/A | Callback function, which is called when a column has been updated. |
OnCommand | Action<object> | N/A | Callback function, which is called when a command is executed. The name argument is the command's name. The command argument is the command's function. details are built in command arguments passed by the Grid. The handled parameter allows you to cancel built-in command, because when you set it to true the Grid will not execute the default command's behavior. |
CurrentUser | object | Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties. | |
Users | IEnumerable<object> | [] | Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties. |
Paging | GridPaging | N/A | Describes the paging settings. |
Pager | GridPager | N/A | Describes the pager settings. |
RowDetail | GridRowDetail | N/A | Sets the row details. |
Scrolling | Scrolling | Scrolling.Physical | Sets the scroll mode settings. |
ColumnHeader | GridColumnHeader | N/A | Describes the column header settings. |
SummaryRow | GridSummaryRow | N/A | Describes the summary row settings. |
GroupHeader | GridGroupHeader | N/A | Describes the settings for the group header. |
Header | GridHeader | N/A | Describes the header settings of the grid. |
Footer | GridFooter | N/A | Describes the footer settings of the grid. |
RightToLeft | bool | false | Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. |
Rows | IEnumerable<IGridRow> | N/A | The rows property is used to describe all rows displayed in the grid. |
Selection | GridSelection | N/A | Describes the selection settings. |
Sorting | GridSorting | N/A | Describes sorting settings. |
Grid Methods
Name | Type | Arguments | Description |
---|---|---|---|
AddFilter | void | string dataField, string filter, bool refreshFilters | Adds a filter to a column. This method will apply a filter to the Grid data.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string filter - Filter expression like: 'startsWith B'. Example 2: ['contains Andrew or contains Nancy'], Example 3: ['quantity', '<= 3 and >= 8']. Filter conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL',bool refreshFilters - Set this to false, if you will use multiple 'addFilter' calls. By doing this, you will avoid unnecessary renders. |
AddFilter | void | string dataField, string filter | Adds a filter to a column. This method will apply a filter to the Grid data. |
AddGroup | void | string dataField | Groups the Grid by a data field. This method will add a group to the Grid when grouping is enabled.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
AddNewColumn | none | IEnumerable<object> column | Adds a new column.Args: dynamic column - A Grid column object. See 'columns' property. |
AddNewRow | bool | string position | Adds a new row and puts it into edit mode. When batch editing is enabled, the row is not saved until the batch edit is saved.Args: string position - 'near' or 'far' |
AddNewRow | bool | N/A | Adds a new row and puts it into edit mode. When batch editing is enabled, the row is not saved until the batch edit is saved. |
AddRow | void | object data, bool insertAtBottom, object callback | Adds a row. When batch editing is enabled, the row is not saved until the batch edit is saved.Args: object data - row data matching the data source,bool insertAtBottom - Determines whether to add the new row to the bottom or top of the collection. The default value is 'true',object callback - Sets a callback function, which is called after the new row is added. The callback's argument is the new row. |
AddRow | void | object data | Adds a row. When batch editing is enabled, the row is not saved until the batch edit is saved. |
AddSort | void | string dataField, string sortOrder | Sorts the Grid by a data field. This method will add a sorting to the Grid when sorting is enabled.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string sortOrder - column's sort order. Use 'asc' or 'desc'. |
AddUnboundRow | bool | int count, string position | Adds a new unbound row to the top or bottom. Unbound rows are not part of the Grid's dataSource. They become part of the dataSource, after an unbound row is edited.Args: int count - The count of unbound rows.,string position - 'near' or 'far' |
AddUnboundRow | bool | int count | Adds a new unbound row to the top or bottom. Unbound rows are not part of the Grid's dataSource. They become part of the dataSource, after an unbound row is edited. |
AreAllRowsSelected | bool | N/A | This method returns true, if all rows in the Grid are selected. |
AutoSizeColumns | void | N/A | Auto-sizes grid columns. This method will update the "width" of all Grid columns. |
AutoSizeRows | void | N/A | Auto-sizes grid rows. This method will update the "height" of all Grid rows. |
BeginEdit | void | object rowId, string dataField | Begins row, cell or column. This method allows you to programmatically start a cell, row or column editing. After calling it, an editor HTMLElement will be created and displayed in the Grid.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
BeginEdit | void | object rowId | Begins row, cell or column. This method allows you to programmatically start a cell, row or column editing. After calling it, an editor HTMLElement will be created and displayed in the Grid. |
BeginEdit | void | string rowId, string dataField | Begins row, cell or column. This method allows you to programmatically start a cell, row or column editing. After calling it, an editor HTMLElement will be created and displayed in the Grid.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
BeginEdit | void | string rowId | Begins row, cell or column. This method allows you to programmatically start a cell, row or column editing. After calling it, an editor HTMLElement will be created and displayed in the Grid. |
BeginEdit | void | int rowId, string dataField | Begins row, cell or column. This method allows you to programmatically start a cell, row or column editing. After calling it, an editor HTMLElement will be created and displayed in the Grid.Args: int rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
BeginEdit | void | int rowId | Begins row, cell or column. This method allows you to programmatically start a cell, row or column editing. After calling it, an editor HTMLElement will be created and displayed in the Grid. |
BeginUpdate | void | N/A | Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once. |
CancelEdit | void | N/A | Cancels the editing. This method closes the cell editor and cancels the changes. |
CheckAllRows | void | N/A | Checks all TreeGrid or Grouping rows. This method updates all check-boxes in the TreeGrid or Grouping rows. |
CheckRow | void | object rowId | Checks a TreeGrid row. This method updates the row's check-box.Args: string rowId - row bound id |
CheckRow | void | string rowId | Checks a TreeGrid row. This method updates the row's check-box.Args: string rowId - row bound id |
CheckRow | void | int rowId | Checks a TreeGrid row. This method updates the row's check-box.Args: int rowId - row bound id |
ClearFilter | void | N/A | Clears all filters. Refreshes the view and updates all filter input components. |
ClearGroups | void | N/A | Clears all data groups. Refreshes the view and updates the DataGrid component. |
ClearRows | void | N/A | Clears the user selection and empties the data source. The Grid will display 'No Rows' in the view. |
ClearSelection | void | N/A | Clears the selection that user have made. All row, cell and column selection highlights will be removed. |
ClearSort | void | N/A | Clears all sorting. Refreshes the view and updates the DataGrid component. |
CloseMenu | void | N/A | Closes the column drop-down menu. |
CollapseAllRows | void | N/A | Collapses all TreeGrid or Grouping rows. |
CollapseRow | void | object rowId | Collapses a TreeGrid or Grouping row.Args: string rowId - row bound id |
CollapseRow | void | string rowId | Collapses a TreeGrid or Grouping row.Args: string rowId - row bound id |
CollapseRow | void | int rowId | Collapses a TreeGrid or Grouping row.Args: int rowId - row bound id |
CreateChart | void | string type, object dataSource | Creates a Chart, when charting is enabled.Args: string type - Chart's type,object dataSource - Chart's data source |
CreateChart | void | string type | Creates a Chart, when charting is enabled. |
DeleteRow | void | object rowId, object callback | Delete a row. When batch editing is enabled, the row is not saved until the batch edit is saved.Args: string rowId - row bound id,object callback - Sets a callback function, which is called after the row is deleted. The callback's argument is the deleted row. |
DeleteRow | void | object rowId | Delete a row. When batch editing is enabled, the row is not saved until the batch edit is saved. |
EndEdit | void | N/A | Ends the editing. This method confirms all changes and closes the opened cell editor(s). |
EndUpdate | void | bool refresh | Ends the update operation. This method will resume the rendering and will refresh the Grid.Args: bool refresh - The flag that control the calls of the refresh method. |
EndUpdate | void | N/A | Ends the update operation. This method will resume the rendering and will refresh the Grid. |
EnsureVisible | bool | object rowId, string dataField | Scrolls to a row or cell. This method scrolls to a row or cell, when scrolling is necessary. If pagination is enabled, it will automatically change the page.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
EnsureVisible | bool | object rowId | Scrolls to a row or cell. This method scrolls to a row or cell, when scrolling is necessary. If pagination is enabled, it will automatically change the page. |
EnsureVisible | bool | string rowId, string dataField | Scrolls to a row or cell. This method scrolls to a row or cell, when scrolling is necessary. If pagination is enabled, it will automatically change the page.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
EnsureVisible | bool | string rowId | Scrolls to a row or cell. This method scrolls to a row or cell, when scrolling is necessary. If pagination is enabled, it will automatically change the page. |
EnsureVisible | bool | int rowId, string dataField | Scrolls to a row or cell. This method scrolls to a row or cell, when scrolling is necessary. If pagination is enabled, it will automatically change the page.Args: int rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
EnsureVisible | bool | int rowId | Scrolls to a row or cell. This method scrolls to a row or cell, when scrolling is necessary. If pagination is enabled, it will automatically change the page. |
ExpandAllRows | void | N/A | Expands all TreeGrid or Grouping rows. |
ExpandRow | void | object rowId | Expands a TreeGrid or Grouping row.Args: string rowId - row bound id |
ExpandRow | void | string rowId | Expands a TreeGrid or Grouping row.Args: string rowId - row bound id |
ExpandRow | void | int rowId | Expands a TreeGrid or Grouping row.Args: int rowId - row bound id |
ExportData | void | string Dataformat | Exports the Grid data to .XLSX, .PDF, .JSON, .XML, .CSV, .TSV, .HTML, .JPEG or .PNG. The method uses the options of the "dataExport" property.Args: string Data format - 'xlsx', 'pdf', 'json', 'xml', 'csv', 'tsv', 'html', 'png', 'jpeg'. |
FirstPage | void | N/A | Navigates to the first page, when grid paging is enabled. |
GetBatchEditChanges | object | N/A | Gets the changes from the batch edit. |
GetCellValue | object | object rowId, string dataField | Gets a value of a cell.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
GetCellValue | object | string rowId, string dataField | Gets a value of a cell.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
GetCellValue | object | int rowId, string dataField | Gets a value of a cell.Args: int rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
GetCheckedAsync() | Task<bool> | 'N/A' | Gets the "Checked" property as Task<bool>. |
GetColumnProperty | object | string dataField, string propertyName | Gets a value of a column.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string propertyName - The property name. |
GetColumns | IEnumerable<object> | N/A | Gets the columns array. Each item in the array contains the column properties which are dynamically set by the user interaction and the columns initialization data properties such as: 'label', 'dataField', 'dataType', 'visible'. |
GetDataSourceAsync() | Task<IEnumerable<object>> | 'N/A' | Gets the "DataSource" property as Task<IEnumerable<object>>. |
GetFilteredColumns | IEnumerable<object> | N/A | Gets an array of columns with applied filters. |
GetGroups | IEnumerable<object> | N/A | Gets the groups array. |
GetHorizontalScrollMax | int | N/A | Gets the maximum position of the horizontal scrollbar. You can use this method in combination with the setHorizontalScrollValue to apply a new scroll position. |
GetHorizontalScrollValue | int | N/A | Gets the position of the horizontal scrollbar. |
GetIsExpandedAsync() | Task<bool> | 'N/A' | Gets the "IsExpanded" property as Task<bool>. |
GetPageIndexAsync() | Task<int> | 'N/A' | Gets the "PageIndex" property as Task<int>. |
GetRowData | object | object rowId | Gets the Data source data associated to the row.Args: string rowId - row bound id |
GetRowData | object | string rowId | Gets the Data source data associated to the row.Args: string rowId - row bound id |
GetRowData | object | int rowId | Gets the Data source data associated to the row.Args: int rowId - row bound id |
GetRowId | object | int rowIndex | Gets the Row's id.Args: int rowIndex - row index |
GetRowProperty | object | object rowId, string propertyName | Gets a value of a row.Args: string rowId - row bound id,string propertyName - The property name. |
GetRowProperty | object | string rowId, string propertyName | Gets a value of a row.Args: string rowId - row bound id,string propertyName - The property name. |
GetRowProperty | object | int rowId, string propertyName | Gets a value of a row.Args: int rowId - row bound id,string propertyName - The property name. |
GetSelectedAsync() | Task<string> | 'N/A' | Gets the "Selected" property as Task<string>. |
GetSelectedCells | IEnumerable<object> | N/A | Gets the selected cells. The method returns an array of cell. Each cell is an array with row id, column data field and cell value. |
GetSelectedRows | IEnumerable<object> | N/A | Gets the selected row ids. |
GetSelection | IEnumerable<object> | N/A | Gets the selection. |
GetSortedColumns | object | N/A | Gets an array of columns with applied sorting. Each member in the array is with column's data field used as a key and 'sortOrder' and 'sortIndex' as a value. |
GetState | object | N/A | Gets a JSON object with the following fields: 'sort', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. |
GetValueAsync() | Task<object> | 'N/A' | Gets the "Value" property as Task<object>. |
GetVerticalScrollMax | int | N/A | Gets the maximum position of the vertical scrollbar. You can use this method in combination with the setVerticalScrollValue to apply a new scroll position. |
GetVerticalScrollValue | int | N/A | Gets the position of the vertical scrollbar. |
GetViewRows | IEnumerable<object> | N/A | Gets the result of the getVisibleRows or the rows hierarchy, when the Grid is in TreeGrid/Grouping mode. |
GetVisibleRows | IEnumerable<object> | N/A | Gets an array of rows, which are visible and match the applied filter. |
GoToPage | void | int index | Navigates to a page, when paging is enabled.Args: int index - page index |
HasMenu | bool | N/A | Gets whether a column's drop-down menu is opened. |
HasSelectedRows | bool | N/A | This method returns true, if any rows in the Grid are selected. |
HideDetail | void | object rowId | Hides the Details of a Row, when row details are enabled.Args: string rowId - row bound id |
HideDetail | void | string rowId | Hides the Details of a Row, when row details are enabled.Args: string rowId - row bound id |
HideDetail | void | int rowId | Hides the Details of a Row, when row details are enabled.Args: int rowId - row bound id |
HighlightCell | void | object rowId, string dataField, string className | Highlights a cell. Calling the method a second time toggle the highlight state.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string className - CSS Class Name |
HighlightCell | void | object rowId, string dataField | Highlights a cell. Calling the method a second time toggle the highlight state. |
HighlightCell | void | string rowId, string dataField, string className | Highlights a cell. Calling the method a second time toggle the highlight state.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string className - CSS Class Name |
HighlightCell | void | string rowId, string dataField | Highlights a cell. Calling the method a second time toggle the highlight state. |
HighlightCell | void | int rowId, string dataField, string className | Highlights a cell. Calling the method a second time toggle the highlight state.Args: int rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string className - CSS Class Name |
HighlightCell | void | int rowId, string dataField | Highlights a cell. Calling the method a second time toggle the highlight state. |
HighlightColumn | void | string dataField | Highlights a column. Highlights a Grid column.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
HighlightRow | void | object rowId, string className | Highlights a row. Calling the method a second time toggle the highlight state.Args: string rowId - row bound id,string className - CSS Class Name |
HighlightRow | void | object rowId | Highlights a row. Calling the method a second time toggle the highlight state. |
HighlightRow | void | string rowId, string className | Highlights a row. Calling the method a second time toggle the highlight state.Args: string rowId - row bound id,string className - CSS Class Name |
HighlightRow | void | string rowId | Highlights a row. Calling the method a second time toggle the highlight state. |
HighlightRow | void | int rowId, string className | Highlights a row. Calling the method a second time toggle the highlight state.Args: int rowId - row bound id,string className - CSS Class Name |
HighlightRow | void | int rowId | Highlights a row. Calling the method a second time toggle the highlight state. |
LastPage | void | N/A | Navigates to the last page, when grid paging is enabled. |
NextPage | void | N/A | Navigates to the next page, when grid paging is enabled. |
OpenMenu | void | string dataField | Opens a column drop-down menu.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
PrevPage | void | N/A | Navigates to the prev page, when grid paging is enabled. |
void | N/A | Prints the Grid data. The method uses the options of the "dataExport" property. When printed, the Grid will not display any scrollbars so all rows and columns will be displayed. The grid will auto resize width and height to fit all contents. To customize the printing options, you can use the "dataExport" property. | |
Refresh | void | 'N/A' | Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements. |
Refresh | void | N/A | Refreshes the grid with the current property values. This method will refresh the Grid layout. |
RefreshSort | void | N/A | Re-sorts the Grid by using the already applied column sortings and re-renders the Grid. |
RefreshView | void | N/A | Refreshes the grid cells in view. The method is useful for live-updates of cell values. |
RemoveFilter | void | string dataField, bool refreshFilters | Removes a column filter. Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,bool refreshFilters - Set this to false, if you need to make multiple removeFilter calls. |
RemoveFilter | void | string dataField | Removes a column filter. |
RemoveGroup | void | string dataField | Removes a group by data field. This method will remove a group to the Grid when grouping is enabled.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
RemoveSort | void | string dataField | Removes a sorting by data field. This method will remove a sorting from a Grid column.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
Render | void | 'N/A' | Re-renders the Blazor Component. This method will make a full re-render. |
Render | void | N/A | Renders the grid. This method will make a full-refresh like in the initial Grid creation. It will create Rows, Columns and Cells HTML Elements and then refresh the Grid layout. |
ReorderColumns | void | object dataField, object referenceDataField, bool insertAfter | Reorders two DataGrid columns.Args: string dataField - The data field or column index of the first grid column.,string referenceDataField - The data field or column index of the second grid column.,bool insertAfter - Determines whether to insert the first column after the reference column. |
ReorderColumns | void | object dataField, object referenceDataField | Reorders two DataGrid columns. |
ReorderColumns | void | string dataField, string referenceDataField, bool insertAfter | Reorders two DataGrid columns.Args: string dataField - The data field or column index of the first grid column.,string referenceDataField - The data field or column index of the second grid column.,bool insertAfter - Determines whether to insert the first column after the reference column. |
ReorderColumns | void | string dataField, string referenceDataField | Reorders two DataGrid columns. |
ReorderColumns | void | int dataField, int referenceDataField, bool insertAfter | Reorders two DataGrid columns.Args: string dataField - The data field or column index of the first grid column.,int referenceDataField - The data field or column index of the second grid column.,bool insertAfter - Determines whether to insert the first column after the reference column. |
ReorderColumns | void | int dataField, int referenceDataField | Reorders two DataGrid columns. |
RevertBatchEdit | void | N/A | Reverts the batch edit changes. This method cancels all changes made by the end-user. |
SaveBatchEdit | void | N/A | Saves the batch edit changes. This method confirms the editing changes made by the end-user. |
Select | void | object rowId, string dataField | Selects a row, cell or column.Args: string rowId - row bound id,string dataField - column bound data field |
Select | void | object rowId | Selects a row, cell or column. |
Select | void | string rowId, string dataField | Selects a row, cell or column.Args: string rowId - row bound id,string dataField - column bound data field |
Select | void | string rowId | Selects a row, cell or column. |
Select | void | int rowId, string dataField | Selects a row, cell or column.Args: int rowId - row bound id,string dataField - column bound data field |
Select | void | int rowId | Selects a row, cell or column. |
SelectAllRows | void | N/A | Selects all rows. |
SelectRange | void | object rowId, string dataField, object endRowId, string endDataField | Selects a range of rows, cells or columns. The result of the method depends on the "selection" configuration of the Grid.Args: string rowId - row bound id,string dataField - column bound data field,string endRowId - row bound id,string endDataField - column bound data field |
SelectRange | void | string rowId, string dataField, string endRowId, string endDataField | Selects a range of rows, cells or columns. The result of the method depends on the "selection" configuration of the Grid.Args: string rowId - row bound id,string dataField - column bound data field,string endRowId - row bound id,string endDataField - column bound data field |
SelectRange | void | int rowId, string dataField, int endRowId, string endDataField | Selects a range of rows, cells or columns. The result of the method depends on the "selection" configuration of the Grid.Args: int rowId - row bound id,string dataField - column bound data field,int endRowId - row bound id,string endDataField - column bound data field |
SelectRows | void | IEnumerable<object> rowId | Selects multiple rows by their ids.Args: IEnumerable<object> rowId - Array of row ids |
SelectRows | void | string[] rowId | Selects multiple rows by their ids.Args: string[] rowId - Array of row ids |
SelectRows | void | int[] rowId | Selects multiple rows by their ids.Args: int[] rowId - Array of row ids |
SelectRowsByIndex | void | int[] rowIndex | Selects multiple rows by their index.Args: int[] rowIndex - Array of row indexes |
SelectRowsRange | void | object rowId, object endRowId | Selects a range of rows.Args: string rowId - row bound id,string endRowId - row bound id |
SelectRowsRange | void | string rowId, string endRowId | Selects a range of rows.Args: string rowId - row bound id,string endRowId - row bound id |
SelectRowsRange | void | int rowId, int endRowId | Selects a range of rows.Args: int rowId - row bound id,int endRowId - row bound id |
SetCellValue | void | object rowId, string dataField, object value | Sets a new value to a cell.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,object value - New Cell value. |
SetCellValue | void | string rowId, string dataField, string value | Sets a new value to a cell.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string value - New Cell value. |
SetCellValue | void | int rowId, string dataField, int value | Sets a new value to a cell.Args: int rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,int value - New Cell value. |
SetColumnProperty | void | string dataField, string propertyName, object value | Sets a property to a column.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string propertyName - The column property's name.,object value - The new property value. |
SetHorizontalScrollValue | void | int value | Sets the position of the horizontal scrollbar. You can use this method in combination with the getHorizontalScrollValue and getHorizontalScrollMax.Args: int value - The new scroll position |
SetRowProperty | void | object rowId, string propertyName, object value | Sets a property to a row.Args: string rowId - row bound id,string propertyName - The row property's name.,object value - The new property value. |
SetVerticalScrollValue | void | int value | Sets the position of the vertical scrollbar. You can use this method in combination with the getVerticalScrollValue and getVerticalScrollMax.Args: int value - The new scroll position |
ShowDetail | void | object rowId | Shows the Details of a Row, when row details are enabled.Args: string rowId - row bound id |
ShowDetail | void | string rowId | Shows the Details of a Row, when row details are enabled.Args: string rowId - row bound id |
ShowDetail | void | int rowId | Shows the Details of a Row, when row details are enabled.Args: int rowId - row bound id |
SortBy | void | string dataField, string sortOrder | Sorts the Grid by a data field. This method will add or remove sorting, when sorting is enabled. To remove the sorting, use 'null' for the sortOrder parameter.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string sortOrder - column's sort order. Use 'asc', 'desc' or null. |
SortBy | void | string dataField, string sortOrder | Sorts the Grid by a data field. This method will add or remove sorting, when sorting is enabled. To remove the sorting, use 'null' for the sortOrder parameter.Args: string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.,string sortOrder - column's sort order. Use 'asc', 'desc' or null. |
StateHasChanged | void | 'N/A' | Refreshes the state and Re-renders the Blazor Component, if necessary. |
SwapColumns | void | object dataField, object referenceDataField | Swaps two DataGrid columns.Args: string dataField - The data field or column index of the first grid column.,string referenceDataField - The data field or column index of the second grid column. |
SwapColumns | void | string dataField, string referenceDataField | Swaps two DataGrid columns.Args: string dataField - The data field or column index of the first grid column.,string referenceDataField - The data field or column index of the second grid column. |
SwapColumns | void | int dataField, int referenceDataField | Swaps two DataGrid columns.Args: string dataField - The data field or column index of the first grid column.,int referenceDataField - The data field or column index of the second grid column. |
ToggleRow | void | object rowId | Toggles a TreeGrid row. When this method is called, the row is expanded, if it's state is collapsed and collapsed if it's state is expanded.Args: string rowId - row bound id |
ToggleRow | void | string rowId | Toggles a TreeGrid row. When this method is called, the row is expanded, if it's state is collapsed and collapsed if it's state is expanded.Args: string rowId - row bound id |
ToggleRow | void | int rowId | Toggles a TreeGrid row. When this method is called, the row is expanded, if it's state is collapsed and collapsed if it's state is expanded.Args: int rowId - row bound id |
UncheckAllRows | void | N/A | Unchecks all TreeGrid or Grouping rows. Sets all check-boxes to false. |
UncheckRow | void | object rowId | Unchecks a TreeGrid row. Sets its check-box to false.Args: string rowId - row bound id |
UncheckRow | void | string rowId | Unchecks a TreeGrid row. Sets its check-box to false.Args: string rowId - row bound id |
UncheckRow | void | int rowId | Unchecks a TreeGrid row. Sets its check-box to false.Args: int rowId - row bound id |
Unselect | void | object rowId, string dataField | Unselects a row, cell or column.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
Unselect | void | object rowId | Unselects a row, cell or column. |
Unselect | void | string rowId, string dataField | Unselects a row, cell or column.Args: string rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
Unselect | void | string rowId | Unselects a row, cell or column. |
Unselect | void | int rowId, string dataField | Unselects a row, cell or column.Args: int rowId - row bound id,string dataField - column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here. |
Unselect | void | int rowId | Unselects a row, cell or column. |
UpdateRow | void | object rowId, object data, object callback | Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.Args: string rowId - row bound id,object data - row data matching the data source,object callback - Sets a callback function, which is called after the row is updated. The callback's argument is the updated row. |
UpdateRow | void | object rowId, object data | Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved. |
Grid Events
Name | Type | Description | Event Detail |
---|---|---|---|
OnBeginEdit | EventCallback<Event> | This event is triggered, when the edit begins. | string id- The edited row id., string dataField- The edited column data field., dynamic row- The edited row., dynamic column- The edited column., dynamic cell- The edited cell. |
BeginEdited | event GridBeginEditedEventHandler | This event is triggered, when the edit begins. | GridBeginEditedEventArgs |
OnBatchChange | EventCallback<Event> | This event is triggered, when the Grid's header toolbar is displayed and the 'OK' button of a header dropdown is clicked. For example, when you open the columns customize panel, reorder columns and click the 'OK' button. | string type- The type of dropdown. Possible values: 'filter', 'sort', 'search', 'group', 'format', 'customize' |
BatchChanged | event GridBatchChangedEventHandler | This event is triggered, when the Grid's header toolbar is displayed and the 'OK' button of a header dropdown is clicked. For example, when you open the columns customize panel, reorder columns and click the 'OK' button. | GridBatchChangedEventArgs |
OnBatchCancel | EventCallback<Event> | This event is triggered, when the Grid's header toolbar is displayed and the 'Cancel' button of a header dropdown is clicked. | string type- The type of dropdown. Possible values: 'filter', 'sort', 'search', 'group', 'format', 'customize' |
BatchCanceled | event GridBatchCanceledEventHandler | This event is triggered, when the Grid's header toolbar is displayed and the 'Cancel' button of a header dropdown is clicked. | GridBatchCanceledEventArgs |
OnChange | EventCallback<Event> | This event is triggered, when the selection is changed. When you select with a drag, the event is triggered when the drag starts and ends. | bool started- The flag is "true", when the selection starts. The flag is "false", when the selection ends and when the user changes the selection by dragging., bool finished- The flag is "true", when the selection ends. The flag is "false", when the selection starts and when the user changes the selection by dragging., Event originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser |
Changed | event GridChangedEventHandler | This event is triggered, when the selection is changed. When you select with a drag, the event is triggered when the drag starts and ends. | GridChangedEventArgs |
OnColumnClick | EventCallback<Event> | This event is triggered, when the user clicks on the header of a column. | dynamic column- The clicked column., string dataField- The column's data field., dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser |
ColumnClicked | event GridColumnClickedEventHandler | This event is triggered, when the user clicks on the header of a column. | GridColumnClickedEventArgs |
OnColumnDoubleClick | EventCallback<Event> | This event is triggered, when the user double clicks on the header of a column. | dynamic column- The double-clicked column., string dataField- The column's data field., dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser |
ColumnDoubleClicked | event GridColumnDoubleClickedEventHandler | This event is triggered, when the user double clicks on the header of a column. | GridColumnDoubleClickedEventArgs |
OnColumnResize | EventCallback<Event> | This event is triggered, when the user resized a column. | dynamic column- The resized column., string dataField- The column's data field., string oldWidth- The old width of the column., string width- The new width of the column. |
ColumnResized | event GridColumnResizedEventHandler | This event is triggered, when the user resized a column. | GridColumnResizedEventArgs |
OnColumnDragStart | EventCallback<Event> | This event is triggered, when the user starts a column drag. | dynamic column- The column., string dataField- The column's data field., int index- The column's index, dynamic originalEvent- The origianl Event object. |
ColumnDragStarted | event GridColumnDragStartedEventHandler | This event is triggered, when the user starts a column drag. | GridColumnDragStartedEventArgs |
OnColumnDragging | EventCallback<Event> | This event is triggered, when the user drags a column. | dynamic column- The column., string dataField- The column's data field., int index- The column's index, dynamic data- The dragging object. data.feedback and data.feedbackLine are HTML Elements which are displayed while the user drags. The object has error(), success() and data() methods which you can call to set the feedback state., dynamic originalEvent- The origianl Event object. |
ColumnDragging | event GridColumnDraggingEventHandler | This event is triggered, when the user drags a column. | GridColumnDraggingEventArgs |
OnColumnDragEnd | EventCallback<Event> | This event is triggered, when the user drops a column. | dynamic column- The column., string dataField- The column's data field., int index- The column's index, int newIndex- The column's new index, dynamic data- The dragging object. data.feedback and data.feedbackLine are HTML Elements which are displayed while the user drags. The object has error(), success() and data() methods which you can call to set the feedback state., dynamic originalEvent- The origianl Event object. |
ColumnDragEnded | event GridColumnDragEndedEventHandler | This event is triggered, when the user drops a column. | GridColumnDragEndedEventArgs |
OnColumnReorder | EventCallback<Event> | This event is triggered, when the user reorders a column. | dynamic column- The column., string dataField- The column's data field., int index- The column's index, int newIndex- The column's new index, dynamic data- The dragging object. data.feedback and data.feedbackLine are HTML Elements which are displayed while the user drags. The object has error(), success() and data() methods which you can call to set the feedback state., dynamic originalEvent- The origianl Event object. |
ColumnReordered | event GridColumnReorderedEventHandler | This event is triggered, when the user reorders a column. | GridColumnReorderedEventArgs |
OnCommentAdd | EventCallback<Event> | This event is triggered, when the user enters a comment in the row edit dialog. | string id- The row's id., any comment- The comment object. The comment object has 'text: string', 'id: string', 'userId: string | number', and 'time: date' fields. The 'text' is the comment's text. 'id' is the comment's unique id, 'userId' is the user's id who entered the comment and 'time' is a javascript date object. |
CommentAdded | event GridCommentAddedEventHandler | This event is triggered, when the user enters a comment in the row edit dialog. | GridCommentAddedEventArgs |
OnCommentRemove | EventCallback<Event> | This event is triggered, when the user removes a comment in the row edit dialog. | string id- The row's id., any comment- The comment object. The comment object has 'text: string', 'id: string', 'userId: string | number', and 'time: date' fields. The 'text' is the comment's text. 'id' is the comment's unique id, 'userId' is the user's id who entered the comment and 'time' is a javascript date object. |
CommentRemoved | event GridCommentRemovedEventHandler | This event is triggered, when the user removes a comment in the row edit dialog. | GridCommentRemovedEventArgs |
OnRowDragStart | EventCallback<Event> | This event is triggered, when the user starts a row drag. | dynamic row- The row., string id- The row's id, int index- The row's index, dynamic originalEvent- The origianl Event object. |
RowDragStarted | event GridRowDragStartedEventHandler | This event is triggered, when the user starts a row drag. | GridRowDragStartedEventArgs |
OnRowDragging | EventCallback<Event> | This event is triggered, when the user drags a row. | dynamic row- The row., string id- The row's id, int index- The row's index, dynamic data- The dragging object. data.feedback and data.feedbackLine are HTML Elements which are displayed while the user drags. The object has error(), success() and data() methods which you can call to set the feedback state., dynamic originalEvent- The origianl Event object. |
RowDragging | event GridRowDraggingEventHandler | This event is triggered, when the user drags a row. | GridRowDraggingEventArgs |
OnRowDragEnd | EventCallback<Event> | This event is triggered, when the user drags a row. | dynamic row- The row., string id- The row's id, int index- The row's index, int newIndex- The row's new index, dynamic data- The dragging object. data.feedback and data.feedbackLine are HTML Elements which are displayed while the user drags. The object has error(), success() and data() methods which you can call to set the feedback state., dynamic originalEvent- The origianl Event object. |
RowDragEnded | event GridRowDragEndedEventHandler | This event is triggered, when the user drags a row. | GridRowDragEndedEventArgs |
OnRowReorder | EventCallback<Event> | This event is triggered, when the user reorders a row. | dynamic row- The row., string id- The row's id, int index- The row's index, int newIndex- The row's new index, dynamic data- The dragging object. data.feedback and data.feedbackLine are HTML Elements which are displayed while the user drags. The object has error(), success() and data() methods which you can call to set the feedback state., dynamic originalEvent- The origianl Event object. |
RowReordered | event GridRowReorderedEventHandler | This event is triggered, when the user reorders a row. | GridRowReorderedEventArgs |
OnRowExpand | EventCallback<Event> | This event is triggered, when the user expands a row of the grid. The Grid is in TreeGrid/Grouping mode. | dynamic row- The expanded row., string id- The row's id, dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser |
RowExpanded | event GridRowExpandedEventHandler | This event is triggered, when the user expands a row of the grid. The Grid is in TreeGrid/Grouping mode. | GridRowExpandedEventArgs |
OnRowCollapse | EventCallback<Event> | This event is triggered, when the user collapsed a row of the grid. The Grid is in TreeGrid/Grouping mode. | dynamic row- The collapsed row. , string id- The row's id, dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser |
RowCollapsed | event GridRowCollapsedEventHandler | This event is triggered, when the user collapsed a row of the grid. The Grid is in TreeGrid/Grouping mode. | GridRowCollapsedEventArgs |
OnRowClick | EventCallback<Event> | This event is triggered, when the user clicks on a row of the grid. | dynamic row- The clicked row., dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser, string id- Gets the row id., bool isRightClick- Gets whether the pointing device's right button is clicked., int pageX- Gets the click's X position., int pageY- Gets the click's Y position. |
RowClicked | event GridRowClickedEventHandler | This event is triggered, when the user clicks on a row of the grid. | GridRowClickedEventArgs |
OnRowDoubleClick | EventCallback<Event> | This event is triggered, when the user double clicks on a row of the grid. | dynamic row- The double-clicked row., dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser, string id- Gets the row id., bool isRightClick- Gets whether the pointing device's right button is clicked., int pageX- Gets the click's X position., int pageY- Gets the click's Y position. |
RowDoubleClicked | event GridRowDoubleClickedEventHandler | This event is triggered, when the user double clicks on a row of the grid. | GridRowDoubleClickedEventArgs |
OnRowResize | EventCallback<Event> | This event is triggered, when the user resized a row. | dynamic row- The resized row., string id- Gets the row id., string oldHeight- The old height of the row., string height- The new height of the row. |
RowResized | event GridRowResizedEventHandler | This event is triggered, when the user resized a row. | GridRowResizedEventArgs |
OnCellClick | EventCallback<Event> | This event is triggered, when the user clicks on a cell of the grid. | dynamic cell- The clicked cell., dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser, string id- Gets the row id., string dataField- Gets the column dataField., bool isRightClick- Gets whether the pointing device's right button is clicked., int pageX- Gets the click's X position., int pageY- Gets the click's Y position. |
CellClicked | event GridCellClickedEventHandler | This event is triggered, when the user clicks on a cell of the grid. | GridCellClickedEventArgs |
OnCellDoubleClick | EventCallback<Event> | This event is triggered, when the user double clicks on a cell of the grid. | dynamic cell- The double-clicked cell. , dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser, string id- Gets the row id., string dataField- Gets the column dataField., bool isRightClick- Gets whether the pointing device's right button is clicked., int pageX- Gets the click's X position., int pageY- Gets the click's Y position. |
CellDoubleClicked | event GridCellDoubleClickedEventHandler | This event is triggered, when the user double clicks on a cell of the grid. | GridCellDoubleClickedEventArgs |
OnEndEdit | EventCallback<Event> | This event is triggered, when the edit ends. | string id- The edited row id., string dataField- The edited column data field., dynamic row- The edited row., dynamic column- The edited column., dynamic cell- The edited cell. |
EndEdited | event GridEndEditedEventHandler | This event is triggered, when the edit ends. | GridEndEditedEventArgs |
OnFilter | EventCallback<Event> | This event is triggered, when a filter is added or removed. | dynamic columns- Array of columns., dynamic data- Array of {dataField: string, filter: object}. "dataField" is the column's data field. "filter" is a FilterGroup object., dynamic expressions- Array of {dataField: string, filter: string}. "dataField" is the column's data field. "filter" is a filter expression like 'startsWith B'. In each array item, you will have an object with column's name and filter string. Example: [['firstName', 'contains Andrew or contains Nancy'], ['quantity', '<= 3 and >= 8']], [['firstName', 'EQUAL' 'Andrew' or 'EQUAL' 'Antoni' or 'EQUAL' 'Beate']], [['lastName','CONTAINS' 'burke' or 'CONTAINS' 'peterson']]. Filter conditions used in the filter expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL' |
Filtered | event GridFilteredEventHandler | This event is triggered, when a filter is added or removed. | GridFilteredEventArgs |
OnGroup | EventCallback<Event> | This event is triggered, when the rows grouping is changed. | IEnumerable<string> groups- Array of column data fields. |
Grouped | event GridGroupedEventHandler | This event is triggered, when the rows grouping is changed. | GridGroupedEventArgs |
OnOpenColumnDialog | EventCallback<Event> | This event is triggered, when the add new column dialog is opened. | string dataField- The column data field. |
OpenColumnDialoged | event GridOpenColumnDialogedEventHandler | This event is triggered, when the add new column dialog is opened. | GridOpenColumnDialogedEventArgs |
OnCloseColumnDialog | EventCallback<Event> | This event is triggered, when the add new column dialog is closed. | string dataField- The column data field. |
CloseColumnDialoged | event GridCloseColumnDialogedEventHandler | This event is triggered, when the add new column dialog is closed. | GridCloseColumnDialogedEventArgs |
OnRowTap | EventCallback<Event> | This event is triggered when the user touches and holds on the row for at least 300ms. | dynamic row- The tapped row., dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser |
RowTaped | event GridRowTapedEventHandler | This event is triggered when the user touches and holds on the row for at least 300ms. | GridRowTapedEventArgs |
OnCellTap | EventCallback<Event> | This event is triggered when the user touches and holds on the cell for at least 300ms. | dynamic cell- The tapped row., dynamic originalEvent- The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser |
CellTaped | event GridCellTapedEventHandler | This event is triggered when the user touches and holds on the cell for at least 300ms. | GridCellTapedEventArgs |
OnPage | EventCallback<Event> | This event is triggered, when the user changes the pages. | N/A |
Paged | event GridPagedEventHandler | This event is triggered, when the user changes the pages. | GridPagedEventArgs |
OnSort | EventCallback<Event> | This event is triggered, when a sorting column is added or removed. | dynamic columns- Array of columns., dynamic data- Array of {dataField: string, sortOrder: string, sortIndex: number}. "dataField" is the column's data field. "sortOrder" is 'asc' or 'desc', "sortIndex" is the index of the column in multi column sorting. |
Sorted | event GridSortedEventHandler | This event is triggered, when a sorting column is added or removed. | GridSortedEventArgs |
OnScrollBottomReached | EventCallback<Event> | This event is triggered, when the user reaches the bottom of the grid. | N/A |
ScrollBottomReached | event GridScrollBottomReachedEventHandler | This event is triggered, when the user reaches the bottom of the grid. | GridScrollBottomReachedEventArgs |
OnScrollTopReached | EventCallback<Event> | This event is triggered, when the user reaches the top of the grid. | N/A |
ScrollTopReached | event GridScrollTopReachedEventHandler | This event is triggered, when the user reaches the top of the grid. | GridScrollTopReachedEventArgs |
Enums
GridAppearanceAutoGenerateRowLabelMode
GridAppearanceAutoGenerateRowLabelMode.Number |
GridAppearanceAutoGenerateRowLabelMode.Letter |
GridAppearanceAutoGenerateColumnLabelMode
GridAppearanceAutoGenerateColumnLabelMode.Number |
GridAppearanceAutoGenerateColumnLabelMode.Letter |
GridResizeMode
GridResizeMode.None |
GridResizeMode.Split |
GridResizeMode.GrowAndShrink |
GridClipboardAutoFillMode
GridClipboardAutoFillMode.None |
GridClipboardAutoFillMode.Copy |
GridClipboardAutoFillMode.FillSeries |
HorizontalAlignment
HorizontalAlignment.Left |
HorizontalAlignment.Center |
HorizontalAlignment.Right |
VerticalAlignment
VerticalAlignment.Top |
VerticalAlignment.Center |
VerticalAlignment.Bottom |
GridColumnFilterMenuMode
GridColumnFilterMenuMode.Basic |
GridColumnFilterMenuMode.Default |
GridColumnFilterMenuMode.Excel |
GridColumnSortOrder
GridColumnSortOrder.Asc |
GridColumnSortOrder.Desc |
GridColumnSortOrder.Null |
GridConditionalFormattingCondition
GridConditionalFormattingCondition.Between |
GridConditionalFormattingCondition.Equal |
GridConditionalFormattingCondition.GreaterThan |
GridConditionalFormattingCondition.LessThan |
GridConditionalFormattingCondition.NotEqual |
GridDataExportPageOrientation
GridDataExportPageOrientation.Landscape |
GridDataExportPageOrientation.Portrait |
GridDataSourceSettingsSanitizeHTML
GridDataSourceSettingsSanitizeHTML.All |
GridDataSourceSettingsSanitizeHTML.BlackList |
GridDataSourceSettingsSanitizeHTML.None |
GridDataSourceSettingsDataFieldDataType
GridDataSourceSettingsDataFieldDataType.String |
GridDataSourceSettingsDataFieldDataType.Date |
GridDataSourceSettingsDataFieldDataType.Boolean |
GridDataSourceSettingsDataFieldDataType.Number |
GridDataSourceSettingsDataFieldDataType.Array |
GridDataSourceSettingsDataFieldDataType.Any |
GridDataSourceSettingsDataSourceType
GridDataSourceSettingsDataSourceType.Array |
GridDataSourceSettingsDataSourceType.Json |
GridDataSourceSettingsDataSourceType.Xml |
GridDataSourceSettingsDataSourceType.Csv |
GridDataSourceSettingsDataSourceType.Tsv |
GridEditingAction
GridEditingAction.None |
GridEditingAction.Click |
GridEditingAction.DoubleClick |
LayoutPosition
LayoutPosition.Near |
LayoutPosition.Far |
LayoutPosition.Both |
GridCommandDisplayMode
GridCommandDisplayMode.Label |
GridCommandDisplayMode.Icon |
GridCommandDisplayMode.LabelAndIcon |
Position
Position.Near |
Position.Far |
GridEditingMode
GridEditingMode.Cell |
GridEditingMode.Row |
GridEditingAddNewRowDisplayMode
GridEditingAddNewRowDisplayMode.Row |
GridEditingAddNewRowDisplayMode.Button |
GridFilteringFilterRowApplyMode
GridFilteringFilterRowApplyMode.Auto |
GridFilteringFilterRowApplyMode.Click |
GridFilteringFilterMenuMode
GridFilteringFilterMenuMode.Default |
GridFilteringFilterMenuMode.Excel |
GridGroupingExpandMode
GridGroupingExpandMode.ButtonClick |
GridGroupingExpandMode.RowClick |
GridGroupingRenderMode
GridGroupingRenderMode.Basic |
GridGroupingRenderMode.Compact |
GridGroupingRenderMode.Advanced |
GridPagerAutoEllipsis
GridPagerAutoEllipsis.None |
GridPagerAutoEllipsis.Before |
GridPagerAutoEllipsis.After |
GridPagerAutoEllipsis.Both |
Scrolling
Scrolling.Physical |
Scrolling.Virtual |
Scrolling.Infinite |
Scrolling.Deferred |
GridSelectionMode
GridSelectionMode.One |
GridSelectionMode.Many |
GridSelectionMode.Extended |
GridSelectionAction
GridSelectionAction.None |
GridSelectionAction.Click |
GridSelectionAction.DoubleClick |
GridSelectionCheckBoxesSelectAllMode
GridSelectionCheckBoxesSelectAllMode.None |
GridSelectionCheckBoxesSelectAllMode.Page |
GridSelectionCheckBoxesSelectAllMode.All |
GridSortingMode
GridSortingMode.One |
GridSortingMode.Many |
Column Properties
Name | Type | Default | Description |
---|---|---|---|
Align | HorizontalAlignment | HorizontalAlignment.Left | Sets or gets the column's header alignment. Accepts: HorizontalAlignment.Left, HorizontalAlignment.Center, HorizontalAlignment.Right |
AllowExport | bool | true | Sets or gets whether the column can be exported. |
AllowGroup | bool | true | Sets or gets whether the column can be grouped. |
AllowHide | bool | true | Sets or gets whether the column can be hidden. |
AllowSelect | bool | true | Sets or gets whether the column can be selected. |
AllowEdit | bool | true | Sets or gets whether the column can be edited. |
AllowSort | bool | true | Sets or gets whether the column can be sorted. |
AllowHeaderEdit | bool | true | Sets or gets whether the column can be edited, when header editing is enabled. |
AllowFilter | bool | true | Sets or gets whether the column can be filtered. |
AllowReorder | bool | true | Sets or gets whether the column can be reordered. |
AllowResize | bool | true | Sets or gets whether the column can be resized. |
AllowNull | bool | true | Sets or gets whether the column can have 'null' values. |
CellsFormat | string | "" | Sets or gets the column's cells format. This property is used for applying a formatting to the cell values. Number format strings: 'd' - decimal numbers. 'f' - floating-point numbers. 'n' - integer numbers. 'c' - currency numbers. 'p' - percentage numbers. For adding decimal places to the numbers, add a number after the formatting stri For example: 'c3' displays a number in this format $25.256 Built-in Date formats: // short date pattern 'd' - 'M/d/yyyy', // long date pattern 'D' - 'dddd, MMMM dd, yyyy', // short time pattern 't' - 'h:mm tt', // long time pattern 'T' - 'h:mm:ss tt', // long date, short time pattern 'f' - 'dddd, MMMM dd, yyyy h:mm tt', // long date, long time pattern 'F' - 'dddd, MMMM dd, yyyy h:mm:ss tt', // month/day pattern 'M' - 'MMMM dd', // month/year pattern 'Y' - 'yyyy MMMM', // S is a sortable format that does not vary by culture 'S' - 'yyyy'-'MM'-'dd'T'HH':'mm':'ss' Date format strings: 'd'-the day of the month; 'dd'-the day of the month 'ddd'-the abbreviated name of the day of the week 'dddd'- the full name of the day of the week 'h'-the hour, using a 12-hour clock from 1 to 12 'hh'-the hour, using a 12-hour clock from 01 to 12 'H'-the hour, using a 24-hour clock from 0 to 23 'HH'- the hour, using a 24-hour clock from 00 to 23 'm'-the minute, from 0 through 59 'mm'-the minutes,from 00 though59 'M'- the month, from 1 through 12 'MM'- the month, from 01 through 12 'MMM'-the abbreviated name of the month 'MMMM'-the full name of the month 's'-the second, from 0 through 59 'ss'-the second, from 00 through 59 't'- the first character of the AM/PM designator 'tt'-the AM/PM designator 'y'- the year, from 0 to 99 'yy'- the year, from 00 to 99 'yyy'-the year, with a minimum of three digits 'yyyy'-the year as a four-digit number; 'yyyyy'-the year as a four-digit number. |
CellsAlign | HorizontalAlignment | HorizontalAlignment.Left | Sets or gets the column's cells alignment. Accepts: 'left', 'right' and 'center' |
CellsWrap | bool | false | Sets or gets the column's cells wrapping. Accepts: true or false. |
CellsVerticalAlign | VerticalAlignment | VerticalAlignment.Center | Sets or gets the column's cells vertical alignment. Accepts: VerticalAlignment.Top, VerticalAlignment.Center, VerticalAlignment.Bottom |
ClassName | string | "" | Sets or gets the column's header CSS class name. |
CellsClassName | string | "" | Sets or gets the column's cells CSS class name. |
ColumnGroup | string | "" | Sets the name of the column group. |
DataField | string | "" | Sets or gets the column's data source bound field. |
DataType | string | "string" | Sets or gets the column's data type. Any of the following value is valid: 'string', 'number', 'int', 'date', 'bool', 'object', 'any' |
DisplayField | string | "" | Sets or gets the column's data source bound field which will be displayed to the user. When the property is not set, it is equal to the 'dataField'. |
Description | string | "" | Sets or gets the column's description. The description of the column is displayed in the column's header, when the end-user moves the pointer over the description button. 'showDescriptionButton' property determines whether the description button is visible. |
Element | object | null | Gets the HTML Element. The property returns null when the Column is not in the View. |
Editor | object | null | Sets or gets the column's editor. The property expects 'input', 'autoComplete', 'comboBox', 'dropDownList', 'image', 'numberInput', 'checkBox', 'multiInput', 'multiComboInput', 'checkInput', 'slider', 'dateTimePicker', 'timeInput', 'dateInput', 'dateRangeInput', 'maskedTextBox', 'textArea' or a custom object with 'template' property which defines the editor type, 'settings' property which defines the custom editor's properties, 'onInit(int row, string column, object editor, object rowData): object', 'onRender(int row, string column, object editor, object rowData): object', 'setValue(object value): void' and 'getValue(object value): object' callback functions. |
Freeze | string | "false" | Sets or gets the Freeze mode. Accepts: 'near', 'far', true and false. Freezes/Pins the column to left(near) or right(far). |
Filter | string | "" | Sets or gets the filter of the column. Example: ['contains Andrew or contains Nancy']. Example with numeric filter ['quantity', '<= 3 and >= 8']. Additional example with filter which we want to apply to a column with filterMenuMode='excel' - ['EQUAL' 'Andrew' or 'EQUAL' 'Antoni' or 'EQUAL' 'Beate']. Example with a string filter applied to a string column - ['CONTAINS' 'burke' or 'CONTAINS' 'peterson']. Filter conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL' |
FilterMenuMode | GridColumnFilterMenuMode | GridColumnFilterMenuMode.Default | Sets or gets the filter menu mode of the column. In 'basic' mode, a single input is displayed in the filter menu. In 'default' mode, two input options are available for more precise filtering. In 'excel' mode, checked list with unique values is displayed. |
FormatSettings | object | new object() | Sets or gets the column's format settings. You can use any of the build in formatting options or to NumberFormat object like that: 'Intl: { NumberFormat: { style: \'currency\', currency: \'EUR\' }}' or DateTimeFormat object like that: 'Intl: { DateTimeFormat: { dateStyle: \'full\' }}'' |
Group | string | "" | Sets or gets the column's group. |
Icon | string | "" | Sets or gets the column's icon. Expects CSS class name. |
Label | string | "" | Sets or gets the text displayed in the column's header. |
MinWidth | int | 30 | Sets or gets the minimum width. |
SortOrder | GridColumnSortOrder | GridColumnSortOrder.Null | Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null. |
SortIndex | int | -1 | Sets or gets the sort index of the column. Accepts an integer value. This property can be used to get or set the column's sort index when sorting mode is 'many'. |
ShowActionButton | bool | true | Sets or gets whether the column's header action drop-down button is displayed. This button opens the column's menu. |
ShowIcon | bool | false | Sets or gets whether the column's header icon is displayed. |
ShowDescriptionButton | bool | false | Sets or gets whether the column's header description button is displayed. |
Width | object | "" | Sets or gets the width. Accepts: 'number', 'px', 'em', 'auto', 'null' values. |
Template | object | "" | Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'radioButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use. |
ValidationRules | IEnumerable<object> | null | Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message. |
VerticalAlign | VerticalAlignment | VerticalAlignment.Center | Sets or gets the column's header vertical alignment. Accepts: VerticalAlignment.Top, VerticalAlignment.Center, VerticalAlignment.Bottom |
Summary | string[] | new string[]{} | Sets or gets the column summary. The property should be set to an array with the following possible values: 'sum', 'min', 'max', 'avg', 'count', 'median', 'stdev', 'stdevp', 'var', 'varp'. |
Visible | bool | true | Sets or gets whether the column is visible. Set the property to 'false' to hide the column. |
GridAppearance Properties
Name | Type | Default | Description |
---|---|---|---|
AlternationStart | int | 0 | Starting row index of alternating colors. |
AlternationEnd | int | 0 | Ending row index of alternating colors. |
AlternationCount | int | 0 | number of row color alternations. |
AllowColumnStickyPosition | bool | false | Enables sticky columns. |
AllowHover | bool | false | Enables row hover effect. Applies a hover style to the cells. |
AllowHeaderHover | bool | true | Enables header hover effect. Applies a hover style to the headers. |
AllowRowToggleAnimation | bool | false | Enables row toggle animation. This animation starts when you expand/collapse a row in TreeGrid/Grouping mode. |
AllowRowDetailToggleAnimation | bool | false | Enables row detail toggle animation. This animation starts when you expand/collapse a row in TreeGrid/Grouping mode. |
AllowSortAnimation | bool | false | Enables sorting animation. Data records are sorted with animation, when sorting is applied. |
AllowColumnLabelAnimation | bool | true | Enables column label animation. The label is moved to 'left' with animation, when the column header's drop-down button is displayed on hover or sorting is applied. |
AllowColumnMenuAnimation | bool | true | Enables column menu animation. When you click on the column header's drop-down button, the menu is animated. |
AllowColumnSortButtonAnimation | bool | true | Enables column sort button animation. When you click on a sortable column to change the sort order, the sort button is animated. |
AllowColumnActionButtonAnimation | bool | true | Enables column action button animation. The drop-down button displayed on column header hover is optionally animated. |
AllowColumnFilterButtonAnimation | bool | true | Enables column filter button animation. |
AutoShowColumnSortButton | bool | true | If enabled, automatically shows column sort button. The sort button is displayed only when the column is sorted. If the property's value is false, sort button will be always displayed to indicate that sorting is possible. |
AutoShowColumnActionButton | bool | true | If enabled, automatically shows column action button. |
AutoShowColumnFilterButton | bool | true | If enabled, automatically shows column filter button. |
AutoGenerateRowLabelMode | GridAppearanceAutoGenerateRowLabelMode | GridAppearanceAutoGenerateRowLabelMode.Number | Generates labels as 'numbers' or 'letters'. This property affects the rendering of the row header. |
AutoGenerateColumnLabelMode | GridAppearanceAutoGenerateColumnLabelMode | GridAppearanceAutoGenerateColumnLabelMode.Letter | Generates labels as 'numbers' or 'letters. This property affects the rendering of the column header. |
DisplayLoadingIndicator | bool | false | Sets the visibility of the loading indicator. This is the Loading... image displayed in the Grid while loading data. |
LoadingIndicatorPlaceholder | string | "Loading..." | Sets the loading indicator label. This is the Text displayed while loading data. |
Placeholder | string | "No Rows" | Sets the placeholder of the Grid. The placeholder is displayed when the Grid is empty. |
SortAnimationDuration | int | 500 | Sets the duration of sorting animation. This property is related to the allowSortAnimation property. |
ShowRowHeader | bool | false | Shows or hides Row header. |
ShowRowHeaderNumber | bool | false | Shows row indexes in the row header. The showRowHeader property should be true |
ShowRowHeaderEditIcon | bool | true | Shows edit icon when a cell or row is in edit state. |
ShowRowHeaderSelectIcon | bool | false | Shows select icon when the pointer is over the row header cell. |
ShowRowHeaderFocusIcon | bool | false | Shows focus icon on cell or row focus. |
ShowRowHeaderDragIcon | bool | false | Shows drag icon on the row header. |
ShowColumnHeaderLines | bool | true | Shows column header lines. |
ShowColumnLines | bool | true | Shows column lines. |
ShowRowLines | bool | true | Shows row lines. |
ShowColumnGroupsInColumnPanel | bool | false | Shows column groups in the Hide columns panel. Column groups and columns are shown in a tree-like structure. When the property is set to false, the column groups are not displayed and the column labels contain the column group name. |
ShowFilterColumnBackground | bool | true | Shows filtered column background, when filter is applied. |
ShowSortColumnBackground | bool | true | Shows sorted column background, when sorting is applied. |
ShowFrozenColumnBackground | bool | true | Shows frozen column background, when the Grid has frozen columns. |
ShowFrozenRowBackground | bool | true | Shows filtered row background, when the Grid has frozen rows. |
ShowColumnSortButton | bool | true | Shows column sort button. |
ShowColumnFilterButton | bool | true | Shows column filter button. |
ShowColumnDescriptionButton | bool | false | Shows column description button. The button's style is customizable through the Grid CSS. |
ShowColumnIcon | bool | false | Shows column icon within the column's header. |
ShowColumnCustomButton | bool | false | Shows column custom button. User-defined button shown in the column header. |
ShowColumnActionButton | bool | true | Shows column action button. This is the drop-down button displayed in the column header. |
ShowTooltips | bool | false | Shows tooltips when user hovers columns or cells. |
ShowHorizontalScrollBarOnFixedColumns | bool | false | Shows horizontal scrollbar on fixed columns. |
ShowVerticalScrollBarOnFixedColumns | bool | false | Shows vertical scrollbar on fixed columns. |
GridBehavior Properties
Name | Type | Default | Description |
---|---|---|---|
AllowColumnAutoSizeOnDoubleClick | bool | true | Auto-Resize on double-click of a column's right border. |
AllowRowAutoSizeOnDoubleClick | bool | true | Auto-Resize on double-click of a row's bottom border. |
AllowRowReorder | bool | false | Determines whether row reorder is enabled. |
AllowColumnReorder | bool | false | Determines whether column reorder is enabled. |
AllowColumnFreeze | bool | false | Determines whether column freeze with drag and drop is enabled. When other columns are frozen/pinned, drag the column to the existing frozen area. When no columns are pinned, drag the column to the edge of the grid and wait for approximately one second. The grid will then assume you want to freeze/pin and create a frozen/pinned area and place the column into it. |
ColumnResizeMode | GridResizeMode | GridResizeMode.None | Sets the column resize mode. split resize mode 'grows' or 'shrinks' the resize element's size and 'shrinks' or 'grows' the next sibling element's size. growAndShrink resize mode 'grows' or 'shrinks' the resize element's size |
RowResizeMode | GridResizeMode | GridResizeMode.None | Sets the row resize mode. split resize mode 'grows' or 'shrinks' the resize element's size and 'shrinks' or 'grows' the next sibling element's size. growAndShrink resize mode 'grows' or 'shrinks' the resize element's size |
GridLayout Properties
Name | Type | Default | Description |
---|---|---|---|
AllowCellsWrap | bool | false | Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines. |
AutoSizeNewColumn | bool | false | Automatically sets width to any new Column which does not have its 'width' property set. |
AutoGenerateColumnWidth | object | null | Sets the width of the auto-generated Grid columns. |
ColumnWidth | object | null | Sets the width of the Grid columns. |
ColumnHeight | object | null | Sets the height of the Grid columns. |
ColumnMinHeight | int | 30 | Sets the minimum height of the Grid columns. |
RowMinHeight | int | 30 | Sets the minimum height of the Grid rows. |
RowHeight | object | null | Sets the height of the Grid rows. The property can be set to null, auto or a number. |
GridClipboard Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | true | Sets or gets whether the property is enabled. |
AutoFillMode | GridClipboardAutoFillMode | GridClipboardAutoFillMode.FillSeries | Sets or gets whether the copy-pasted values will be auto-filled by using automatic pattern detection. This is used in the Drag&Drop Multiple Cells selection. none does nothing. copy just copies the cells. 'fillSeries' detects and automatically fills the values. For example, if the selection has '1, 2' and the possible positions are more, the pasted values would be '1, 2, 3, 4, etc. |
OnPasteValue | object | null | Sets or gets a callback on paste. |
GridColumn Properties
Name | Type | Default | Description |
---|---|---|---|
Align | HorizontalAlignment | HorizontalAlignment.Left | Sets or gets the column's header alignment. Accepts: HorizontalAlignment.Left, HorizontalAlignment.Center, HorizontalAlignment.Right |
AllowExport | bool | true | Sets or gets whether the column can be exported. |
AllowGroup | bool | true | Sets or gets whether the column can be grouped. |
AllowHide | bool | true | Sets or gets whether the column can be hidden. |
AllowSelect | bool | true | Sets or gets whether the column can be selected. |
AllowEdit | bool | true | Sets or gets whether the column can be edited. |
AllowSort | bool | true | Sets or gets whether the column can be sorted. |
AllowHeaderEdit | bool | true | Sets or gets whether the column can be edited, when header editing is enabled. |
AllowFilter | bool | true | Sets or gets whether the column can be filtered. |
AllowReorder | bool | true | Sets or gets whether the column can be reordered. |
AllowResize | bool | true | Sets or gets whether the column can be resized. |
AllowNull | bool | true | Sets or gets whether the column can have 'null' values. |
CellsFormat | string | "" | Sets or gets the column's cells format. This property is used for applying a formatting to the cell values. Number format strings: 'd' - decimal numbers. 'f' - floating-point numbers. 'n' - integer numbers. 'c' - currency numbers. 'p' - percentage numbers. For adding decimal places to the numbers, add a number after the formatting stri For example: 'c3' displays a number in this format $25.256 Built-in Date formats: // short date pattern 'd' - 'M/d/yyyy', // long date pattern 'D' - 'dddd, MMMM dd, yyyy', // short time pattern 't' - 'h:mm tt', // long time pattern 'T' - 'h:mm:ss tt', // long date, short time pattern 'f' - 'dddd, MMMM dd, yyyy h:mm tt', // long date, long time pattern 'F' - 'dddd, MMMM dd, yyyy h:mm:ss tt', // month/day pattern 'M' - 'MMMM dd', // month/year pattern 'Y' - 'yyyy MMMM', // S is a sortable format that does not vary by culture 'S' - 'yyyy'-'MM'-'dd'T'HH':'mm':'ss' Date format strings: 'd'-the day of the month; 'dd'-the day of the month 'ddd'-the abbreviated name of the day of the week 'dddd'- the full name of the day of the week 'h'-the hour, using a 12-hour clock from 1 to 12 'hh'-the hour, using a 12-hour clock from 01 to 12 'H'-the hour, using a 24-hour clock from 0 to 23 'HH'- the hour, using a 24-hour clock from 00 to 23 'm'-the minute, from 0 through 59 'mm'-the minutes,from 00 though59 'M'- the month, from 1 through 12 'MM'- the month, from 01 through 12 'MMM'-the abbreviated name of the month 'MMMM'-the full name of the month 's'-the second, from 0 through 59 'ss'-the second, from 00 through 59 't'- the first character of the AM/PM designator 'tt'-the AM/PM designator 'y'- the year, from 0 to 99 'yy'- the year, from 00 to 99 'yyy'-the year, with a minimum of three digits 'yyyy'-the year as a four-digit number; 'yyyyy'-the year as a four-digit number. |
CellsAlign | HorizontalAlignment | HorizontalAlignment.Left | Sets or gets the column's cells alignment. Accepts: 'left', 'right' and 'center' |
CellsWrap | bool | false | Sets or gets the column's cells wrapping. Accepts: true or false. |
CellsVerticalAlign | VerticalAlignment | VerticalAlignment.Center | Sets or gets the column's cells vertical alignment. Accepts: VerticalAlignment.Top, VerticalAlignment.Center, VerticalAlignment.Bottom |
ClassName | string | "" | Sets or gets the column's header CSS class name. |
CellsClassName | string | "" | Sets or gets the column's cells CSS class name. |
ColumnGroup | string | "" | Sets the name of the column group. |
DataField | string | "" | Sets or gets the column's data source bound field. |
DataType | string | "string" | Sets or gets the column's data type. Any of the following value is valid: 'string', 'number', 'int', 'date', 'bool', 'object', 'any' |
DisplayField | string | "" | Sets or gets the column's data source bound field which will be displayed to the user. When the property is not set, it is equal to the 'dataField'. |
Description | string | "" | Sets or gets the column's description. The description of the column is displayed in the column's header, when the end-user moves the pointer over the description button. 'showDescriptionButton' property determines whether the description button is visible. |
Element | object | null | Gets the HTML Element. The property returns null when the Column is not in the View. |
Editor | object | null | Sets or gets the column's editor. The property expects 'input', 'autoComplete', 'comboBox', 'dropDownList', 'image', 'numberInput', 'checkBox', 'multiInput', 'multiComboInput', 'checkInput', 'slider', 'dateTimePicker', 'timeInput', 'dateInput', 'dateRangeInput', 'maskedTextBox', 'textArea' or a custom object with 'template' property which defines the editor type, 'settings' property which defines the custom editor's properties, 'onInit(int row, string column, object editor, object rowData): object', 'onRender(int row, string column, object editor, object rowData): object', 'setValue(object value): void' and 'getValue(object value): object' callback functions. |
Freeze | string | "false" | Sets or gets the Freeze mode. Accepts: 'near', 'far', true and false. Freezes/Pins the column to left(near) or right(far). |
Filter | string | "" | Sets or gets the filter of the column. Example: ['contains Andrew or contains Nancy']. Example with numeric filter ['quantity', '<= 3 and >= 8']. Additional example with filter which we want to apply to a column with filterMenuMode='excel' - ['EQUAL' 'Andrew' or 'EQUAL' 'Antoni' or 'EQUAL' 'Beate']. Example with a string filter applied to a string column - ['CONTAINS' 'burke' or 'CONTAINS' 'peterson']. Filter conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL' |
FilterMenuMode | GridColumnFilterMenuMode | GridColumnFilterMenuMode.Default | Sets or gets the filter menu mode of the column. In 'basic' mode, a single input is displayed in the filter menu. In 'default' mode, two input options are available for more precise filtering. In 'excel' mode, checked list with unique values is displayed. |
FormatSettings | object | new object() | Sets or gets the column's format settings. You can use any of the build in formatting options or to NumberFormat object like that: 'Intl: { NumberFormat: { style: \'currency\', currency: \'EUR\' }}' or DateTimeFormat object like that: 'Intl: { DateTimeFormat: { dateStyle: \'full\' }}'' |
Group | string | "" | Sets or gets the column's group. |
Icon | string | "" | Sets or gets the column's icon. Expects CSS class name. |
Label | string | "" | Sets or gets the text displayed in the column's header. |
MinWidth | int | 30 | Sets or gets the minimum width. |
SortOrder | GridColumnSortOrder | GridColumnSortOrder.Null | Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null. |
SortIndex | int | -1 | Sets or gets the sort index of the column. Accepts an integer value. This property can be used to get or set the column's sort index when sorting mode is 'many'. |
ShowActionButton | bool | true | Sets or gets whether the column's header action drop-down button is displayed. This button opens the column's menu. |
ShowIcon | bool | false | Sets or gets whether the column's header icon is displayed. |
ShowDescriptionButton | bool | false | Sets or gets whether the column's header description button is displayed. |
Width | object | "" | Sets or gets the width. Accepts: 'number', 'px', 'em', 'auto', 'null' values. |
Template | object | "" | Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'radioButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use. |
ValidationRules | IEnumerable<object> | null | Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message. |
VerticalAlign | VerticalAlignment | VerticalAlignment.Center | Sets or gets the column's header vertical alignment. Accepts: VerticalAlignment.Top, VerticalAlignment.Center, VerticalAlignment.Bottom |
Summary | string[] | new string[]{} | Sets or gets the column summary. The property should be set to an array with the following possible values: 'sum', 'min', 'max', 'avg', 'count', 'median', 'stdev', 'stdevp', 'var', 'varp'. |
Visible | bool | true | Sets or gets whether the column is visible. Set the property to 'false' to hide the column. |
GridColumnMenu Properties
Name | Type | Default | Description |
---|---|---|---|
AutoClose | bool | true | Automatically closes the column menu. |
DataSource | GridColumnMenuDataSource | new GridColumnMenuDataSource() | Sets the data sources to the column menu. |
Visible | bool | false | Gets the visibility of the column menu. Returns true, when the column menu is visible. |
Enabled | bool | false | Sets or gets whether the column menu is enabled. If the value is false, the column menu will not be displayed, when user hovers the column. |
Width | int | 250 | Sets the width of the column menu. |
Height | int? | null | Sets the height of the column menu. |
GridColumnMenuDataSource Properties
Name | Type | Default | Description |
---|---|---|---|
ColumnMenuCustomizeType | GridCommand | new GridCommand() | Describes the settings of the column menu customize type |
ColumnMenuItemRename | GridCommand | new GridCommand() | Describes the settings of the column menu item rename. |
ColumnMenuItemEditDescription | GridCommand | new GridCommand() | Describes the settings of the column menu item edit description. |
ColumnMenuItemDuplicate | GridCommand | new GridCommand() | Describes the settings of the column menu item duplicate. |
ColumnMenuItemInsertLeft | GridCommand | new GridCommand() | Describes the settings of the column menu item insert left. |
ColumnMenuItemInsertRight | GridCommand | new GridCommand() | Describes the settings of the of the column menu item insert right. |
ColumnMenuItemSortAsc | GridCommand | new GridCommand() | Describes the settings of the column menu item sort ascending. |
ColumnMenuItemSortDesc | GridCommand | new GridCommand() | Describes the settings of the column menu item sort descending. |
ColumnMenuItemRemoveSort | GridCommand | new GridCommand() | Describes the settings of the column menu item remove sort. |
ColumnMenuItemFilter | GridCommand | new GridCommand() | Describes the settings of the column menu item filter. |
ColumnMenuItemRemoveFilter | GridCommand | new GridCommand() | Describes the settings of the column menu item remove filter. |
ColumnMenuItemGroupBy | GridCommand | new GridCommand() | Describes the settings of the column menu item group by. |
ColumnMenuItemRemoveGroupBy | GridCommand | new GridCommand() | Describes the settings of the column menu item group by. |
ColumnMenuItemHide | GridCommand | new GridCommand() | Describes the settings of the column menu item hide. |
ColumnMenuItemDelete | GridCommand | new GridCommand() | Describes the settings of the column menu item delete. |
GridCommand Properties
Name | Type | Default | Description |
---|---|---|---|
Command | string | "customizeTypeCommand" | Sets the command of the column menu customize type. |
Enabled | bool | true | Enables the column menu customize type. |
Visible | bool | false | Sets the visibility of the column menu customize type. |
Icon | string | "jqx-icon-customize" | Sets the icon of the column menu customize type. |
Label | string | "{{messages}}" | Sets the label of the column menu customize type. |
GridColumnGroup Properties
Name | Type | Default | Description |
---|---|---|---|
Label | string | "" | Sets the label. |
Align | HorizontalAlignment | HorizontalAlignment.Center | Sets the align. |
Name | string | "" | Sets the name of the column group. |
ParentGroup | string | "" | Sets the name of the parent column group. |
VerticalAlign | VerticalAlignment | VerticalAlignment.Center | Sets the vertical align. |
GridConditionalFormatting Properties
Name | Type | Default | Description |
---|---|---|---|
Column | string | "all" | The data field of a numeric column to format. Set 'all' to format all numeric columns. |
Condition | GridConditionalFormattingCondition | GridConditionalFormattingCondition.LessThan | The formatting condition. |
FirstValue | int | 0 | The value to compare by. When condition is 'between', this is the start (from) value. |
FontFamily | string | "" | The fontFamily to apply to formatted cells. |
FontSize | string | "The default fontSize as set in CSS" | The fontSize to apply to formatted cells. |
Highlight | string | "The default backgroundColor as set in CSS" | The background color to apply to formatted cells. |
SecondValue | int | 1 | When condition is 'between', this is the end (to) value. Otherwise, this value is not used. |
Text | string | "The default color as set in CSS" | The text color to apply to formatted cells. |
GridCharting Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Sets or gets whether charting is enabled. |
ColorScheme | string | "scheme01" | Sets or gets the charting colors. Accepts the 'colorScheme' values of our Chart component. |
AppendTo | object | null | Sets or gets the chart's container. |
Dialog | Dialog | new Dialog() | Sets or gets the charting dialog. |
Dialog Properties
Name | Type | Default | Description |
---|---|---|---|
Header | string | "{{message}}" | Sets or gets the dialog header. |
Height | int | 400 | Sets or gets the dialog height. |
Width | int | 400 | Sets or gets the dialog width. |
Left | object | "center" | Sets or gets the dialog Left position. |
Top | object | "center" | Sets or gets the dialog Top position. |
Enabled | bool | true | Sets or gets whether the dialog is enabled. |
Visible | bool | false | Gets whether the dialog is displayed. |
GridCheckBoxes Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the visibility of the TreeGrid checkboxes. |
HasThreeStates | bool | false | Sets the three-state mode of the TreeGrid checkboxes. In that mode, checking a checkbox affects the parent-child rows checkboxes. |
GridDataExport Properties
Name | Type | Default | Description |
---|---|---|---|
Header | bool | true | Sets whether the columns header will be exported. |
FilterBy | object | null | Sets whether the export uses the applied filters. |
GroupBy | object | null | Sets the groups of the exported data. |
Style | object | null | Sets a custom style object of the dataExport. |
FileName | string | "jqxGrid" | Sets the exported file's name. |
PageOrientation | GridDataExportPageOrientation | GridDataExportPageOrientation.Portrait | Sets the page orientation, when exporting to PDF. |
ExpandChar | string | "+" | Sets the expand char displayed when the Grid with row hierarchy(TreeGrid / Grouped) is exported. |
CollapseChar | string | "-" | Sets the collapse char displayed when the Grid with row hierarchy(TreeGrid / Grouped) is exported. |
View | bool | false | Exports only the visible data of the Grid. |
ViewStart | int? | null | Determines the start row index that will be exported or printed. 'view' should be set to true |
ViewEnd | int? | null | Determines the end row index that will be exported or printed. 'view' should be set to true |
RowIds | IEnumerable<object> | null | An array of row ids that denotes the rows to export. |
GridDataSourceSettings Properties
Name | Type | Default | Description |
---|---|---|---|
AutoGenerateColumns | bool | false | Sets or gets whether a column will be auto-generated. |
ChildrenDataField | string | "" | Sets or gets a children data field like 'children', 'items' in the data source. When this property is set, the component will look for this data field when looping through the items. If it is found a hierarchical data source would be created. |
SanitizeHTML | GridDataSourceSettingsSanitizeHTML | GridDataSourceSettingsSanitizeHTML.BlackList | Sets or gets the XML binding root. |
Root | string | "" | Sets or gets the XML binding root. |
Record | string | "" | Sets or gets the XML binding record. |
GroupBy | string[] | new string[]{} | Sets or gets the data fields to group by. |
DataFields | IEnumerable<IGridDataSourceSettingsDataField> | null | Sets or gets the data fields which decribe the loaded data and data type. Ex: ['id: number', 'firstName: string', 'lastName: string'] |
DataSourceType | GridDataSourceSettingsDataSourceType | GridDataSourceSettingsDataSourceType.Array | Sets or gets whether the data source type. |
Id | string | "" | Sets or gets the component's id |
KeyDataField | string | "" | Sets or gets the key data field to be used for building the hierarchy. It is used in combination with the parentDataField property. Usually the 'id' field is used as key data field and 'parentId' as parent data field' |
ParentDataField | string | "" | Sets or gets the parent data field to be used for building the hierarchy. It is used in combination with the keyDataField property. Usually the 'id' field is used as key data field and 'parentId' as parent data field' |
MapChar | string | "." | Sets the 'mapChar' data field of the record |
VirtualDataSource | object | null | Sets the virtual data source function which is called each time the Grid requests data. Demos using 'virtualDataSource' are available on the Grid demos page. |
VirtualDataSourceOnExpand | object | null | Sets the virtual data source on expand function. This function is called when we load data on demand in Tree or TreeGrid and virtualDataSource in these components is set, too |
GridDataSourceSettingsDataField Properties
Name | Type | Default | Description |
---|---|---|---|
Name | string | "" | Sets the dataField name. |
Map | string | "" | Sets the dataField mapping path. For nested mapping, use '.'. Example: 'name.firstName'. |
DataType | GridDataSourceSettingsDataFieldDataType | GridDataSourceSettingsDataFieldDataType.String | Sets the dataField type. |
GridEditing Properties
Name | Type | Default | Description |
---|---|---|---|
AllowRowHeaderEdit | bool | false | Enables row header cells editing. |
AllowColumnHeaderEdit | bool | false | Enables column headers editing. |
Enabled | bool | false | Enables editing. |
Batch | bool | false | Enables batch editing. This allows editing multiple grid rows on the client side and sending them with a single server request. |
Action | GridEditingAction | GridEditingAction.Click | Determines the way editing is initiated. |
CommandKeys | GridEditingCommandKeys | new GridEditingCommandKeys() | Describes command keys. |
CommandBar | GridEditingCommandBar | new GridEditingCommandBar() | Describes the grid's command bar settings. The command bar is a toolbar or statusbar with tools for saving and reverting edits. |
CommandColumn | GridEditingCommandColumn | new GridEditingCommandColumn() | Describes the grid's command column settings. The command column can be used to edit or delete a row. |
Mode | GridEditingMode | GridEditingMode.Cell | Sets the grid's edit mode. |
AddNewRow | GridEditingAddNewRow | new GridEditingAddNewRow() | Describes the settings of the 'Add New Row' UI element which enables the quick adding of rows to the Grid with a single click. |
AddNewColumn | GridEditingAddNewColumn | new GridEditingAddNewColumn() | Enables users to dynamically add new columns through the User Interface. When the add new column is visible, a '+' is displayed as a last column. Clicking it opens a dialog for adding new columns. |
Dialog | Dialog | new Dialog() | Describes dialog's editing settings. |
AddDialog | Dialog | new Dialog() | Describes add dialog's settings |
DeleteDialog | Dialog | new Dialog() | Describes delete dialog's settings |
GridEditingCommandKeys Properties
Name | Type | Default | Description |
---|---|---|---|
CommandKeyEdit | GridCommandKey | new GridCommandKey() | Describes the edit command key. |
CommandKeyCancel | GridCommandKey | new GridCommandKey() | Describes the cancel command key. |
CommandKeyUpdate | GridCommandKey | new GridCommandKey() | Describes the update command key. |
GridCommandKey Properties
Name | Type | Default | Description |
---|---|---|---|
Command | string | "commandKeyEditCommand" | Sets the name of the edit key command. |
Key | string | "F2" | Sets the key that invokes the edit command. |
GridEditingCommandBar Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Makes the command bar visible. |
Position | LayoutPosition | LayoutPosition.Near | Sets the command bar's position. |
DisplayMode | GridCommandDisplayMode | GridCommandDisplayMode.LabelAndIcon | Sets what is to be displayed in command bar buttons. |
DataSource | GridEditingCommandBarDataSource | new GridEditingCommandBarDataSource() | Sets the command bar's data source. |
GridEditingCommandBarDataSource Properties
Name | Type | Default | Description |
---|---|---|---|
CommandBarAddRow | GridCommand | new GridCommand() | Describes the settings of the command bar's button for adding rows. |
CommandBarDeleteRow | GridCommand | new GridCommand() | Describes the settings of the command bar's button for deleting rows. |
CommandBarBatchSave | GridCommand | new GridCommand() | Describes the settings of the command bar's button for saving changes. |
CommandBarBatchRevert | GridCommand | new GridCommand() | Describes the settings of the command bar's button for reverting changes. |
GridEditingCommandColumn Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Makes the command column visible. |
Inline | bool | false | Enables inline display of the command column. |
Position | Position | Position.Far | Sets the command column's position. |
DisplayMode | GridCommandDisplayMode | GridCommandDisplayMode.Icon | Sets what is to be displayed in command column buttons. |
DataSource | GridEditingCommandColumnDataSource | new GridEditingCommandColumnDataSource() | Sets the command column's data source. |
Width | int? | null | Sets the width of the command column. |
GridEditingCommandColumnDataSource Properties
Name | Type | Default | Description |
---|---|---|---|
CommandColumnMenu | GridCommand | new GridCommand() | Describes the settings of the command column's button displayed in the column's header. By default, this Command opens a Menu with Column Chooser. |
CommandColumnEdit | GridCommand | new GridCommand() | Describes the settings of the command column's button for editing rows. |
CommandColumnDelete | GridCommand | new GridCommand() | Describes the settings of the command column's button for deleting rows. |
CommandColumnUpdate | GridCommand | new GridCommand() | Describes the settings of the command column's button for updating rows. |
CommandColumnCancel | GridCommand | new GridCommand() | Describes the settings of the command column's button for canceling edits. |
CommandColumnRowMenu | GridCommand | new GridCommand() | Describes the settings of the command column's row menu button. |
CommandColumnCustom | GridCommand | new GridCommand() | Describes the settings of the command column's custom button. |
GridEditingAddNewRow Properties
Name | Type | Default | Description |
---|---|---|---|
AutoCreate | bool | false | Adds new row by clicking the Enter button, when the focused row is the last row. |
AutoEdit | bool | true | Determines whether the newly added row enters automatically in edit mode, when added. |
Position | LayoutPosition | LayoutPosition.Both | Sets the position of the 'Add New Row' UI element. |
DisplayMode | GridEditingAddNewRowDisplayMode | GridEditingAddNewRowDisplayMode.Row | Sets or gets the display mode of the new row action. It could be either 'row' or 'button'. |
Visible | bool | false | Makes the 'Add New Row' UI element visible. |
Label | string | "{{message}}" | Sets the label of the 'Add New Row' UI element. |
GridEditingAddNewColumn Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Makes the 'Add New Row' UI element visible. |
GridFiltering Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Enables filtering. |
Filter | IEnumerable<object> | new List<object>() | An array of filtering conditions to apply to the DataGrid. Each member of the filter array is an array with two members. The first one is the column dataField to apply the filter to. The second one is the filtering condition. Example: [['firstName', 'contains Andrew or contains Nancy'], ['quantity', '<= 3 and >= 8']]. Additional example with filter which we want to apply to a column with filterMenuMode='excel' - [['firstName', 'EQUAL' 'Andrew' or 'EQUAL' 'Antoni' or 'EQUAL' 'Beate']]. Example with a string filter applied to a string column - [['lastName','CONTAINS' 'burke' or 'CONTAINS' 'peterson']]. Filter conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL' |
FilterRow | GridFilteringFilterRow | new GridFilteringFilterRow() | Describes the filter row's settings. |
FilterMenu | GridFilteringFilterMenu | new GridFilteringFilterMenu() | Describes the settings for the filter menu. |
FilterBuilder | GridFilteringFilterBuilder | new GridFilteringFilterBuilder() | (In Development)Describes the settings for the filter builder. |
GridFilteringFilterRow Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Makes the filter row visible. |
MenuVisible | bool | false | Makes the filter row's menu visible. |
ApplyMode | GridFilteringFilterRowApplyMode | GridFilteringFilterRowApplyMode.Auto | Sets the way filtering through the filter row is applied. |
AutoApplyModeDelay | int | 300 | Sets the delay (in milliseconds) before applying filtering (when filtering.filterRow.applyMode is 'auto'). |
GridFilteringFilterMenu Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | true | Sets the visibility of the filter menu. |
Buttons | string[] | new string[]{} | Sets the button text of the filter menu. |
Mode | GridFilteringFilterMenuMode | GridFilteringFilterMenuMode.Default | Sets the filter menu mode. |
DataSource | object | null | Sets the filter menu datasource. |
Width | int | 250 | Sets the width of the filter menu. |
Height | int | 200 | Sets the height of the filter menu. |
GridFilteringFilterBuilder Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the visibility of the filter builder. |
Height | int? | null | Sets the height of the filter builder. |
GridGrouping Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Enables grouping. |
AllowCollapse | bool | false | Enables collapsing of groups. |
AutoExpandAll | bool | false | Automatically expands all groups. |
AutoHideGroupColumn | bool | false | Automatically hides all grouped columns. |
ExpandMode | GridGroupingExpandMode | GridGroupingExpandMode.ButtonClick | Sets the group expand mode. |
RenderMode | GridGroupingRenderMode | GridGroupingRenderMode.Advanced | Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level. |
GroupRowHeight | object | 50 | Sets the group row height. |
ToggleButtonIndent | int | 16 | Sets the indent of the group toggle button. |
GroupIndent | int | 16 | Sets the indent of the group. |
GroupBar | GridGroupingGroupBar | new GridGroupingGroupBar() | Describes the group bar's settings. |
SummaryRow | GridGroupingSummaryRow | new GridGroupingSummaryRow() | Describes the group summary row's settings. |
GridGroupingGroupBar Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Makes the group bar visible. |
AllowColumnDragDrop | bool | false | Enables column drag and drop. |
AllowColumnCloseButtons | bool | true | Enables column close buttons. |
GridGroupingSummaryRow Properties
Name | Type | Default | Description |
---|---|---|---|
Inline | bool | true | Enables inline display of the group summary row. |
Visible | bool | true | Makes the group summary row visible. |
GridPaging Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Enables pagination. |
Spinner | GridPagingSpinner | new GridPagingSpinner() | Describes the spinner pagination settings. |
PageSize | int | 10 | Sets the number of rows per page. |
PageIndex | int | 0 | Sets the start page. |
GridPagingSpinner Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Enables spinner pagination. |
Step | int | 1 | Sets the step of page |
GridPager Properties
Name | Type | Default | Description |
---|---|---|---|
AutoEllipsis | GridPagerAutoEllipsis | GridPagerAutoEllipsis.Both | Sets the ellipsis display mode. |
Position | LayoutPosition | LayoutPosition.Far | Sets the position of pager. |
Template | object | "" | Sets a template for the pager. |
PageSizeSelector | GridPagerPageSizeSelector | new GridPagerPageSizeSelector() | Describes the settings for the 'rows per page' option. |
Summary | GridPagerSummary | new GridPagerSummary() | Describes the summary settings. |
NavigationButtons | GridPagerNavigationButtons | new GridPagerNavigationButtons() | Describes the navigation buttons settings. |
NavigationInput | GridPagerNavigationInput | new GridPagerNavigationInput() | Describes the settings about navigation input option. |
PageIndexSelectors | GridPagerPageIndexSelectors | new GridPagerPageIndexSelectors() | Describes the settings for the numeric page buttons. |
Visible | bool | false | Sets the visibility of pager. |
GridPagerPageSizeSelector Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the visibility of the 'rows per page' option. |
DataSource | object | "10,20,50" | Sets the count of the 'rows per page' option. |
Position | Position | Position.Far | Sets the position of the 'rows per page' option. |
GridPagerSummary Properties
Name | Type | Default | Description |
---|---|---|---|
Position | Position | Position.Far | Sets the position of the summary. |
Visible | bool | false | Sets the visibility of the summary. |
GridPagerNavigationButtons Properties
Name | Type | Default | Description |
---|---|---|---|
Position | LayoutPosition | LayoutPosition.Both | Sets the navigation buttons position. |
PrevNextButtons | GridPagerNavigationButtonsPrevNextButtons | new GridPagerNavigationButtonsPrevNextButtons() | Describes the settings about buttons 'previous page' and 'next page'. |
FirstLastButtons | GridPagerNavigationButtonsFirstLastButtons | new GridPagerNavigationButtonsFirstLastButtons() | Describes the settings about buttons 'first page' and 'last page'. |
Labels | GridPagerNavigationButtonsLabels | new GridPagerNavigationButtonsLabels() | Describes the labels settings for navigation buttons. |
GridPagerNavigationButtonsPrevNextButtons Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | true | Sets the visibility of 'previous page' and 'next page' buttons. |
GridPagerNavigationButtonsFirstLastButtons Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | true | Sets the visibility of 'first page' and 'last page' buttons. |
GridPagerNavigationButtonsLabels Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the visibility of labels for navigation buttons. |
GridPagerNavigationInput Properties
Name | Type | Default | Description |
---|---|---|---|
Position | Position | Position.Far | Sets the position of navigation input option. |
Visible | bool | false | Sets the visibility of navigation input option. |
GridPagerPageIndexSelectors Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | true | Sets the visibility of numeric page buttons. |
DataSource | object | 10 | Sets the number of visible page buttons. |
GridRowDetail Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Enables the row details. |
Height | int | 200 | Sets the height of the row details. |
Position | Position | Position.Near | Sets the position of the Column which allows you to dynamically expand/collapse the row details. |
Template | object | "" | Sets the template of the row details. |
Visible | bool | true | Sets the visibility of the Column which allows you to dynamically expand/collapse the row details. |
Dialog | Dialog | new Dialog() | Sets the row details dialog. When enabled, row details will be displayed in a Dialog. |
GridColumnHeader Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | true | Sets the column header visibility. |
GridSummaryRow Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the summary row visibility. |
Editing | bool | false | Sets the summary row editor. When you point over a summary row cell, an editor is displayed and you will be able to dynamically change the summary type. |
GridGroupHeader Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the visibility of the group header. |
Template | object | "" | Sets a template for the group header. |
GridHeader Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the header visibility. |
Template | object | "" | Sets a template for the header. |
OnInit | object | null | This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument. |
Buttons | string[] | new string[]{} | Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel. |
GridFooter Properties
Name | Type | Default | Description |
---|---|---|---|
Visible | bool | false | Sets the footer visibility. |
Template | object | "" | Sets a template for the footer. |
GridRow Properties
Name | Type | Default | Description |
---|---|---|---|
AllowToggle | bool | true | Sets or gets the row can be expanded or collapsed. |
AllowResize | bool | true | Sets or gets the row can be resized. |
AllowSelect | bool | true | Sets or gets the row can be selected. |
AllowCheck | bool | true | Sets or gets the row can be checked. This property is used when the Grid is in Tree Grid or Grouped mode. |
Checked | bool | true | Sets or gets the row's check state. This property is used when the Grid is in Tree Grid or Grouped mode. |
Cells | IEnumerable<IGridRowCell> | new List<object>() | Gets the Row's Cells array. |
Children | IEnumerable<object> | null | Gets the row's children array of GridRow. This property is associated to the TreeGrid and Groupng mode of the Grid. |
Data | object | null | Gets the row's bound data. |
DetailHeight | int | 200 | Sets or gets the row's detail height. |
DetailTemplate | object | null | Sets or gets the row's detail template. |
Element | object | null | Gets the HTML Element. The property returns null when the Row is not in the View. |
IsExpanded | bool | false | Sets or gets the row is expanded. This property is used when the Grid is in Tree Grid or Grouped mode. |
Header | object | null | Gets the row's header element. |
Height | int | 30 | Sets or gets the row's height. |
Index | int | -1 | Gets the row's bound index. |
Id | object | "" | Gets the row's bound id. |
Leaf | bool | false | Gets whether the row is leaf row in TreeGrid or Grouping mode. |
MaxHeight | int | 100 | Sets or gets the row's maximum height. |
MinHeight | int | 30 | Sets or gets the row's minimum height. |
Freeze | string | "false" | Sets or gets the Freeze mode. Accepts: 'near', 'far', true and false. Freezes/Pins the row to top(near) or bottom(far). |
Selected | bool | false | Sets or gets whether the row is selected. |
ShowDetail | bool | false | Sets or gets whether the row detail is displayed. |
SetStyle | Action<object> | null | "Method which applies a style object to all cells. Expects a JSON object with the following allowed values: 'background', 'color', 'fontSize', 'fontFamily', 'fontWeight', 'fontStyle', 'textDecoration' |
Visible | bool | true | Sets or gets whether the row is visible. Set the property to 'false' to hide the row. |
VisibleIndex | int | -1 | Gets the visible index of the row. |
GetCell | object | -1 | Methods which gets a cell, which is inside a row. A dataField string is a required argument, when you call this method. |
GridRowCell Properties
Name | Type | Default | Description |
---|---|---|---|
Align | string | "left" | "Sets or gets the horizontal alignment. Allowed values are: 'left', 'center' or 'right'". |
Column | object | null | Gets the column associated to the cell. |
Color | string | "" | Sets or gets the cell's text color. |
Background | string | "" | Sets or gets the cell's background. |
BorderColor | string | "" | Sets or gets the cell's borderColor. |
ColSpan | int | 1 | Sets or gets the cell's colSpan. |
Editor | object | null | Sets or gets the cell's editor. |
Element | object | null | Gets the HTMLElement associated to the cell. |
GetFormattedValue | Action<object> | null | Gets a formatted number or Date. |
IsEditing | bool | false | Gets whether the cell is in edit mode. |
OldValue | object | null | Gets the old value of the cell |
FontSize | string | "" | Sets or gets the cell's fontSize |
FontWeight | string | "" | Sets or gets the cell's fontWeight |
FontFamily | string | "" | Sets or gets the cell's fontFamily |
FontStyle | string | "" | Sets or gets the cell's fontStyle |
Readonly | bool | false | "Sets or gets whether the cell can be edited.". |
Row | object | null | Gets the row object associated to the cell. |
RowSpan | int | 1 | Sets or gets the row span. |
Selected | bool | false | Sets or gets whether the cell is selected. |
SetProperties | Action<object> | null | "Each property is an object{name: string, value: any}. This function allows you to update multiple properties with single refresh.". |
Tooltip | string | "" | "Allowed values are: 'top', 'middle' or 'bottom'". |
Value | object | null | The cell's value |
VerticalAlign | string | "center" | "Sets or gets the vertical alignment. Allowed values are: 'top', 'center' or 'bottom'". |
SetStyle | Action<object> | null | "Method which applies a cell style object. Expects a JSON object with the following possible values: 'background', 'color', 'fontSize', 'fontFamily', 'fontWeight', 'fontStyle', 'textDecoration' |
GridSelection Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Enables the selection option. |
AllowRowHeaderSelection | bool | false | Sets or gets whether selection by clicking on a Row header is allowed. |
AllowColumnHeaderSelection | bool | false | Sets or gets whether selection by clicking on a Column header is allowed. |
AllowRowSelection | bool | true | Sets or gets whether selection by clicking on a Row is allowed. |
AllowCellSelection | bool | false | Sets or gets whether selection by clicking on a cell is allowed. |
AllowDragSelection | bool | true | Sets or gets whether selection by dragging(like in Excel) is allowed. |
AllowDragSelectionAutoScroll | bool | true | Sets or gets whether selection by dragging will automatically scroll the Grid view. |
AllowCellDragSelectionHandle | bool | true | Sets or gets whether the Cells selection bottom-right corner selection 'Drag Handle' (litte square like in Excel) is displayed. That handle allows you to resize the selection horizontally or vertically |
AllowCellDragDropSelectionHandle | bool | true | Sets or gets whether the Cells selection can be dragged and dropped. Drag happens when the cursor is moved to the bottom of the cells selection. The cursor is changed to a drag cursor. Press the button and hold and move the selection. By default the dragged cell values are copied on drop. |
AllowCellDragSelectionAutoFill | bool | true | Sets or gets whether the Cells selection will be auto-filled with values on drop when dragging through the 'Drag Handle'. |
DefaultSelection | bool | false | Sets or gets whether the default browser's text selection is enabled. |
Mode | GridSelectionMode | GridSelectionMode.Many | Sets or gets whether the selection allows you to select 'one', 'many' or a variation of 'many' called 'extended'. 'one' allows you to have only single cell or row selected. 'many' |
Action | GridSelectionAction | GridSelectionAction.Click | Sets or gets whether the selection happens on 'click' or 'doubleClick'. 'none' means that selection can happen only through API. |
CheckBoxes | GridSelectionCheckBoxes | new GridSelectionCheckBoxes() | |
Selected | string | "" |
GridSelectionCheckBoxes Properties
Name | Type | Default | Description |
---|---|---|---|
AutoShow | bool | false | Sets or gets whether the checkboxes are automatically displayed only when the mouse is over the Grid. When false, checkboses are always displayed |
Enabled | bool | false | Sets or gets whether the checkboxes selection is enabled. In that mode a new column with checkboxes is displayed. |
Action | GridSelectionAction | GridSelectionAction.Click | Sets or gets whether the selection happens on 'click' or 'doubleClick'. 'none' means that selection can happen only through API. |
SelectAllMode | GridSelectionCheckBoxesSelectAllMode | GridSelectionCheckBoxesSelectAllMode.Page | Sets or gets whether the checkbox selection selects all rows in the current page or all rows. The 'none' setting disables the header checkbox. |
Position | Position | Position.Near | Sets or gets whether the position of the checkbox selection column. |
GridSorting Properties
Name | Type | Default | Description |
---|---|---|---|
Enabled | bool | false | Enables sorting. |
Sort | string[] | new string[]{} | Sets the sort columns to be sorted. |
Mode | GridSortingMode | GridSortingMode.One | Sets the count of allowed sorting columns. When the property value is set to 'many', users can sort data by multiple columns. |
SortToggleThreeStates | bool | true | Enables switching between the three sort states: ascending, descending and not sorted. |