New to Telerik UI for WinForms? Start a free 30-day trial

GridSortField

Class

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

public class GridSortField : SortDescriptor, INotifyPropertyChanged, INotifyPropertyChangingEx, ICloneable

Inheritance: objectSortDescriptorGridSortField

Implements: ICloneableINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members SortDescriptor.OnPropertyChanged(string)SortDescriptor.OnPropertyChanging(string, object, object)SortDescriptor.OnPropertyChanging(PropertyChangingEventArgsEx)SortDescriptor.PropertyNameSortDescriptor.DirectionSortDescriptor.OwnerSortDescriptor.PropertyIndexSortDescriptor.PropertyChangedSortDescriptor.PropertyChanging...

Constructors

GridSortField()

Initializes a new instance of the GridSortField class.

public GridSortField()

GridSortField(string, RadSortOrder)

Initializes a new instance of the GridSortField class with field name, sort order and the default data type of string.

public GridSortField(string fieldName, RadSortOrder sortOrder)

Parameters:fieldNamestring

The field name of the new GridSortField object.

sortOrderRadSortOrder

The sort order of the new GridSortField object

GridSortField(string)

Initializes a new instance of the GridSortField class with field name.

public GridSortField(string fieldName)

Parameters:fieldNamestring

The field name of the new GridSortField object.

Properties

FieldName

string

Gets or sets the name of the field.

public string FieldName { get; set; }

Property Value:

The name of the field.

IsEmpty

bool

Gets a value indicating whether this instance is empty.

[Browsable(false)]
public bool IsEmpty { get; }

Property Value:

true if this instance is empty; otherwise, false.

SortOrder

RadSortOrder

Gets or sets the sort order.

public RadSortOrder SortOrder { get; set; }

Property Value:

The sort order.

Methods

Clone()

Clones this instance.

public GridSortField Clone()

Returns:

GridSortField

Equals(object)

Determines whether the specified object is equal to this instance.

public override bool Equals(object obj)

Parameters:objobject

The object to compare with this instance.

Returns:

bool

true if the specified object is equal to this instance; otherwise, false.

Exceptions:

NullReferenceException

The obj parameter is null.

Overrides: object.Equals(object)

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns:

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides: object.GetHashCode()

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event

protected override void OnPropertyChanged(PropertyChangedEventArgs e)

Parameters:ePropertyChangedEventArgs

A PropertyChangedEventArgs instance containing event data.

Overrides: SortDescriptor.OnPropertyChanged(PropertyChangedEventArgs)

SortOrderAsString()

Sorts the order as string.

public string SortOrderAsString()

Returns:

string

SortOrderAsString(RadSortOrder)

Sorts the order as string.

public static string SortOrderAsString(RadSortOrder sortOrder)

Parameters:sortOrderRadSortOrder

The sort order.

Returns:

string

SortOrderFromString(string)

Sorts the order from string.

public static RadSortOrder SortOrderFromString(string sortOrder)

Parameters:sortOrderstring

The sort order.

Returns:

RadSortOrder

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns:

string

A string that represents this instance.

Overrides: object.ToString()