GridViewToolbarItem.Command Property
Gets or sets the name of a command executed when users click a toolbar item.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v21.2.dll
Declaration
[DefaultValue(GridViewToolbarCommand.Custom)]
public GridViewToolbarCommand Command { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| GridViewToolbarCommand | Custom |
One of the GridViewToolbarCommand enumeration values specifying the toolbar item’s command name. |
Available values:
| Name | Description |
|---|---|
| Custom | A custom user command. |
| FullExpand | A command that expands all rows. |
| FullCollapse | A command that collapses all rows. |
| 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. |
| ShowFilterRow | A command that controls the filter row visibility. |
| ShowFilterRowMenu | A command that controls the filter row menu visibility. |
| ClearGrouping | A command that clears the grouping in the grid’s group panel. |
| ShowGroupPanel | A command that controls the group panel visibility. |
| ShowSearchPanel | A command that controls the search panel visibility. |
| ShowCustomizationWindow | A command that controls the Column Chooser visibility. |
| ShowFooter | A command that controls the footer visibility. |
| ShowCustomizationDialog | A command that controls the Customization Dialog visibility. |
| Refresh | A command that refreshes grid data. |
| New | A command that creates a new row. |
| Edit | A command that allows editing the current row. |
| Delete | A command that deletes the current row. |
| DeleteSelectedRowsOnPage | A command that deletes the selected rows on the page. |
| Update | A command that saves all the changes made to the current data row and switches the ASPxGridView to browse mode. |
| Cancel | A command that discards any changes made to the current row and switches the ASPxGridView to browse mode. |
| PreviewChanges | A command that displays the changed preview information when the control is in batch edit mode. |
| HidePreview | A command that hides the preview when the control is in batch edit mode. |
| UpdateSummaries | A command that recalculates total and group summaries on the client in batch edit mode. |
| ExpandRow | A command that expands the row. |
| CollapseRow | A command that collapses the row. |
| ExpandDetailRow | A command that expands the detail row. |
| CollapseDetailRow | A command that collapses the detail row. |
| 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 XLSX 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 data item;
- selecting data item;
- master-detail view;
- endless paging.
Concept
Example
Web Forms:
Note
For a full example, see the ASPxGridView - Customization Dialog demo.
<dx:ASPxGridView ID="Grid" runat="server" DataSourceID="ProductsDataSource" EnableRowsCache="false" Width="100%">
<Columns>
...
</Columns>
<SettingsCustomizationDialog Enabled="true" />
<Toolbars>
<dx:GridViewToolbar Position="Top" ItemAlign="Right">
<Items>
<dx:GridViewToolbarItem Command="ShowCustomizationDialog" />
</Items>
</dx:GridViewToolbar>
</Toolbars>
</dx:ASPxGridView>
MVC:
@Html.DevExpress().GridView(
settings =>
{
settings.Name = "grid";
settings.KeyFieldName = "PersonID";
settings.CallbackRouteValues = new { Controller = "Home", Action = "GridViewEditingPartial" };
settings.SettingsEditing.AddNewRowRouteValues = new { Controller = "Home", Action = "EditingAddNew" };
settings.SettingsEditing.UpdateRowRouteValues = new { Controller = "Home", Action = "E