Struct SortColumn

Namespace

Microsoft.WindowsAPICodePack.Shell

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Stores information about how to sort a column that is displayed in the folder view.

public struct SortColumn

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

SortColumn(PropertyKey, SortDirection)

Creates a sort column with the specified direction for the given property.

public SortColumn(PropertyKey propertyKey, SortDirection direction)

Parameters

propertyKey PropertyKey

Property key for the property that the user will sort.

direction SortDirection

The direction in which the items are sorted.

Properties

Direction

The direction in which the items are sorted.

public SortDirection Direction { get; set; }

Property Value

SortDirection

PropertyKey

The ID of the column by which the user will sort. A PropertyKey structure. For example, for the "Name" column, the property key is PKEY_ItemNameDisplay or ItemName.

public PropertyKey PropertyKey { get; set; }

Property Value

PropertyKey

Methods

Equals(object)

Determines if this object is equal to another.

public override bool Equals(object obj)

Parameters

obj object

The object to compare

Returns

bool

Returns true if the objects are equal; false otherwise.

GetHashCode()

Generates a nearly unique hashcode for this structure.

public override int GetHashCode()

Returns

int

A hash code.

Operators

operator ==(SortColumn, SortColumn)

Implements the == (equality) operator.

public static bool operator ==(SortColumn col1, SortColumn col2)

Parameters

col1 SortColumn

First object to compare.

col2 SortColumn

Second object to compare.

Returns

bool

True if col1 equals col2; false otherwise.

operator !=(SortColumn, SortColumn)

Implements the != (unequality) operator.

public static bool operator !=(SortColumn col1, SortColumn col2)

Parameters

col1 SortColumn

First object to compare.

col2 SortColumn

Second object to compare.

Returns

bool

True if col1 does not equals col1; false otherwise.