Click or drag to resize

ItemIdList Class

Wrapper class for ItemIdList structures of the Win32 Shell.
Inheritance Hierarchy
SystemObject
  Jam.ShellItemIdListBase2
    Jam.ShellItemIdList
      Jam.ShellSearchFolder

Namespace: Jam.Shell
Assembly: ShellBrowser.Core (in ShellBrowser.Core.dll) Version: 7.2
Syntax
Copy
[TypeConverterAttribute(typeof(ItemIdListConverter))]
public class ItemIdList : ItemIdListBase2, IComparable<ItemIdList>, 
	IJamItemIdList, IComparable

The ItemIdList type exposes the following members.

Constructors
 NameDescription
Public methodItemIdList Initializes a new empty instance of the ItemIdList class.
Public methodItemIdList(IntPtr)Initializes a new instance of the ItemIdList class that contains a copy of the given ItemIdList.
Public methodItemIdList(ItemIdList) Initializes a new instance of the ItemIdList class that contains a copy of the given ItemIdList.
Public methodItemIdList(ShellFolder) Initializes a new instance of the ItemIdList class that contains an ItemIdList for the given special folder.
Public methodItemIdList(EnvironmentSpecialFolder) Initializes a new instance of the ItemIdList class that contains an ItemIdList to the given special folder.
Public methodItemIdList(String) Initializes a new instance of the ItemIdList class that contains an ItemIdList for the given path.
Top
Properties
 NameDescription
Public propertyCaption Returns the display name of the object for that this ItemIdList stands for. This does not neccessarily return the complete filename of the object, refer to Path if this functionality is required.
Public propertyCount Returns the number of parts this ItemIdList consists of.
Public propertyDisplayPath Returns a string representing the path for this item suitable for displaying.
Public propertyIsExpandableGets a value indicating whether this object is expandable.
Public propertyIsFolder Does this ItemIdList element represent a directory?
Public propertyIsInNetworktrue if this ItemIdList is part of the nethood; false
Public propertyIsInSearchFolder Similar to IsSearchFolder, method returns true, if the current ItemIdList belongs to a search folder, i.e. if it is a subfolder appearing in a search result.
Public propertyIsInvalid Returns true if the currently stored ItemIdList is valid; false otherwise;
(Overrides ItemIdListBase2IsInvalid)
Public propertyIsRootOfNamespace Returns true if the current ItemIdList is the root of the shell name space. This is commonly the "Desktop"
Public propertyIsSearchFolderGets a value indicating whether this object represents a search folder.
Public propertyIsSlowGets a value indicating whether this object is slow.
Public propertyLinkTarget Gets the link target if the element represented by this ItemIdList is a link.
Public propertyNameReturns the physical name of the ItemIdList.
Public propertyParent Returns the parent ItemIdList, or an invalid ItemIdList if no parent exists.
Public propertyParentPath Returns the parent directory of the element represented by this ItemIdList.
Public propertyPath The corresponding file system path of this ItemIdList. This property may be empty if the current ItemIdList does not belong to a file system object.
Public propertySpecialFolder SpecialFolder allows you to get the type of the currently listed folder.
Public propertyWin32PtrGets the window 32 pointer, i.e. the PIDL of the ItemIdList.
Top
Methods
 NameDescription
Public methodCompareTo(ItemIdList) Determines the relative order of "this" and "other".
Public methodCompareTo(Object)Determines the relative order of "this" and "other".
Public methodCompareTo(ItemIdList, ItemIdListComparison) Determines the relative order of "this" and "other".
Public methodConcat Concatenates the specified ItemIdList to the current one.
Public methodConcatRelativeIdList Concatenates a relative item idlist to the current one returning a new object
Public methodStatic memberCopyItemIdList Creates a copy of a Win32 ItemIdList in the memory.
Public methodDispose Releases ressources.
(Inherited from ItemIdListBase2)
Protected methodDispose(Boolean)Releases Com-Interfaces associated with this ItemIdList.
(Overrides ItemIdListBase2Dispose(Boolean))
Public methodEquals(ItemIdList) Determines whether the specified ItemIdList references the same object in the Windows Shell namespace.
Public methodEquals(Object) Determines whether the specified ItemIdList references the same object in the Windows Shell namespace.
(Overrides ObjectEquals(Object))
Public methodEquals(ItemIdList, ItemIdListComparison) Determines whether the specified ItemIdList references the same object in the Windows Shell namespace.
Protected methodFinalize Finalizes an instance of the ItemIdListBase2 class. Releases unmanaged ressources before the instance is reclaimed by the Garbage Collection.
(Inherited from ItemIdListBase2)
Public methodGetDisplayNameGets a display name as specified by the passed format.
Public methodStatic memberGetForSpecialFolder Returns an ItemIdList for a SpecialFolder.
Public methodGetHashCode Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode)
Public methodGetPart Returns a new instance of the ItemIdList class that contains only a part of the current ItemIdList.
Protected methodStatic memberGetPidlCount Returns the number of parts of that a Win32 ItemIdList consists.
Protected methodStatic memberGetPidlSize Calculates the size of the given Win32 ItemIdList in bytes.
Public methodGetPropertyDisplayValueGets property value converted to a string.
Public methodGetPropertyVariantValueGets property value of the shell item represented by this ItemIdList. Depending on the attribute requested, the value is converted into a matching type.
Public methodHasAttributes Determines whether the object represented by this ItemIdList has the specified attributes.
Public methodStatic memberIsFileSystemFolder Returns true for normal FileSystemFolders, false for elements like zip files, that have an associated stream. If pAcceptAncestor is true, a virtual folder containing file system folders will return true as well, false otherwise.
Public methodStatic memberIsInZipArchive Returns true, if the passed ItemIdList is part of a zip archive or similar format.
Public methodStatic memberIsNullOrInvalidQuery if 'pItemIdList' is null or invalid.
Public methodIsParentOf Determines whether the passed ItemIdList is a child of this instance or if it represents the same element as the callee.
Public methodIsSpecialFolder(ShellFolder) Compares the ItemIdList to a ShellFolder.
Public methodIsSpecialFolder(ShellFolder)Compares the ItemIdList to the set of ShellFolder instances.
Public methodStatic memberIsZipArchive Returns true, if the passed ItemIdList is a zip or similar archive.
Public methodLastPart Returns the last part of an ItemIdList as new ItemIdList.
Public methodStatic memberParse Parses the specified p_DisplayPath and returns an ItemIdList instance. Finds physical paths, SpecialFolder names like "My PC" or concatenations of Special Folders and physical paths ("Libraries\Pictures\...", "My PC\c:\windows") Also resolves paths in zip files.
Protected methodReleaseHandle Free the current Win32 ItemIdList.
(Overrides ItemIdListBase2ReleaseHandle)
Public methodReloadReloads the ItemIdList by updating the ShellItem and reassigning the pidl. Turns non-functional ItemIdLists as they are sent by ShellNotifications into functional ones.
Public methodRenameRenames the ItemIdList.
Public methodSetPropertyValueSets a property value.
Top
Fields
 NameDescription
Public fieldStatic memberEmptyIdList An empty ItemIdList.
Top
See Also