PropertyKey Structure |
Specifies the format + id (FMTID/PID) structure that programmatically identifies a property.
Wraps Windows Property System's PROPERTYKEY structure.
Namespace: ShellBoost.Core.WindowsPropertySystem
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public struct PropertyKey : IEquatable<PropertyKey>
The PropertyKey type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PropertyKey(Byte) |
Initializes a new instance of the PropertyKey struct.
|
| PropertyKey(Guid, Int32) |
Initializes a new instance of the PropertyKey struct.
|
Properties| Name | Description | |
|---|---|---|
 | CanonicalName |
Gets the canonical name.
|
| Description |
Gets the corresponding property description.
|
| FormatId |
Gets the format identifier.
|
| Id |
Gets the identifier.
|
| IsNull |
Gets a value indicating whether this instance is the NULL property key (guid empty and identitifier set to 0).
|
Methods| Name | Description | |
|---|---|---|
| Equals(Object) |
Determines whether the specified Object is equal to this instance.
(Overrides ValueTypeEquals(Object).) |
| Equals(PropertyKey) |
Indicates whether the current object is equal to another object of the same type.
|
| FormatForDisplay |
Formats a value for display, using the property description.
|
 | FromString |
Converts a string to a PropertyKey instance.
|
| GetHashCode |
Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode.) |
| ToString |
Returns a String that represents this instance.
(Overrides ValueTypeToString.) |
| ToValueString |
Formats the property key as "{Guid value} identifier", like "{F29F85E0-4FF9-1068-AB91-08002B27B3D9} 2" for example.
See also the PSPropertyKeyFromString function.
|
| TryCoerceToCanonicalValue |
Coerces a value to a canonical value.
|
Operators| Name | Description | |
|---|---|---|
 | Equality |
Implements the == operator.
|
| Inequality |
Implements the != operator.
|
Fields| Name | Description | |
|---|---|---|
 | FirstUsableId |
The first usable identifier
|
| Null |
The null property key.
|
| PID_FIRST_USABLE |
The first usable property id value (2). Values of 0 and 1 are reserved and should not be used.
|
| PSGUID_FOLDER_COLUMNID |
The Property Key format identifier for accessing a folder column by its index.
|
See Also