Class
SortDescriptor

Represents a descriptor for sorting data.

Definition

Namespace:Telerik.WinControls.Data

Assembly:Telerik.WinControls.dll

Syntax:

cs-api-definition
public class SortDescriptor : INotifyPropertyChanged, INotifyPropertyChangingEx, ICloneable

Inheritance: objectSortDescriptor

Derived Classes: GridSortField

Implements: ICloneableINotifyPropertyChangedINotifyPropertyChangingEx

Constructors

SortDescriptor()

Declaration

cs-api-definition
public SortDescriptor()

SortDescriptor(string, ListSortDirection)

Declaration

cs-api-definition
public SortDescriptor(string propertyName, ListSortDirection direction)

Parameters

propertyName

string

direction

ListSortDirection

SortDescriptor(string, ListSortDirection, SortDescriptorCollection)

Declaration

cs-api-definition
public SortDescriptor(string propertyName, ListSortDirection direction, SortDescriptorCollection owner)

Parameters

propertyName

string

direction

ListSortDirection

owner

SortDescriptorCollection

Properties

Direction

Gets or sets the direction.

Declaration

cs-api-definition
public ListSortDirection Direction { get; set; }

Property Value

ListSortDirection

The direction.

Owner

Gets or sets the owner.

Declaration

cs-api-definition
[Browsable(false)]
public SortDescriptorCollection Owner { get; }

Property Value

SortDescriptorCollection

The owner.

PropertyIndex

Represents the index of the property to be used for sorting in a SortDescriptor.

Declaration

cs-api-definition
public int PropertyIndex { get; }

Property Value

int

The index of the specified property within the data source.

PropertyName

Gets or sets the name of the property.

Declaration

cs-api-definition
public string PropertyName { get; set; }

Property Value

string

The name of the property.

Methods

Clone()

Creates a duplicate of the current SortDescriptor instance.

Declaration

cs-api-definition
public virtual object Clone()

Returns

object

A new instance of the SortDescriptor that is a copy of the current instance.

Implements ICloneable.Clone()

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event

Declaration

cs-api-definition
protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameters

e

PropertyChangedEventArgs

A PropertyChangedEventArgs instance containing event data.

OnPropertyChanged(string)

Raises the PropertyChanged event

Declaration

cs-api-definition
protected void OnPropertyChanged(string propertyName)

Parameters

propertyName

string

The name of the property

OnPropertyChanging(PropertyChangingEventArgsEx)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnPropertyChanging(PropertyChangingEventArgsEx e)

Parameters

e

PropertyChangingEventArgsEx

The PropertyChangingEventArgs instance containing the event data.

OnPropertyChanging(string, object, object)

Raises the event.

Declaration

cs-api-definition
protected virtual bool OnPropertyChanging(string propertyName, object oldValue, object newValue)

Parameters

propertyName

string

Name of the property.

oldValue

object

The old value.

newValue

object

The new value.

Returns

bool

Returns [TRUE] If the events is not canceled, otherwise [FALSE].

Events

PropertyChanged

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged

PropertyChanging

Occurs when a property value is changing.

Declaration

cs-api-definition
public event PropertyChangingEventHandlerEx PropertyChanging

Event Value

PropertyChangingEventHandlerEx

Implements INotifyPropertyChangingEx.PropertyChanging