Class TreeGridSerializationController

Represents a controller that is used to perform serialize and deserialize operations in SfTreeGrid using DataContractSerializer.

Inheritance

System.Object

TreeGridSerializationController

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.UI.Xaml.TreeGrid

Assembly: Syncfusion.SfGrid.WPF.dll

Syntax

public class TreeGridSerializationController : IDisposable

Constructors

TreeGridSerializationController(SfTreeGrid)

Initializes a new instance of TreeGridSerializationController class.

Declaration

public TreeGridSerializationController(SfTreeGrid treeGrid)

Parameters

Type	Name	Description
SfTreeGrid	treeGrid	The SfTreeGrid.

Properties

TreeGrid

Gets the reference to the SfTreeGrid control.

Declaration

public SfTreeGrid TreeGrid { get; }

Property Value

Type
SfTreeGrid

Methods

Deserialize(Stream, TreeGridDeserializationOptions)

Deserializes the SfTreeGrid from the given XML stream based on the specified DeserializationOptions.

Declaration

public virtual void Deserialize(Stream stream, TreeGridDeserializationOptions deserializeOptions)

Parameters

Type	Name	Description
System.IO.Stream	stream	Contains the XML document to deserialize.
TreeGridDeserializationOptions	deserializeOptions	Specifies the TreeGridDeserializationOptions to decide the type of treegrid operations such as sorting ,filtering ,and etc to be deserialized.

Dispose()

Releases all the resources used by the SerializationController class.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the SerializationController class.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

GetSerializableTreeGridColumn(TreeGridColumn)

Gets the SerializableTreeGridColumn instance while serializing the SfTreeGrid.

Declaration

protected virtual SerializableTreeGridColumn GetSerializableTreeGridColumn(TreeGridColumn column)

Parameters

Type	Name	Description
TreeGridColumn	column	The corresponding column to get serializable treegrid column.

Returns

Type	Description
SerializableTreeGridColumn	Returns the SerializableTreeGridColumn instance for the specified treegrid column

Remarks

You can use this method while serializing the custom column.

GetTreeGridColumn(SerializableTreeGridColumn)

Gets the TreeGridColumn from the SerializableTreeGridColumn during deserialization process.

Declaration

protected virtual TreeGridColumn GetTreeGridColumn(SerializableTreeGridColumn serializableColumn)

Parameters

Type	Name	Description
SerializableTreeGridColumn	serializableColumn	The serializable column to get its treegrid column.

Returns

Type	Description
TreeGridColumn	Returns the TreeGridColumn.

Remarks

Override this method to get the custom column during deserialization process.

KnownTypes()

Gets the known column types to serialize and deserialize the columns in SfTreeGrid.

Declaration

public virtual Type[] KnownTypes()

Returns

Type
System.Type[]

ReloadTreeGrid(SerializableTreeGrid, TreeGridDeserializationOptions)

Reloads the treegrid properties from the SerializableTreeGrid with the specified DeserializationOptions during deserialization.

Declaration

protected virtual void ReloadTreeGrid(SerializableTreeGrid treeGrid, TreeGridDeserializationOptions deserializationOptions)

Parameters

Type	Name	Description
SerializableTreeGrid	treeGrid	The corresponding SerializableTreeGrid to restore the treegrid settings.
TreeGridDeserializationOptions	deserializationOptions	The deserialization options.

RestoreColumnFilterPredicates(Object)

Restores the column filter predicates from the TreeGrid filter predicates or serializable TreeGrid filter settings.

Declaration

protected virtual void RestoreColumnFilterPredicates(dynamic treeGridFilterSettings)

Parameters

Type	Name	Description
System.Object	treeGridFilterSettings	The corresponding TreeGrid filter settings for deserializing filter predicates.

RestoreColumnProperties(SerializableTreeGridColumn, TreeGridColumn)

Restores the treegrid column properties from the specified SerializableTreeGridColumn to the TreeGridColumn during deserialization.

Declaration

protected virtual void RestoreColumnProperties(SerializableTreeGridColumn serializableColumn, TreeGridColumn column)

Parameters

