Serialization Support in WPF GridControl

Essential GridControl supports Serialization. The whole grid can be serialized and deserialized at run-time.

Use Case Scenarios

Serialization can be implemented for the applications which need to save its data and structure after the application is closed. Serialization supports to save the structure and data of the GridControl to an XML file and it can be loaded at any time.

Adding Serialization to an Application

The following sample application explains the implementation of the Serialization support to GirdControl.

  1. Create an application. Create a WPF application and add the GridControl to it.
  2. Call the Serialization support methods

    In the application, create three buttons. The first button to call the Serialize() method, the second button to make changes to the Grid and the third button is to call the Deserialize() method. The following code snippet explains the implementation of Serialization.

// To Serialize the GridControl.
this.grid.Model.Serialize("Data.xml");

// To Deserialize the GridControl.
this.grid.Model.Deserialize("Data.xml");

3.Run the application

Run the application. Click the Serialize button to serialize the initial load; this creates an XML file and saves it. Click the second button ModifyGridStyle to make some changes in the GridControl. Now click the Deserialize button which restores the old settings of the GridControl.

Supported Properties for Serialization

The following properties are Serialized in the GridControl.

  • RowCount
  • ColCount
  • ActivateCurrentCellBehavior
  • AllowSelection
  • AllowSelectionOnShiftTab
  • ColumnSizer
  • CurrentCellBorder
  • CurrentCellBorderWidth
  • DataObjectConsumerOptions
  • DrawSelectionOptions
  • ExcelLikeCurrentCell
  • ExcelLikeSelectionFrame
  • HighlightSelectionBorder
  • HighlightSelectionBorderWidth
  • ListBoxModeAllowUIElementClick
  • ListBoxSelectionMode
  • MaxLength
  • ScrollFrozen
  • ShowCurrentCell
  • WrapCell
  • WrapCellBehavior

Methods

Method Description Parameters Type Return Type
Serialize() A virtual method called to Serialize the GridControl. It stores the settings in an XML file named as specified in its parameter. string  fileName public void
Deserialize() A virtual method called to Deserialize the GridControl. It restores the settings in an XML file named as specified in its parameter. string  fileName public void
SerializeToStream() Serializes the Grid to Stream. TextWriter textWriter public  void
SerializeAsString() Serialize the Grid as String. NA public string 
DeserializeFromStream Deserialize from the given TextReader. TextReader textReader public void
DeserializeFromString Deserialize from the given String content. string content public void
  1. Refer to the samples in the shipped Sample Browser.
  2. Go to Essential Studio WPF Sample Browser Grid Serialization GridControl Serialization Demo