DxGrid Members
#Properties
Name | Description |
---|---|
Allow |
Specifies whether users can reorder columns. |
Allow |
Specifies whether users can start the row drag operation. |
Allowed |
Specifies allowed drag-and-drop targets. |
Allow |
Specifies whether users can group grid data. |
Allow |
Specifies whether users can select and deselect rows by mouse clicks, tap gestures, and keyboard shortcuts. |
Allow |
Specifies whether users can sort grid data. |
Attributes | Specifies a collection of standard HTML attributes applied to the Grid. |
Auto |
Specifies whether an expanded detail row should be automatically collapsed when a user expands another detail row. |
Auto |
Specifies whether to expand all group rows automatically when the grid loads data or users interact with the grid. |
Column |
Specifies the alignment of all column captions. |
Column |
Specifies a common template used to display all footer cells in the Grid. |
Column |
Specifies a common template for all group footer cells in the Grid. |
Column |
Specifies a common template used to display captions of all column headers in the Grid. |
Column |
Specifies whether and how users can resize Grid columns. |
Columns | Allows you to add Grid columns. |
Css |
Assigns a CSS class to the Grid. |
Custom |
Allows you to declare custom validator components. |
Data | Specifies an object that supplies Grid data. |
Data |
Specifies a common template used to display all data column cells in the Grid. |
Data |
Allows you to replace automatically generated editors with custom content in all edit cells displayed for data columns. |
Data |
Specifies a common template used to display all column filter menus in the Grid. |
Data |
Allows you to replace automatically generated editors with custom content in all filter row cells displayed for data columns. |
Data |
Specifies a common template used to display all group rows in the Grid. |
Detail |
Specifies when to display master-detail expand buttons. |
Detail |
Specifies when to display detail rows in the Grid. |
Detail |
Specifies a template used to display a detail row. |
Drag |
Specifies the template for the drag hint. |
Drop |
Specifies the drop position behavior. Applicable only to drag and drop operations initiated externally. |
Edit |
Specifies whether the edit form contains the predefined Save and Cancel buttons. |
Edit |
Specifies the template used to display the edit form. |
Edit |
Specifies how users edit Grid data. |
Edit |
Specifies the position of UI elements used to create new rows. |
Editor |
Specifies how the Grid renders editors in the filter row and in data rows during edit operations. |
Empty |
Specifies the template used to display an empty data area. |
Filter |
Specifies when the Grid displays filter menu buttons in column headers. |
Focused |
Specifies whether the row focus is enabled. |
Footer |
Specifies when to display the footer in the Grid. |
Group |
Specifies when to display group footers in the Grid. |
Group |
Contains group summary items. |
Highlight |
Specifies whether to highlight a data row when a user hovers the mouse pointer over it. |
Keyboard |
Obsolete. This property is now obsolete because the Grid component activates keyboard navigation and built-in shortcuts by default. Do not use this property in your project. |
Key |
Specifies the name of a data field that contains unique identifiers for Grid data items. |
Key |
Specifies the names of data fields that contain key values. The combination of key values forms a unique identifier for a Grid data item. |
Page |
Specifies the active page index. |
Pager |
Specifies whether arrow navigation buttons are hidden when all numeric buttons are displayed in the pager. |
Pager |
Specifies how users navigate between Grid pages. |
Pager |
Specifies the pager position. |
Pager |
Specifies the number of pages when the pager switches from numeric buttons to the input box in Auto mode. |
Pager |
Specifies whether the Grid displays the pager. |
Pager |
Specifies the maximum number of numeric buttons displayed in the pager. |
Page |
Specifies the maximum number of rows displayed on a page. |
Page |
Specifies whether the page size selector contains the All item. |
Page |
Specifies items available in the page size selector. |
Page |
Specifies whether the Grid displays the page size selector in the pager. |
Popup |
Assigns a CSS class to the pop-up edit form. |
Popup |
Specifies text displayed in the pop-up edit form’s header. |
Search |
Specifies the time interval between the last typed character in the search box and the consequent search text update. |
Search |
Specifies the prompt text displayed in the search box when it is empty. |
Search |
Specifies a template for the search box. |
Search |
Specifies the text that the Grid uses to filter and highlight data. |
Search |
Specifies how the grid treats search words. |
Select |
Specifies whether the Select All checkbox selects all rows on the current page or on all grid pages. |
Selected |
In single selection mode, this property specifies the data item that corresponds to the selected Grid row. |
Selected |
In multiple selection mode, this property specifies data items that corresponds to selected Grid rows. |
Selection |
Specifies selection mode. |
Show |
Specifies whether the Grid displays all rows on one page. |
Show |
Specifies whether the Grid displays the filter row. |
Show |
Specifies whether to display grouped columns with other columns in the grid’s data area. |
Show |
Specifies whether to show the Group Panel. |
Show |
Specifies whether the Grid displays the search box. |
Size |
Specifies the size of grid elements (for instance, text size and row height) and other built-in grid components (for instance, pager and buttons). |
Skeleton |
Specifies whether the Grid displays skeleton rows while it loads data. |
Text |
Specifies whether the Grid wraps words or trims extra words and displays an ellipsis. |
Toolbar |
Specifies a template for a toolbar area. |
Total |
Contains total summary items. |
Validation |
Specifies whether the Grid validates user input in DevExpress data editors located in the edit form or edit cells. |
Virtual |
Specifies whether vertical virtual scrolling is enabled. |
#Methods
Name | Description |
---|---|
Auto |
Adjusts column widths to their content. |
Auto |
Obsolete. Automatically adjusts column widths to their content. |
Begin |
Suspends Grid updates caused by parameter changes and method calls until the End |
Cancel |
Cancels row editing and discards changes. |
Clear |
Clears the filter applied to grid data. |
Clear |
Clears selection. |
Clear |
Clears sorting. |
Collapse |
Collapses all detail rows. |
Collapse |
Collapses all group rows. |
Collapse |
Collapses the specified detail row. |
Collapse |
Collapses a group row with the specified visible index. |
Deselect |
Deselects all rows in the grid. |
Deselect |
Deselects all rows on the current visible page. |
Deselect |
Deselects a row that corresponds to the specified data item. |
Deselect |
Deselects rows that correspond to the specified data items. |
Deselect |
Deselects a row with the specified visible index. |
Deselect |
Deselects rows with the specified visible indexes. |
End |
Resumes Grid updates (when the Begin |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Equals |
Determines whether the specified object is equal to the current object. Inherited from Object. |
Expand |
Expands all group rows. |
Expand |
Expands the specified detail row. |
Expand |
Expands a group row with the specified visible index. |
Export |
Exports grid data to a stream in CSV format. |
Export |
Exports grid data in CSV format and downloads the resulting file to the client machine. |
Export |
Exports grid data to a stream in XLS format. |
Export |
Exports grid data in XLS format and downloads the resulting file to the client machine. |
Export |
Exports grid data in XLSX format to a stream. |
Export |
Exports grid data in XLSX format and downloads the resulting file to the client machine. |
Filter |
Filters grid data by the specified column value. |
Get |
Returns editor settings of the column bound to the specified data source field. |
Get |
Returns a collection of all grid columns. |
Get |
Returns a data column collection. |
Get |
Gets a data source item that is bound to the processed row. |
Get |
Returns the value of the specified field for the specified data item. |
Get |
Returns the edit context. |
Get |
Returns the filter criteria applied to the specified field of the bound data source. |
Get |
Returns the filter criteria applied to the grid data. |
Get |
Returns a data item bound to the focused data row. |
Get |
Returns the visible index of the focused row. |
Get |
Gets the number of grouped columns. |
Get |
Gets a group summary item’s display text. |
Get |
Gets a group summary item’s formatted value. |
Get |
Gets the collection of group summary items. |
Get |
Gets the name of a group summary‘s function name. |
Get |
Gets a group summary item’s value. |
Get |
Serves as the default hash function. Inherited from Object. |
Get |
Returns the total number of pages in the Grid. |
Get |
Gets the nesting level of the processed row. |
Get |
Gets the value of the data source field in the specified row. |
Get |
Gets the collection of sorted columns. |
Get |
Gets the visible index of the first row on the current page. |
Get |
Gets a total summary item’s display text. |
Get |
Gets a total summary item’s formatted value. |
Get |
Gets the collection of total summary items. |
Get |
Gets the name of a total summary‘s function name. |
Get |
Gets a total summary item’s value. |
Get |
Gets the Type of the current instance. Inherited from Object. |
Get |
Returns a collection of visible columns sorted based on their display order. |
Get |
Gets the total number of visible rows in the grid. |
Group |
Groups data by values of the specified column and inserts the grouped column in the specified position between other grouped columns. |
Group |
Groups data by values of the specified column. |
Is |
Identifies whether the row bound to the specified data item is focused. |
Is |
Returns whether the row that corresponds to the specified data item is selected. |
Is |
Indicates whether the specified detail row is expanded. |
Is |
Returns whether the Grid is being edited. |
Is |
Returns whether a new Grid row is being edited. |
Is |
Returns whether the specified Grid row is being edited. |
Is |
Specifies whether the specified row is a group row. |
Is |
Specifies whether the specified group row is expanded. |
Is |
Identifies whether the row with the specified visible index is focused. |
Is |
Returns whether the specified row is selected. |
Load |
Restores the Dx |
Make |
Makes the row bound to the specified data item visible on screen. |
Make |
Makes the row with the specified visible index visible on screen. |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Refresh |
Refreshes all total and group summary values in the grid. |
Reload() | Reloads Grid data. |
Save |
Triggers validation and raises the Edit |
Save |
Saves information about the Dx |
Select |
Selects or deselects all rows in the grid. |
Select |
Selects or deselects all rows on the current visible page. |
Select |
Selects or deselects a row that corresponds to the specified data item. |
Select |
Selects or deselects rows that correspond to the specified data items. |
Select |
Selects or deselects a row with the specified visible index. |
Select |
Selects or deselects rows with the specified visible indexes. |
Set |
Applies a filter to the specified data field. |
Set |
Applies a filter to grid data. |
Set |
Moves focus to the row bound to the specified data item. |
Set |
Moves focus to the row with the specified visible index. |
Show |
Shows the column chooser in the center of the grid. |
Show |
Shows the column chooser and positions it based on the specified display options. |
Show |
Shows the column chooser below the specified target element. |
Show |
Displays the delete confirmation dialog for the specified data item. If a user confirms the operation, the method raises the Data |
Show |
Displays the delete confirmation dialog for the specified row. If a user confirms the operation, the method raises the Data |
Sort |
Sorts data by column values in the specified order, and specifies the sorted column’s index. |
Sort |
Sorts data by column values in the specified order. |
Sort |
Sorts data by the specified column values. |
Start |
Starts editing the specified data item. |
Start |
Starts editing a new row. |
Start |
Starts editing the row with the specified visible index. |
To |
Returns a string that represents the current object. Inherited from Object. |
Wait |
Returns a task that completes when pending asynchronous data load operations are completed. |
Wait |
Obsolete. Returns a task that is completed when the specified row of an asynchronous Instant Feedback Data Source is loaded. |
Wait |
Returns a task that is completed when the specified row of an asynchronous remote data source is loaded. |
#Events
Name | Description |
---|---|
Custom |
Enables you to implement custom logic used to group data in the grid. |
Customize |
Allows you to customize text displayed within a cell. |
Customize |
Allows you to customize a cell editor in a data row. |
Customize |
Allows you to create a custom edit model or customize an automatically generated edit model. |
Customize |
Allows you to customize grid elements. |
Customize |
Allows you to customize column filter menu items. |
Customize |
Allows you to customize a cell editor in the filter row. |
Customize |
Allows you to customize the group value’s display text. |
Customize |
Allows you to customize the summary display text. |
Custom |
Allows you to implement custom logic used to sort data in the grid. |
Custom |
Allows you to create custom summary items. |
Data |
Fires when a user confirms the delete operation in the delete confirmation dialog. |
Edit |
Fires before the Grid cancels the edit operation and discards changes. |
Edit |
Fires if validation succeeds after a user saves changes or you call the Save |
Edit |
Fires before the Grid starts editing a row. |
Filter |
Fires when filter criteria applied to grid data change. |
Focused |
Fires when the row focus changes. |
Items |
Fires when a user drops rows onto the Grid. |
Layout |
Fires when the Dx |
Layout |
Fires when the grid’s layout changes. |
Page |
Fires when the grid’s active page index changes. |
Page |
Fires when the page size changes. |
Row |
Fires when a user clicks or taps a grid row or focuses a data cell and presses Enter. |
Row |
Fires when a user double clicks a grid row. |
Search |
Fires when the search text changes. |
Selected |
In single selection mode, fires when another Grid row is selected. |
Selected |
In multiple selection mode, fires when the selection in the Grid changes. |
Show |
Fires when the Show |
Unbound |
Allows you to implement custom logic to obtain unbound column values. |