DataControlSerializationOptions Class
Contains options that specify how column specific settings are stored to and restored from a stream or file in XML format.
Namespace: DevExpress.Xpf.Grid
Assembly: DevExpress.Xpf.Grid.v18.2.Core.dll
Declaration
public class DataControlSerializationOptions
Public Class DataControlSerializationOptions
The DataControlSerializationOptions provides two options: DataControlSerializationOptions.AddNewColumns and DataControlSerializationOptions.RemoveOldColumns. The first option specifies whether the columns that currently exist in the grid, but do not exist in a layout when it is restored, should be retained. The second option specifies whether the columns that exist in a layout when it is restored but do not currently exist in the grid, should be discarded.
To save the grid layout, use the DataControlBase.SaveLayoutToStream or DataControlBase.SaveLayoutToXml method. To load the layout, use the DataControlBase.RestoreLayoutFromStream or DataControlBase.RestoreLayoutFromXml method.
To learn more, see Saving and Restoring Layout.
Note
To correctly save and restore the grid layout, grid columns should be uniquely identified, using the x:Name attribute.
Example
This example shows how to save the grid layout to a memory stream. To do this, click the ‘Save Layout’ button. Once saved, the grid layout can then be restored by clicking the ‘Restore Layout’ button.
using System.Collections.Generic;
using System.Windows;
using System.Windows.Documents;
namespace DXGrid_GridLayout {
public partial class Window1 : Window {
public Window1() {
InitializeComponent();
}
}
}
<Window x:Class="DXGrid_GridLayout.Window1"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
xmlns:local="clr-namespace:DXGrid_GridLayout"
Title="Window1" Height="300" Width="442">
<Grid>
<local:MainPage/>
</Grid>
</Window>
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using System.IO;
namespace DXGrid_GridLayout {
public partial class MainPage : UserControl {
public static readonly DependencyProperty IsLayoutSavedProperty =
DependencyProperty.Register("IsLayoutSaved", typeof(bool), typeof(MainPage), null);
public bool IsLayoutSaved {
get { return (bool)GetValue(IsLayoutSavedProperty); }
set { SetValue(IsLayoutSavedProperty, value); }
}
MemoryStream layoutStream;
public MainPage() {
DataContext = this;
InitializeComponent();
IsLayoutSaved = false;
grid.ItemsSource = IssueList.GetData();
}
private void SaveButton_Click(object sender, RoutedEventArgs e) {
layoutStream = new MemoryStream();
grid.SaveLayoutToStream(layoutStream);
IsLayoutSaved = true;
}
private void LoadButton_Click(object sender, RoutedEventArgs e) {
layoutStream.Position = 0;
grid.RestoreLayoutFromStream(layoutStream);
}
private void Button_Click(object sender, RoutedEventArgs e) {
grid.Columns.Add(new DevExpress.Xpf.Grid.GridColumn() { FieldName = "IsPrivate" });
}
}
public class IssueList {
static public List<IssueDataObject> GetData() {
List<IssueDataObject> data = new List<IssueDataObject>();
data.Add(new IssueDataObject() {
IssueName = "Transaction History",
IssueType = "Bug", IsPrivate = true
});
data.Add(new IssueDataObject() {
IssueName = "Ledger: Inconsistency",
IssueType = "Bug", IsPrivate = false
});
data.Add(new IssueDataObject() {
IssueName = "Data Import",
IssueType = "Request", IsPrivate = false
});
data.Add(new IssueDataObject() {
IssueName = "Data Archiving",
IssueType = "Request", IsPrivate = true
});
return data;
}
}
public class IssueDataObject {
public string IssueName { get; set; }
public string IssueType { get; set; }
public bool IsPrivate { get; set; }
}
}
<UserControl x:Class="DXGrid_GridLayout.MainPage"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
mc:Ignorable="d"
d:DesignHeight="300" d:DesignWidth="400"
xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
xmlns:local="clr-namespace:DXGrid_GridLayout" >
<Grid>
<Grid.RowDefinitions>
<RowDefinition Height="*" />
<RowDefinition Height="Auto" />
</Grid.RowDefinitions>
<dxg:GridControl x:Name="grid" dx:DXSerializer.SerializationID="grid"
dx:DXSerializer.StoreLayoutMode="All"
dxg:GridSerializationOptions.AddNewColumns="False"
dxg:GridSerializationOptions.RemoveOldColumns="False">
<dxg:GridControl.Columns>
<dxg:GridColumn x:Name="colIssueName" FieldName="IssueName" />
<dxg:GridColumn x:Name="colIssueType" FieldName="IssueType" />
<dxg:GridColumn x:Name="colPrivate" FieldName="IsPrivate">Private</dxg:GridColumn>
</dxg:GridControl.Columns>
<dxg:GridControl.View>
<dxg:TableView AutoWidth="True" />
</dxg:GridControl.View>
</dxg:GridControl>
<StackPanel Grid.Row="1" Orientation="Vertical">
<StackPanel Orientation="Horizontal">
<Button Margin="1" Click="Button_Click">AddNewColumn</Button>
</StackPanel>
<StackPanel Orientation="Horizontal">
<Button Margin="1" Click="SaveButton_Click">Save Layout</Button>
<Button x:Name="restoreButton" Margin="1" Click="LoadButton_Click" IsEnabled="{Binding IsLayoutSaved}">
Restore Layout
</Button>
</StackPanel>
</StackPanel>
</Grid>
</UserControl>
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Net
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Documents
Imports System.Windows.Input
Imports System.Windows.Media
Imports System.Windows.Media.Animation
Imports System.Windows.Shapes
Imports System.IO
Namespace DXGrid_GridLayout
Partial Public Class MainPage
Inherits UserControl
Public Shared ReadOnly IsLayoutSavedProperty As DependencyProperty = DependencyProperty.Register("IsLayoutSaved", GetType(Boolean), GetType(MainPage), Nothing)
Public Property IsLayoutSaved() As Boolean
Get
Return DirectCast(GetValue(IsLayoutSavedProperty), Boolean)
End Get
Set(ByVal value As Boolean)
SetValue(IsLayoutSavedProperty, value)
End Set
End Property
Private layoutStream As MemoryStream
Public Sub New()
DataContext = Me
InitializeComponent()
IsLayoutSaved = False
grid.ItemsSource = IssueList.GetData()
End Sub
Private Sub SaveButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
layoutStream = New MemoryStream()
grid.SaveLayoutToStream(layoutStream)
IsLayoutSaved = True
End Sub
Private Sub LoadButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
layoutStream.Position = 0
grid.RestoreLayoutFromStream(layoutStream)
End Sub
Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
grid.Columns.Add(New DevExpress.Xpf.Grid.GridColumn() With {.FieldName = "IsPrivate"})
End Sub
End Class
Public Class IssueList
Public Shared Function GetData() As List(Of IssueDataObject)
Dim data As New List(Of IssueDataObject)()
data.Add(New IssueDataObject() With {.IssueName = "Transaction History", .IssueType = "Bug", .IsPrivate = True})
data.Add(New IssueDataObject() With {.IssueName = "Ledger: Inconsistency", .IssueType = "Bug", .IsPrivate = False})
data.Add(New IssueDataObject() With {.IssueName = "Data Import", .IssueType = "Request", .IsPrivate = False})
data.Add(New IssueDataObject() With {.IssueName = "Data Archiving", .IssueType = "Request", .IsPrivate = True})
Return data
End Function
End Class
Public Class IssueDataObject
Public Property IssueName() As String
Public Property IssueType() As String
Public Property IsPrivate() As Boolean
End Class
End Namespace
Imports System.Collections.Generic
Imports System.Windows
Imports System.Windows.Documents
Namespace DXGrid_GridLayout
Partial Public Class Window1
Inherits Window
Public Sub New()
InitializeComponent()
End Sub
End Class
End Namespace
Inheritance
ObjectDataControlSerializationOptions
See Also