|
//Copyright (c) Microsoft Corporation. All rights reserved.
//Copyright (c) Microsoft Corporation. All rights reserved.
using System;
using Microsoft.WindowsAPICodePack.Shell;
namespace Microsoft.WindowsAPICodePack.Shell.PropertySystem
{
/// <summary>
/// Defines the properties used by a Shell Property.
/// </summary>
public interface IShellProperty
{
/// <summary>
/// Gets the property key that identifies this property.
/// </summary>
PropertyKey PropertyKey
{
get;
}
/// <summary>
/// Gets a formatted, Unicode string representation of a property value.
/// </summary>
/// <param name="format">One or more <c>PropertyDescriptionFormat</c> flags
/// chosen to produce the desired display format.</param>
/// <returns>The formatted value as a string.</returns>
string FormatForDisplay(PropertyDescriptionFormat format);
/// <summary>
/// Get the property description object.
/// </summary>
ShellPropertyDescription Description
{
get;
}
/// <summary>
/// Gets the case-sensitive name of the property as it is known to the system,
/// regardless of its localized name.
/// </summary>
string CanonicalName
{
get;
}
/// <summary>
/// Gets the value for this property using the generic Object type.
/// </summary>
/// <remarks>
/// To obtain a specific type for this value, use the more strongly-typed
/// <c>Property<T></c> class.
/// You can only set a value for this type using the <c>Property<T></c>
/// class.
/// </remarks>
object ValueAsObject
{
get;
}
/// <summary>
/// Gets the <c>System.Type</c> value for this property.
/// </summary>
Type ValueType
{
get;
}
/// <summary>
/// Gets the image reference path and icon index associated with a property value.
/// This API is only available in Windows 7.
/// </summary>
IconReference IconReference
{
get;
}
}
}
|
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please
let us know and we'll add colourisation support for it.
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.