Class ShellPropertyDescription

Namespace

Microsoft.WindowsAPICodePack.Shell.PropertySystem

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Defines the shell property description information for a property.

public class ShellPropertyDescription : IDisposable

Inheritance

object

ShellPropertyDescription

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

AggregationTypes

Gets a value that describes how the property values are displayed when multiple items are selected in the user interface (UI).

public PropertyAggregationType AggregationTypes { get; }

Property Value

PropertyAggregationType

CanonicalName

Gets the case-sensitive name of a property as it is known to the system, regardless of its localized name.

public string CanonicalName { get; }

Property Value

string

ColumnState

Gets the column state flag, which describes how the property should be treated by interfaces or APIs that use this flag.

public PropertyColumnStateOptions ColumnState { get; }

Property Value

PropertyColumnStateOptions

ConditionOperation

Gets the default condition operation to use when displaying the property in the query builder user interface (UI). This influences the list of predicate conditions (for example, equals, less than, and contains) that are shown for this property.

public PropertyConditionOperation ConditionOperation { get; }

Property Value

PropertyConditionOperation

Remarks

For more information, see the conditionType attribute of the typeInfo element in the property's .propdesc file.

ConditionType

Gets the condition type to use when displaying the property in the query builder user interface (UI). This influences the list of predicate conditions (for example, equals, less than, and contains) that are shown for this property.

public PropertyConditionType ConditionType { get; }

Property Value

PropertyConditionType

Remarks

For more information, see the conditionType attribute of the typeInfo element in the property's .propdesc file.

DefaultColumWidth

Gets the default user interface (UI) column width for this property.

public uint DefaultColumWidth { get; }

Property Value

uint

DisplayName

Gets the display name of the property as it is shown in any user interface (UI).

public string DisplayName { get; }

Property Value

string

DisplayType

Gets the current data type used to display the property.

public PropertyDisplayType DisplayType { get; }

Property Value

PropertyDisplayType

EditInvitation

Gets the text used in edit controls hosted in various dialog boxes.

public string EditInvitation { get; }

Property Value

string

GroupingRange

Gets the method used when a view is grouped by this property.

public PropertyGroupingRange GroupingRange { get; }

Property Value

PropertyGroupingRange

Remarks

The information retrieved by this method comes from the groupingRange attribute of the typeInfo element in the property's .propdesc file.

HasSystemDescription

Gets a value that determines if the native property description is present on the system.

public bool HasSystemDescription { get; }

Property Value

bool

PropertyEnumTypes

Gets a list of the possible values for this property.

public ReadOnlyCollection<ShellPropertyEnumType> PropertyEnumTypes { get; }

Property Value

ReadOnlyCollection<ShellPropertyEnumType>

PropertyKey

Gets the property key identifying the underlying property.

public PropertyKey PropertyKey { get; }

Property Value

PropertyKey

SortDescription

Gets the current sort description flags for the property, which indicate the particular wordings of sort offerings.

public PropertySortDescription SortDescription { get; }

Property Value

PropertySortDescription

Remarks

The settings retrieved by this method are set through the sortDescription attribute of the labelInfo element in the property's .propdesc file.

TypeFlags

Gets a set of flags that describe the uses and capabilities of the property.

public PropertyTypeOptions TypeFlags { get; }

Property Value

PropertyTypeOptions

ValueType

Gets the .NET system type for a value of this property, or null if the value is empty.

public Type ValueType { get; }

Property Value

Type

VarEnumType

Gets the VarEnum OLE type for this property.

public VarEnum VarEnumType { get; }

Property Value

VarEnum

ViewFlags

Gets the current set of flags governing the property's view.

public PropertyViewOptions ViewFlags { get; }

Property Value

PropertyViewOptions

Methods

Dispose()

Release the native objects

public void Dispose()

Dispose(bool)

Release the native objects

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

Indicates that this is being called from Dispose(), rather than the finalizer.

~ShellPropertyDescription()

Release the native objects

protected ~ShellPropertyDescription()

GetSortDescriptionLabel(bool)

Gets the localized display string that describes the current sort order.

public string GetSortDescriptionLabel(bool descending)

Parameters

descending bool

Indicates the sort order should reference the string "Z on top"; otherwise, the sort order should reference the string "A on top".

Returns

string

The sort description for this property.

Remarks

The string retrieved by this method is determined by flags set in the sortDescription attribute of the labelInfo element in the property's .propdesc file.