VerticalGridToolbarItem.Command Property
Gets or sets the name of a command executed when clicking a toolbar item.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v24.1.dll
NuGet Package: DevExpress.Web
Declaration
[DefaultValue(VerticalGridToolbarCommand.Custom)]
public VerticalGridToolbarCommand Command { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| VerticalGridToolbarCommand | Custom | One of the VerticalGridToolbarCommand enumeration values specifying the toolbar item’s command name. |
Available values:
| Name | Description |
|---|---|
| Custom | A custom user command. |
| ClearSorting | A command that clears sorting by the current column. |
| ClearFilter | A command that clears the filter applied to the current column. |
| ShowFilterEditor | A command that controls the filter control visibility. |
| ShowSearchPanel | A command that controls the search panel visibility. |
| ShowSummaryPanel | A command that controls the summary panel visibility. |
| Refresh | A command that refreshes grid data. |
| New | A command that creates a new record. |
| Edit | A command that allows editing the current record. |
| Delete | A command that deletes the current record. |
| DeleteSelectedRecordsOnPage | A command that deletes the selected records on the page. |
| Update | A command that saves all the changes made to the current record and switches the ASPxVerticalGrid to browse mode. |
| Cancel | A command that discards any changes made to the current record and switches the ASPxVerticalGrid to browse mode. |
| UpdateSummaries | A command that recalculates total and group summaries on the client in batch edit mode. |
| ExportToPdf | A command that exports the grid’s data to a file in PDF format. |
| ExportToDocx | A command that exports the grid’s data to a file in DOCX format. |
| ExportToRtf | A command that exports the grid’s data to a file in RTF format. |
| ExportToCsv | A command that exports the grid’s data to a file in CSV format. |
| ExportToXls | A command that exports the grid’s data to a file in XLS format. |
| ExportToXlsx | A command that exports the grid’s data to a file in XLS format. |
Remarks
Use the Command property to specify a command that will be executed when a toolbar item is clicked.
Note
The ASPxGridBase.KeyFieldName property should be specified when using the following grid features:
- data editing;
- adding new and deleting existing record;
- selecting record;