Skip to main content
All docs
V24.1

DXSerializer Members

Allows the DevExpress WPF Controls to save/restore their layout.

Fields

Name Description
AllowPropertyEvent static Identifies the AllowProperty routed event.
BeforeLoadLayoutEvent static Identifies the BeforeLoadLayout routed event.
CreateCollectionItemEvent static Allows you to create an instance of an item and restore its settings when a collection is deserialized.
CustomGetSerializableChildrenEvent static Identifies the CustomGetSerializableChildren routed event.
CustomGetSerializablePropertiesEvent static Identifies the CustomGetSerializableProperties routed event.
DeserializePropertyEvent static Identifies the DeserializeProperty routed event.
EnabledProperty static Identifies the Enabled attached property.
EnableSubtreeProperty static Identifies the EnableSubtree attached property.
LayoutUpgradeEvent static Identifies the LayoutUpgrade routed event.
LayoutVersionProperty static Identifies the LayoutVersion attached property.
SerializationIDProperty static Identifies the SerializationID attached property.
StoreLayoutModeProperty static Identifies the StoreLayoutMode attached property.

Methods

Name Description
AddAllowPropertyHandler(DependencyObject, AllowPropertyEventHandler) static Adds a handler for the AllowProperty attached event.
AddBeforeLoadLayoutHandler(DependencyObject, BeforeLoadLayoutEventHandler) static Adds a handler for the BeforeLoadLayout attached event.
AddCreateCollectionItemEventHandler(DependencyObject, XtraCreateCollectionItemEventHandler) static Adds a handler for the CreateCollectionItemEvent attached event.
AddCustomGetSerializableChildrenHandler(DependencyObject, CustomGetSerializableChildrenEventHandler) static Adds a handler for the CustomGetSerializableChildren attached event.
AddCustomGetSerializablePropertiesHandler(DependencyObject, CustomGetSerializablePropertiesEventHandler) static Adds a handler for the CustomGetSerializableProperties attached event.
AddDeserializePropertyHandler(DependencyObject, XtraPropertyInfoEventHandler) static Adds a handler for the DeserializeProperty attached event.
AddLayoutUpgradeHandler(DependencyObject, LayoutUpgradeEventHandler) static Adds a handler for the LayoutUpgrade attached event.
Deserialize(DependencyObject, Stream, String, DXOptionsLayout) static Restores (deserializes) layouts of the specified container (or a control) and all its child elements from the Stream.
Deserialize(DependencyObject, Object, String, DXOptionsLayout) static Restores (deserializes) layouts of the specified container (or control) and all its child elements from the XML file.
Deserialize(DependencyObject[], Object, String, DXOptionsLayout) static Restores (deserializes) layouts of the specified container (or control) collection and all their child elements from the XML file/Stream.
DeserializeSingleObject(DependencyObject, Object, String) static Restores (deserializes) the specified container (or control) layout from the XML file/Stream.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetEnabled(DependencyObject) static Gets the value of the DXSerializer.Enabled attached property for the specified DXSerializer.
GetEnableSubtree(DependencyObject) static Gets the value of the DXSerializer.EnableSubtree attached property for the specified DXSerializer.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLayoutVersion(DependencyObject) static Gets the value of the DXSerializer.LayoutVersion attached property for the specified DXSerializer.
GetSerializationID(DependencyObject) static Gets the value of the DXSerializer.SerializationID attached property for the specified DXSerializer.
GetStoreLayoutMode(DependencyObject) static Gets the value of the DXSerializer.StoreLayoutMode attached property for the specified DXSerializer.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveAllowPropertyHandler(DependencyObject, AllowPropertyEventHandler) static Removes a handler for the AllowProperty attached event.
RemoveBeforeLoadLayoutHandler(DependencyObject, BeforeLoadLayoutEventHandler) static Removes a handler for the BeforeLoadLayout attached event.
RemoveCreateCollectionItemEventHandler(DependencyObject, XtraCreateCollectionItemEventHandler) static Removes a handler for the CreateCollectionItemEvent attached event.
RemoveCustomGetSerializableChildrenHandler(DependencyObject, CustomGetSerializableChildrenEventHandler) static Removes a handler for the CustomGetSerializableChildrenEvent attached event.
RemoveCustomGetSerializablePropertiesHandler(DependencyObject, CustomGetSerializablePropertiesEventHandler) static Removes a handler for the CustomGetSerializableProperties attached event.
RemoveDeserializePropertyHandler(DependencyObject, XtraPropertyInfoEventHandler) static Removes a handler for the DeserializeProperty attached event.
RemoveLayoutUpgradeHandler(DependencyObject, LayoutUpgradeEventHandler) static Removes a handler for the LayoutUpgrade attached event.
Serialize(DependencyObject, Stream, String, DXOptionsLayout) static Saves (serializes) layouts of the specified container (or control) and all its child elements to a Stream. The method saves layouts of visual controls that exist in the application’s visual tree.
Serialize(DependencyObject, Object, String, DXOptionsLayout) static Saves (serializes) layouts of the specified container (or control) and all its child elements to an XML file. The method saves layouts of visual controls that exist in the application’s visual tree.
Serialize(DependencyObject[], Object, String, DXOptionsLayout) static Saves (serializes) layouts of the specified container (or control) collection and all its child elements to an XML file/Stream. The method saves layouts of visual controls that exist in the application’s visual tree.
SerializeSingleObject(DependencyObject, Object, String) static Saves (serializes) the specified container (or control) layout to an XML file/Stream. The method saves layouts of visual controls that exist in the application’s visual tree.
SetEnabled(DependencyObject, Boolean) static Sets the value of the DXSerializer.Enabled attached property to the specified DXSerializer.
SetEnableSubtree(DependencyObject, Boolean) static Sets the value of the DXSerializer.EnableSubtree attached property to the specified DXSerializer.
SetLayoutVersion(DependencyObject, String) static Sets the value of the DXSerializer.LayoutVersion attached property to the specified DXSerializer.
SetSerializationID(DependencyObject, String) static Sets the value of the DXSerializer.SerializationID attached property to the specified DXSerializer.
SetStoreLayoutMode(DependencyObject, StoreLayoutMode) static Sets the value of the DXSerializer.StoreLayoutMode attached property to the specified DXSerializer.
ToString() Returns a string that represents the current object. Inherited from Object.

Attached Events

Name Description
AllowProperty static Allows you to prevent a property from deserialization.
BeforeLoadLayout static Occurs before the DXSerializer loads a layout from an XML file/Stream.
CustomGetSerializableChildren static Allows you to save a layout of a control that does not exist in the application’s visual tree.
CustomGetSerializableProperties static Allows you to serialize standard/custom controls or custom properties.
DeserializeProperty static Occurs when the DXSerializer is about to deserialize a property.
LayoutUpgrade static Occurs when the application’s current layout version is higher than in the serialized storage (XML file/Stream).

Attached Properties

Name Description
Enabled static Gets or sets whether the DXSerializer should serialize/deserialize properties of the control to which this property is specified. This is an attached property.
EnableSubtree static Gets or sets whether the DXSerializer should serialize/deserialize properties of the specified control’s children.
LayoutVersion static Gets or sets a version of the application’s layout. This is an attached property.
SerializationID static Gets or sets an element’s unique identifier that the DXSerializer uses to identify the saved/restored elements. This is an attached property.
StoreLayoutMode static Gets or sets properties that should be serialized. This is an attached property.
See Also