ShellItemIdList Class |
A class that represent a Windows Shell's ITEMIDLIST structure also called a PIDL.
Inheritance HierarchyNamespace: ShellBoost.Core
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public class ShellItemIdList : IReadOnlyList<ShellItemId>, IReadOnlyCollection<ShellItemId>, IEnumerable<ShellItemId>, IEnumerable, IEquatable<ShellItemIdList>, IWithIdList
The ShellItemIdList type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShellItemIdList |
Initializes a new instance of the ShellItemIdList class.
|
| ShellItemIdList(Byte) |
Initializes a new instance of the ShellItemIdList class.
|
| ShellItemIdList(IEnumerableShellItemId) |
Initializes a new instance of the ShellItemIdList class.
|
| ShellItemIdList(ShellItemId) |
Initializes a new instance of the ShellItemIdList class.
|
| ShellItemIdList(Byte, Int32) |
Initializes a new instance of the ShellItemIdList class.
|
| ShellItemIdList(ShellItemIdList, ShellItemId) |
Initializes a new instance of the ShellItemIdList class.
|
Properties| Name | Description | |
|---|---|---|
 | ContainsKnownId |
Gets a value indicating whether this instance contains at least one id known by the current Shell Folder Server.
|
| Count |
Gets the number of elements (SHITEMID structures) in the collection, including the terminator.
|
| Data |
Gets the PIDLs' data.
|
| DebugString |
Gets a string useful for developers.
|
 | Desktop |
Gets the desktop PIDL.
|
| IdCount |
Gets the number of elements (SHITEMID structures) in the collection, excluding the terminator.
|
| IsTerminator |
Gets a value indicating whether this instance contains only the terminator.
|
| Item |
Gets the ShellItemId at the specified index.
|
| Last |
Gets the last SHITEMID of this instance.
This is not the terminator.
|
| Parent |
Gets the parent PIDL.
|
| RelativeFromParent |
Gets this PIDL relative from its parent.
This is like the Last id with a terminator.
|
| Size |
Gets the PIDL's size.
|
Methods| Name | Description | |
|---|---|---|
| Add |
Adds the specified SHITEMID structure to this instance.
|
| AddRange |
Adds a range of SHITEMID structures to this instance.
|
 | ClearCache |
Clears the cache.
|
| Clone |
Clones this instance.
|
| ComparesAsAbsolute |
Determines the relative order this instance to another.
|
| ComputeHashCode |
Computes the hash code for this instance.
|
| CopyToPointer |
Allocates a buffer and copy this instance to the allocated buffer.
Once used, the buffer must be freed using Marshal.FreeCoTaskMem.
|
| CopyToPointer(Int32) |
Allocates a buffer and copy this instance to the allocated buffer.
Once used, the buffer must be freed using Marshal.FreeCoTaskMem.
|
| Equals(Object) |
Determines whether the specified Object is equal to this instance.
(Overrides ObjectEquals(Object).) |
| Equals(ShellItemIdList) |
Indicates whether the current object is equal to another object of the same type.
|
| FromFileSystem |
Creates an instance of a ShellItemIdList from a file system path and attributes.
Note the PIDL created is internal to ShellBoost, it cannot be used as a standard Windows Shell PIDL.
|
| FromPointer |
Builds a PIDL from a native pointer.
|
| GetAsRelativeFrom |
Get this PIDL relatively from a parent PIDL.
|
| GetData |
Gets the data.
|
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| GetFileSystemPath |
Gets the file system path, if this instance represents a Shell Item that defines a file system path.
Note this will call back into the Shell API, so, if this PIDL is already known to you (for example, it's one of your ShellItem's PIDL), prefer another method.
|
| GetHashCode |
Returns a hash code for this instance.
(Overrides ObjectGetHashCode.) |
| GetName |
Gets the name.
Note this will call back into the Shell API, so, if this PIDL is already known to you (for example, it's one of your ShellItem's PIDL), prefer another method.
|
| GetPath |
Gets the path.
Note this will call back into the Shell API, so, if this PIDL is already known to you (for example, it's one of your ShellItem's PIDL), prefer another method.
|
| IsChildOf |
Determines if this instance is a child of another instance.
|
| RefreshShellViews |
Refreshes all current Windows Shell views.
|
| RefreshShellViews(RefreshViewsOptions) |
Refreshes all current Windows Shell views.
|
| ResetShellThumbnail |
Resets the shell thumbnails cache for this instance.
|
| ToHexa |
Convert this instance to an hexadecimal string. Useful for developers.
|
| ToHexa(String) |
Convert this instance to an hexadecimal string. Useful for developers.
|
| ToHexaDump |
Convert this instance to an hexadecimal dump string. Useful for developers.
|
| ToHexaDump(String) |
Convert this instance to an hexadecimal dump string. Useful for developers.
|
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
Operators| Name | Description | |
|---|---|---|
 | Equality |
Implements the == operator.
|
| Inequality |
Implements the != operator.
|
Extension Methods| Name | Description | |
|---|---|---|
 | OpenView |
Opens a Windows Explorer window.
(Defined by Extensions.) |
| WithPointer(ActionIntPtr) | Overloaded.
Allocates a buffer, runs the specified action and free the buffer.
(Defined by Extensions.) |
| WithPointerT(FuncIntPtr, T) | Overloaded.
Allocates a buffer, runs the specified function and free the buffer.
(Defined by Extensions.) |
See Also