Type	Name	Description
SerializableTreeGridColumn	serializableColumn	The corresponding SerializableTreeGridColumn to restore the treegrid column properties.
TreeGridColumn	column	The corresponding column to restore its properties for deserialization.

RestoreFilterPredicates(SerializableTreeGrid, TreeGridDeserializationOptions)

Restores the filter predicates from SerializableTreeGrid with the specified DeserializationOptions during deserialization.

Declaration

protected virtual void RestoreFilterPredicates(SerializableTreeGrid serializableTreeGrid, TreeGridDeserializationOptions options)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	The corresponding SerializableTreeGrid to restore the filter predicates.
TreeGridDeserializationOptions	options	Specifies the options for deserializing the filter predicates.

RestoreSortColumnDescriptions(SerializableTreeGrid, TreeGridDeserializationOptions)

Restores the sort column descriptions settings from the SerializableTreeGrid with the specified DeserializationOptions during deserialization.

Declaration

protected virtual void RestoreSortColumnDescriptions(SerializableTreeGrid serializableTreeGrid, TreeGridDeserializationOptions options)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	The serializable TreeGrid to deserialize the sort column descriptions.
TreeGridDeserializationOptions	options	Specifies the options for deserializing the sort column descriptions.

RestoreTreeGridColumns(SerializableTreeGrid, TreeGridDeserializationOptions)

Restores the treegrid columns from the SerializableTreeGrid with the specified DeserializationOptions during deserialization process.

Declaration

protected virtual void RestoreTreeGridColumns(SerializableTreeGrid serializableTreeGrid, TreeGridDeserializationOptions options)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	Restores the columns settings from the SerializableTreeGrid.
TreeGridDeserializationOptions	options	Contains the deserialization options.

RestoreTreeGridProperties(SerializableTreeGrid)

Restores treegrid properties from the specified SerializableTreeGrid.

Declaration

protected virtual void RestoreTreeGridProperties(SerializableTreeGrid serializableTreeGrid)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	The corresponding serializable TreeGrid to restore TreeGrid properties for deserialization.

RestoreTreeGridSettings(SerializableTreeGrid, SfTreeGrid, TreeGridDeserializationOptions)

Restores the SfTreeGrid settings from the SerializableTreeGrid with the specified DeserializationOptions during deserialization process.

Declaration

protected virtual void RestoreTreeGridSettings(SerializableTreeGrid serializableTreeGrid, SfTreeGrid treeGrid, TreeGridDeserializationOptions options)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	The corresponding serializable TreeGrid to restore the tree grid settings.
SfTreeGrid	treeGrid	The corresponding SfTreeGrid to deserialize its settings.
TreeGridDeserializationOptions	options	Specifies the TreeGridDeserializationOptions for deserializing the treegrid settings.

RestoreTreeGridStackedHeaderRows(SerializableTreeGrid, TreeGridDeserializationOptions)

Restores the stacked header rows settings from the SerializableTreeGrid with the specified DeserializationOptions during deserialization.

Declaration

protected virtual void RestoreTreeGridStackedHeaderRows(SerializableTreeGrid serializableTreeGrid, TreeGridDeserializationOptions options)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	The corresponding serializable TreeGrid to restore the treegrid settings.
TreeGridDeserializationOptions	options	Specifies the TreeGridDeserializationOptions for deserializing the treegrid settings.

Serialize(Stream, TreeGridSerializationOptions)

Serializes the SfTreeGrid to the given XML stream based on the specified SerializationOptions.

Declaration

public virtual void Serialize(Stream stream, TreeGridSerializationOptions serializeOptions)

Parameters

Type	Name	Description
System.IO.Stream	stream	Specifies stream used to write XML document file.
TreeGridSerializationOptions	serializeOptions	Specifies the TreeGridDeserializationOptions to decide the type of operations such as sorting ,filtering ,and etc to be serialized.

StoreFilterPredicates(SfTreeGrid, TreeGridSerializationOptions)

Stores the filter predicates to SerializableFilterSettings with the specified SerializationOptions during serialization process.

Declaration

protected virtual SerializableFilterSettings StoreFilterPredicates(SfTreeGrid treeGrid, TreeGridSerializationOptions serializeOptions)

Parameters

