Class
GridSortField

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition

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.

Declaration

cs-api-definition

public GridSortField()

GridSortField(string)

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

Declaration

cs-api-definition

public GridSortField(string fieldName)

Parameters

fieldName

string

The field name of the new GridSortField object.

GridSortField(string, RadSortOrder)

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

Declaration

cs-api-definition

public GridSortField(string fieldName, RadSortOrder sortOrder)

Parameters

fieldName

string

The field name of the new GridSortField object.

sortOrder

RadSortOrder

The sort order of the new GridSortField object

Properties

FieldName

Gets or sets the name of the field.

Declaration

cs-api-definition

public string FieldName { get; set; }

Property Value

string

The name of the field.

IsEmpty

Gets a value indicating whether this instance is empty.

Declaration

cs-api-definition

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

Property Value

bool

true if this instance is empty; otherwise, false.

SortOrder

Gets or sets the sort order.

Declaration

cs-api-definition

public RadSortOrder SortOrder { get; set; }

Property Value

RadSortOrder

The sort order.

Methods

Clone()

Clones this instance.

Declaration

cs-api-definition

public GridSortField Clone()

Returns

GridSortField

Equals(object)

Determines whether the specified object is equal to this instance.

Declaration

cs-api-definition

public override bool Equals(object obj)

Parameters

obj

object

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.

Declaration

cs-api-definition

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

Declaration

cs-api-definition

protected override void OnPropertyChanged(PropertyChangedEventArgs e)

Parameters

PropertyChangedEventArgs

A PropertyChangedEventArgs instance containing event data.

Overrides SortDescriptor.OnPropertyChanged(PropertyChangedEventArgs)

SortOrderAsString()

Sorts the order as string.

Declaration

cs-api-definition

public string SortOrderAsString()

Returns

string

SortOrderAsString(RadSortOrder)

Sorts the order as string.

Declaration

cs-api-definition

public static string SortOrderAsString(RadSortOrder sortOrder)

Parameters

sortOrder

RadSortOrder

The sort order.

Returns

string

SortOrderFromString(string)

Sorts the order from string.

Declaration

cs-api-definition

public static RadSortOrder SortOrderFromString(string sortOrder)

Parameters

sortOrder

string

The sort order.

Returns

RadSortOrder

ToString()

Returns a string that represents this instance.

Declaration

cs-api-definition

public override string ToString()

Returns

string

A string that represents this instance.

Overrides object.ToString()

ClassGridSortField

Class
GridSortField