Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IPropertyDescription interface

Exposes methods that enumerate and retrieve individual property description details.

Members

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

Methods

The IPropertyDescription interface has these methods.

MethodDescription
CoerceToCanonicalValue

Coerces the value to the canonical value, according to the property description.

FormatForDisplay

Gets a formatted, Unicode string representation of a property value.

GetAggregationType

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

GetCanonicalName

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

GetColumnState

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

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.

GetDefaultColumnWidth

Gets the default column width of the property in a list view.

GetDisplayName

Gets the display name of the property as it is shown in any UI.

GetDisplayType

Gets the current data type used to display the property.

GetEditInvitation

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

GetEnumTypeList

Gets an instance of an IPropertyEnumTypeList, which can be used to enumerate the possible values for a property.

GetGroupingRange

Gets the grouping method to be used when a view is grouped by a property, and retrieves the grouping type.

GetPropertyKey

Gets a structure that acts as a property's unique identifier.

GetPropertyType

Gets the variant type of the property.

GetRelativeDescription

Compares two property values in the manner specified by the property description. Returns two display strings that describe how the two properties compare.

GetRelativeDescriptionType

Gets the relative description type for a property description.

GetSortDescription

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

GetSortDescriptionLabel

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

GetTypeFlags

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

GetViewFlags

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

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Propsys.h

IDL

Propsys.idl

See also

Property Description Schema

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.