TreeList.PropertySerializing Event

Allows you to include certain settings in the layout when you save it.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.1.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.TreeList

Declaration

C#

[DXCategory("Events")]
public event EventHandler<PropertyAllowEventArgs> PropertySerializing

VB.NET

<DXCategory("Events")>
Public Event PropertySerializing As EventHandler(Of PropertyAllowEventArgs)

Event Data

The PropertySerializing event's data class is PropertyAllowEventArgs. The following properties provide information specific to this event:

Property	Description
Allow	Gets or sets whether to allow property serialization or deserialization.
OptionsLayout	Gets layout settings of the control whose layout is being serialized or deserialized.
Owner	Gets the control or UI element whose layout settings are being serialized or deserialized.
PropertyName	Gets the property name currently being processed.

Remarks

Handle the PropertySerializing and PropertyDeserializing events for fine-grained control over layout saving/restoring. The e.PropertyName parameter specifies which property/setting is currently being processed. Use the e.Allow property to allow or disallow property serialization.

You can also use the OptionsLayout property to specify layout-related settings.

Read the following topic for information and examples: Save and Restore Layouts of DevExpress Controls.

Example

The following example demonstrates how to avoid serializing certain settings:

C#

treeList.PropertySerializing += (s, e) => {
    if(e.Owner is TreeListColumn && e.PropertyName == "Caption")
        e.Allow = DefaultBoolean.False;
};

VB.NET

AddHandler treeList.PropertySerializing, Sub(s, e)
    If TypeOf e.Owner Is TreeListColumn AndAlso e.PropertyName = "Caption" Then
        e.Allow = DefaultBoolean.False
    End If
End Sub