State Persistence in ASP.NET MVC

4 Dec 20241 minute to read

The Syncfusion^® ASP.NET MVC library supports persisting a control’s state across page refreshes or navigation. To enable this feature, set enablePersistence property as true to the required control. This will store the control’s state in browser’s localStorage object on page unload event.

CSHTML

@Html.EJS().Grid("check").DataSource(dataManger =>
   {
       dataManger.Url("http://services.odata.org/V4/Northwind/Northwind.svc/Products").CrossDomain(true).Adaptor("ODataV4Adaptor");
   }).Columns(col =>
        {
            col.Field("ProductID").HeaderText("Product ID").Width("120").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
            col.Field("ProductName").HeaderText("Product Name").Width("150").Add();
            col.Field("UnitPrice").HeaderText("Supplier ID").Width("130").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
            col.Field("UnitsInStock").HeaderText("QuantityPerUnit").Width("120").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
            col.Field("Discontinued").HeaderText("Discontinued").Width("140").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Center).Type("boolean").DisplayAsCheckBox(true).Add();
        })
        .EnablePersistence()
        .AllowPaging()
        .PageSettings(page=>page.PageCount(5))
        .Render()

State Persistence Supported controls and Properties

The following table demonstrates the list of Syncfusion^® ASP.NET MVC controls that are supported with state persistence and describes the list of properties stored in the localStorage.

control Name	Properties
Grid	Columns filterSettings searchSettings groupSettings pageSettings selectedRowIndex scrollPosition
Accordion	expandedIndices
Tabs	selectedItem
Schedule	currentView selectedDate scrollLeft scrollTop
Kanban	columns dataSource swimlaneToggleArray
Chart	zoomFactor zoomPosition
Maps	zoomSettings
Pivot Table	dataSourceSettings pivotValues gridSettings chartSettings displayOption
TreeGrid	columns pageSettings searchSettings filterSettings selectedRowIndex sortSettings
Switch	checked
Checkbox	checked
RadioButton	checked value
ColorPicker	value
ListBox	value
QueryBuilder	rule
In-placeEditor	value
RichTextEditor	value
Splitter	paneSettings
Autocomplete	value
Calendar	value
ComboBox	value
DatePicker	value
DropDownList	value
MaskedTextBox	value
NumericTextBox	value
Textbox	value
TimePicker	value
Multiselect	value
DateTimePicker	value
DateRangePicker	startDate endDate value
Uploader	filesData
Slider	value
ListView	cssClass enableRtl htmlAttributes enable fields animation headerTitle sortOrder showIcon height width showCheckBox checkBoxPosition
TreeView	selectedNodes checkedNodes expandedNodes
Dashboard Layout	panels
File Manager	view path selectedItems
Sidebar	type position isOpen
Dropdown Tree	value