Type	Name	Description
SfTreeGrid	treeGrid	The corresponding SfTreeGrid to serialize the filter predicates settings.
TreeGridSerializationOptions	serializeOptions	The corresponding serialization options.

Returns

Type	Description
SerializableFilterSettings	Returns the SerializableFilterSettings that contains the specified filter predicates in SfTreeGrid.

StoreSortColumnDescriptions(SfTreeGrid, TreeGridSerializationOptions)

Stores the sort column descriptions to SerializableSortColumnDescriptions with the specified SerializationOptions during serialization process.

Declaration

protected virtual SerializableSortColumnDescriptions StoreSortColumnDescriptions(SfTreeGrid treeGrid, TreeGridSerializationOptions serializeOptions)

Parameters

Type	Name	Description
SfTreeGrid	treeGrid	The corresponding SfTreeGrid to serialize its sort column descriptions property settings.
TreeGridSerializationOptions	serializeOptions	The corresponding serialization options.

Returns

Type	Description
SerializableSortColumnDescriptions	Returns the SerializableSortColumnDescriptions that contains the specified sort column descriptions in SfTreeGrid.

StoreTreeGridColumnProperties(TreeGridColumn, SerializableTreeGridColumn)

Stores the treegrid column properties to the specified SerializableTreeGridColumn during serialization process.

Declaration

protected virtual void StoreTreeGridColumnProperties(TreeGridColumn column, SerializableTreeGridColumn serializableTreeGridColumn)

Parameters

Type	Name	Description
TreeGridColumn	column	The corresponding column to store it property settings for serialization.
SerializableTreeGridColumn	serializableTreeGridColumn	The corresponding SerializableTreeGridColumn where the column properties are stored.

StoreTreeGridColumns(SfTreeGrid, TreeGridSerializationOptions)

Stores the columns settings of SfTreeGrid to SerializableTreeGridColumns with the specified SerializationOptions during serialization process.

Declaration

protected virtual SerializableTreeGridColumns StoreTreeGridColumns(SfTreeGrid treeGrid, TreeGridSerializationOptions serializeOptions)

Parameters

Type	Name	Description
SfTreeGrid	treeGrid	The corresponding treeGrid to store its columns settings for serialization.
TreeGridSerializationOptions	serializeOptions	The corresponding serialization options.

Returns

Type	Description
SerializableTreeGridColumns	Returns the SerializableTreeGridColumns that contains the specified property settings of columns.

StoreTreeGridProperties(SerializableTreeGrid)

Stores the SfTreeGrid properties during serialization process.

Declaration

protected virtual void StoreTreeGridProperties(SerializableTreeGrid serializableTreeGrid)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	The corresponding SerializableTreeGrid to store SfTreeGrid properties settings.

StoreTreeGridSettings(TreeGridSerializationOptions)

Stores the SfTreeGrid settings with the specified SerializationOptions to SerializableTreeGrid.

Declaration

protected virtual SerializableTreeGrid StoreTreeGridSettings(TreeGridSerializationOptions serializeOptions)

Parameters

Type	Name	Description
TreeGridSerializationOptions	serializeOptions	Specifies the serialization options to store treegrid settings.

Returns

Type	Description
SerializableTreeGrid	Returns the SerializableTreeGrid with treegrid settings.

StoreTreeGridStackedHeaderRow(SerializableTreeGrid, StackedHeaderRows, TreeGridSerializationOptions)

Stores the stacked header settings to the SerializableTreeGrid during serialization process.

Declaration

protected virtual void StoreTreeGridStackedHeaderRow(SerializableTreeGrid serializableTreeGrid, StackedHeaderRows stackedHeaderRows, TreeGridSerializationOptions serializeOptions)

Parameters

Type	Name	Description
SerializableTreeGrid	serializableTreeGrid	The corresponding serializable TreeGrid to store the treegrid stacked header rows.
StackedHeaderRows	stackedHeaderRows	The corresponding stacked header rows that need to be copied to serializable TreeGrid for serialization.
TreeGridSerializationOptions	serializeOptions	The corresponding serialization options.

UnWireSerializablePropertyEvents()

Unwires the events associates with the serializable property.

Declaration

protected virtual void UnWireSerializablePropertyEvents()

Implements

System.IDisposable