IPropertyDescription interface (propsys.h)

Article
07/27/2022

Exposes methods that enumerate and retrieve individual property description details.

Inheritance

The IPropertyDescription interface inherits from the IUnknown interface. IPropertyDescription also has these types of members:

Methods

The IPropertyDescription interface has these methods.


IPropertyDescription::CoerceToCanonicalValue Coerces the value to the canonical value, according to the property description.
IPropertyDescription::FormatForDisplay Gets a formatted, Unicode string representation of a property value. (IPropertyDescription.FormatForDisplay)
IPropertyDescription::GetAggregationType Gets a value that describes how the property values are displayed when multiple items are selected in the UI.
IPropertyDescription::GetCanonicalName Gets the case-sensitive name by which a property is known to the system, regardless of its localized name.
IPropertyDescription::GetColumnState Gets the column state flag, which describes how the property should be treated by interfaces or APIs that use this flag.
IPropertyDescription::GetConditionType Gets the condition type and default condition operation to use when displaying the property in the query builder UI. This influences the list of predicate conditions (for example, equals, less than, and contains) that are shown for this property.
IPropertyDescription::GetDefaultColumnWidth Gets the default column width of the property in a list view.
IPropertyDescription::GetDisplayName Gets the display name of the property as it is shown in any UI.
IPropertyDescription::GetDisplayType Gets the current data type used to display the property.
IPropertyDescription::GetEditInvitation Gets the text used in edit controls hosted in various dialog boxes.
IPropertyDescription::GetEnumTypeList Gets an instance of an IPropertyEnumTypeList, which can be used to enumerate the possible values for a property.
IPropertyDescription::GetGroupingRange Gets the grouping method to be used when a view is grouped by a property, and retrieves the grouping type.
IPropertyDescription::GetPropertyKey Gets a structure that acts as a property's unique identifier.
IPropertyDescription::GetPropertyType Gets the variant type of the property.
IPropertyDescription::GetRelativeDescription Compares two property values in the manner specified by the property description. Returns two display strings that describe how the two properties compare.
IPropertyDescription::GetRelativeDescriptionType Gets the relative description type for a property description.
IPropertyDescription::GetSortDescription Gets the current sort description flags for the property, which indicate the particular wordings of sort offerings.
IPropertyDescription::GetSortDescriptionLabel Gets the localized display string that describes the current sort order.
IPropertyDescription::GetTypeFlags Gets a set of flags that describe the uses and capabilities of the property.
IPropertyDescription::GetViewFlags Gets the current set of flags governing the property's view.
IPropertyDescription::IsValueCanonical Gets a value that indicates whether a property is canonical according to the definition of the property description.

Remarks

When to Implement

Do not implement this interface. There is only one implementation of IPropertyDescription in the system; it is provided by the Shell.

To obtain this interface, call PSGetPropertyDescription, PSGetPropertyDescriptionByName, or IPropertyDescriptionList::GetAt.

Only one property description exists for each property in the system.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	propsys.h