GridPersistentLayout Class
Contains information about a DxGrid layout.
Namespace: DevExpress.Blazor
Assembly: DevExpress.Blazor.Grid.v26.1.dll
NuGet Package: DevExpress.Blazor
Declaration
public class GridPersistentLayout :
GridPersistentLayoutBase,
IEquatable<GridPersistentLayout>Related API Members
The following members return GridPersistentLayout objects:
Remarks
A GridPersistentLayout object stores the following Grid layout settings:
| Saved Information | Grid Property | GridPersistentLayout Property |
|---|---|---|
| Current page index | DxGrid.PageIndex | Layout.PageIndex |
| Page size | DxGrid.PageSize | Layout.PageSize |
| Single-page or multi-page data display | DxGrid.ShowAllRows | Layout.ShowAllRows |
| Search text | DxGrid.SearchText | Layout.SearchText |
| Filter values | Grid column filter criteria[1] joined by AND operators |
Layout.FilterCriteria |
| Individual column settings (refer to the table below) | - | Layout.Columns.Item(i) |
Important
DevExpress components can incorrectly serialize custom enumeration values in criteria operators. Refer to the following troubleshooting topic for additional information: The XXX enumeration type is not registered for the parse operation…
The GridPersistentLayout.Columns collection stores information about column layout settings. Each collection item (GridPersistentLayoutColumn) includes the following data:
| Saved Information | Column Property | GridPersistentLayoutColumn Property |
|---|---|---|
| Column type | A column type defined in the markup: data, band, command, or selection | LayoutColumn.ColumnType |
| Data field name | DxGridColumn.FieldName | LayoutColumn.FieldName |
| Group index (does not include group expand states) | DxGridColumn.GroupIndex | LayoutColumn.GroupIndex |
| Sort index | DxGridColumn.SortIndex | LayoutColumn.SortIndex |
| Sort direction | DxGridColumn.SortOrder | LayoutColumn.SortOrder |
| Position | DxGridColumn.VisibleIndex | LayoutColumn.VisibleIndex |
| Visibility | DxGridColumn.Visible | LayoutColumn.Visible |
| Width | DxGridColumn.Width | LayoutColumn.Width |
Refer to the following topic for information on how to use this object to save Grid layout settings: Save and Restore Layout in Blazor Grid.
Implements
Inheritance
-
Filter criteria can be applied to grid data in the following ways:
- Filter row and filter menu UI elements.
- SetFilterCriteria and SetFieldFilterCriteria methods.
Use the GetFilterCriteria() method to obtain all filter criteria, whether applied in code or using the component’s filter UI.