Interface IShellProperty

Namespace

Microsoft.WindowsAPICodePack.Shell.PropertySystem

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Defines the properties used by a Shell Property.

public interface IShellProperty

Properties

CanonicalName

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

string CanonicalName { get; }

Property Value

string

Description

Get the property description object.

ShellPropertyDescription Description { get; }

Property Value

ShellPropertyDescription

IconReference

Gets the image reference path and icon index associated with a property value. This API is only available in Windows 7.

IconReference IconReference { get; }

Property Value

IconReference

PropertyKey

Gets the property key that identifies this property.

PropertyKey PropertyKey { get; }

Property Value

PropertyKey

ValueAsObject

Gets the value for this property using the generic Object type.

object ValueAsObject { get; }

Property Value

object

Remarks

To obtain a specific type for this value, use the more strongly-typed Property<T> class. You can only set a value for this type using the Property<T> class.

ValueType

Gets the System.Type value for this property.

Type ValueType { get; }

Property Value

Type

Methods

FormatForDisplay(PropertyDescriptionFormatOptions)

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

string FormatForDisplay(PropertyDescriptionFormatOptions format)

Parameters

format PropertyDescriptionFormatOptions

One or more PropertyDescriptionFormat flags chosen to produce the desired display format.

Returns

string

The formatted value as a string.