CompareNodeValuesEventArgs Class

Provides data for the TreeList.CompareNodeValues event.

Assembly : DevExpress.XtraTreeList.v25.2.dll

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

Declaration

C#
VB.NET

csharp

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
public class CompareNodeValuesEventArgs :
    EventArgs

<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
Public Class CompareNodeValuesEventArgs
    Inherits EventArgs

Remarks

The TreeList.CompareNodeValues event fires each time a pair of nodes is compared in order to arrange them in a specific order. Data for this event is provided by a CompareNodeValuesEventArgs object. Properties of this object allow you to obtain the following information:

The column against whose values sorting is to be performed and the sort order applied. (The CompareNodeValuesEventArgs.Column and CompareNodeValuesEventArgs.SortOrder properties.)
The values to be compared and nodes containing these values. (The CompareNodeValuesEventArgs.NodeValue1, CompareNodeValuesEventArgs.NodeValue2, CompareNodeValuesEventArgs.Node1 and CompareNodeValuesEventArgs.Node2 properties.)

The CompareNodeValuesEventArgs.Result property is used to specify the custom result of the comparison.

When the TreeList.CompareNodeValues event is raised, an instance of the CompareNodeValuesEventArgs class is automatically created, adjusted and transmitted to the handler.

Inheritance

Object EventArgs CompareNodeValuesEventArgs