Class ShellPropertyCollection

Namespace

Microsoft.WindowsAPICodePack.Shell.PropertySystem

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Creates a readonly collection of IProperty objects.

public class ShellPropertyCollection : ReadOnlyCollection<IShellProperty>, IList<IShellProperty>, ICollection<IShellProperty>, IList, ICollection, IReadOnlyList<IShellProperty>, IReadOnlyCollection<IShellProperty>, IEnumerable<IShellProperty>, IEnumerable, IDisposable

Inheritance

object

ReadOnlyCollection<IShellProperty>

ShellPropertyCollection

Implements

IList<IShellProperty>

ICollection<IShellProperty>

IList

ICollection

IReadOnlyList<IShellProperty>

IReadOnlyCollection<IShellProperty>

IEnumerable<IShellProperty>

IEnumerable

IDisposable

Inherited Members

ReadOnlyCollection<IShellProperty>.Contains(IShellProperty)

ReadOnlyCollection<IShellProperty>.CopyTo(IShellProperty[], int)

ReadOnlyCollection<IShellProperty>.GetEnumerator()

ReadOnlyCollection<IShellProperty>.IndexOf(IShellProperty)

ReadOnlyCollection<IShellProperty>.Empty

ReadOnlyCollection<IShellProperty>.Count

ReadOnlyCollection<IShellProperty>.this[int]

ReadOnlyCollection<IShellProperty>.Items

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ShellPropertyCollection(ShellObject)

Creates a new Property collection given an IShellItem2 native interface

public ShellPropertyCollection(ShellObject parent)

Parameters

parent ShellObject

Parent ShellObject

ShellPropertyCollection(string)

Creates a new ShellPropertyCollection object with the specified file or folder path.

public ShellPropertyCollection(string path)

Parameters

path string

The path to the file or folder.

Properties

this[PropertyKey]

Gets a property associated with the supplied property key.

public IShellProperty this[PropertyKey key] { get; }

Parameters

key PropertyKey

The property key.

Property Value

IShellProperty

The property associated with the property key, if found.

Exceptions

IndexOutOfRangeException

Throws IndexOutOfRangeException if no matching property is found.

this[string]

Gets the property associated with the supplied canonical name string. The canonical name property is case-sensitive.

public IShellProperty this[string canonicalName] { get; }

Parameters

canonicalName string

The canonical name.

Property Value

IShellProperty

The property associated with the canonical name, if found.

Exceptions

IndexOutOfRangeException

Throws IndexOutOfRangeException if no matching property is found.

Methods

Contains(PropertyKey)

public bool Contains(PropertyKey key)

Parameters

key PropertyKey

Returns

bool

Contains(string)

Checks if a property with the given canonical name is available.

public bool Contains(string canonicalName)

Parameters

canonicalName string

The canonical name of the property.

Returns

bool

True if available, false otherwise.

Dispose()

Release the native objects.

public void Dispose()

Dispose(bool)

Release the native and managed objects

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

Indicates that this is being called from Dispose(), rather than the finalizer.

~ShellPropertyCollection()

Implement the finalizer.

protected ~ShellPropertyCollection()