Class ShellObjectCollection

Namespace

Microsoft.WindowsAPICodePack.Shell

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

An ennumerable list of ShellObjects

public class ShellObjectCollection : IDisposable, IList<ShellObject>, ICollection<ShellObject>, IEnumerable<ShellObject>, IEnumerable

Inheritance

object

ShellObjectCollection

Implements

IDisposable

IList<ShellObject>

ICollection<ShellObject>

IEnumerable<ShellObject>

IEnumerable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ShellObjectCollection()

Constructs an empty ShellObjectCollection

public ShellObjectCollection()

Properties

Count

Item count

public int Count { get; }

Property Value

int

IsReadOnly

If true, the contents of the collection are immutable.

public bool IsReadOnly { get; }

Property Value

bool

this[int]

The collection indexer

public ShellObject this[int index] { get; set; }

Parameters

index int

The index of the item to retrieve.

Property Value

ShellObject

The ShellObject at the specified index

Methods

Add(ShellObject)

Adds a ShellObject to the collection,

public void Add(ShellObject item)

Parameters

item ShellObject

The ShellObject to add.

BuildShellIDList()

Builds the data for the CFSTR_SHELLIDLIST Drag and Clipboard data format from the ShellObjects in the collection.

public MemoryStream BuildShellIDList()

Returns

MemoryStream

A memory stream containing the drag/drop data.

Clear()

Clears the collection of ShellObjects.

public void Clear()

Contains(ShellObject)

Determines if the collection contains a particular ShellObject.

public bool Contains(ShellObject item)

Parameters

item ShellObject

The ShellObject.

Returns

bool

true, if the ShellObject is in the list, false otherwise.

CopyTo(ShellObject[], int)

Copies the ShellObjects in the collection to a ShellObject array.

public void CopyTo(ShellObject[] array, int arrayIndex)

Parameters

array ShellObject[]

The destination to copy to.

arrayIndex int

The index into the array at which copying will commence.

Dispose()

Standard Dispose pattern

public void Dispose()

Dispose(bool)

Standard Dispose patterns

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

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

~ShellObjectCollection()

Finalizer

protected ~ShellObjectCollection()

FromDataObject(IDataObject)

Creates a ShellObjectCollection from an IDataObject passed during Drop operation.

public static ShellObjectCollection FromDataObject(IDataObject dataObject)

Parameters

dataObject IDataObject

An object that implements the IDataObject COM interface.

Returns

ShellObjectCollection

ShellObjectCollection created from the given IDataObject

GetEnumerator()

Collection enumeration

public IEnumerator GetEnumerator()

Returns

IEnumerator

IndexOf(ShellObject)

Returns the index of a particualr shell object in the collection

public int IndexOf(ShellObject item)

Parameters

item ShellObject

The item to search for.

Returns

int

The index of the item found, or -1 if not found.

Insert(int, ShellObject)

Inserts a new shell object into the collection.

public void Insert(int index, ShellObject item)

Parameters

index int

The index at which to insert.

item ShellObject

The item to insert.

Remove(ShellObject)

Removes a particular ShellObject from the list.

public bool Remove(ShellObject item)

Parameters

item ShellObject

The ShellObject to remove.

Returns

bool

True if the item could be removed, false otherwise.

RemoveAt(int)

Removes the specified ShellObject from the collection

public void RemoveAt(int index)

Parameters

index int

The index to remove at.