ShellBrowser.TItemIdListCollection

Class which is allows to deal with multiple paths and ItemIdLists for that a common operation should be performed.

Syntax

Pascal

TItemIdListCollection = class(TInterfacedObject, IItemIdListCollection, IShellItemArray, IContextMenu);

Remarks

This class is reference counted since V11 and should be used with our interface IItemIdListCollection. It also implements the Shell API interface IShellItemArray via interface delegation.

See Also

TShellBrowser.MultiObjects

Example

To create an IDataObject from some paths use code like this:

function TForm1.CreateDataObject(Sender: TBaseVirtualTree; out DataObject: IDataObject);
var
  lMultiObjects: IItemIdListCollection;
begin
  lMultiObjects := TItemIdListCollection.Create(nil);
  lMulitObjects.Add('C:WindowsExplorer.exe');
  lMulitObjects.Add('C:WindowsRegedit.exe');
  DataObject := IDataObject(lMultiObjects.GetUIObject(IDataObject));
end;

Namespace

ShellBrowser

Public Methods

ShellBrowser.TItemIdListCollection

	Name	Description
	constructor Create; overload;	Creates an instance of this class.
	constructor Create(const pDataObject: IDataObject); overload;	Creates an instance of this class and fills it with a given IDataObject.
	constructor Create(const pBaseFolder: IShellFolder); overload;	Creates an instance of this class.
	constructor Create(const pShellItemArray: IShellItemArray); overload;	Creates an instance of this class and fills it with a given IShellItemArray.
	destructor Destroy; override;	Destroys the instance of this class

ICommandInvokable Methods

	Name	Description
	procedure InvokeCommand(const pCommand: TShellCommand);	Executes a shell command on the objects selected in the control.

Jam.Shell.Types.IItemIdListCollection

	Name	Description
	procedure Add(const pItemIdList: IItemIdList); overload;	Adds the given ItemIdList to this collection.
	procedure Add(const pItemIdListCollection: IItemIdListCollection); overload;	Adds the elements of the given IItemIdListCollection to this instance.
	procedure Add(const pPath: string); overload;	Adds the given path to this collection.
	procedure AddStrings(pPaths: TStrings);	Adds the given paths to this collection.
	procedure Clear;	Removes all elements.
	function Count: Integer;	Returns the number of objects in this collection.
	function GetEnumerator: TListOfItemIdList;	Returns the enumerator for all IItemIdLists in this collection.
	function GetItem(pIndex: Integer): IItemIdList;	Getter for the Items property.
	function GetUIObject(const pInterfaceID: TGUID): IInterface;	Wrapper for IShellFolder.GetUIObjectOf() which retrieves a COM object for the ItemIdLists in this collection.
	procedure InvokeCommand(const pCommand: string = 'DEFAULT'); overload;	Executes a Shell context menu command for all ItemIdLists in this collection
	function ToString: string;	Executes a Shell context menu command for all ItemIdLists in this collection Returns the string representation of the value.

ShellBrowser.TItemIdListCollection

	Name	Description
	procedure Add(const pItemIdList: IItemIdList); overload;	Adds the given ItemIdList to this collection.
	procedure Add(const pItemIdListCollection: IItemIdListCollection); overload;	Adds the elements of the given IItemIdListCollection to this instance.
	procedure Add(const pPath: string); overload;	Adds the given path to this collection.
	procedure AddStrings(pPaths: TStrings);	Adds the given paths to this collection.
	procedure Assign(const pIdLists: TArray<IItemIdList>); overload;	Replaces the current members in this collection with the given ItemIdLists.
	procedure Assign(pPaths: TStrings); overload;	Replaces the current members in this collection with the given paths.
	procedure Clear;	Removes all elements.
	procedure CopyTo(pChangeNotifier: TJamShellChangeNotifier); overload; deprecated;	Copies the items included in this collection at a TJamShellChangeNotifier.
	procedure CopyTo(pStringList: TStrings); overload;	Copies the items included in this collection at a list of strings.
	function Count: Integer;	Returns the number of objects in this collection.
	function GetEnumerator: TListOfItemIdList;	Returns the enumerator for all IItemIdLists in this collection.
	function GetLongestCommonAncestor: IItemIdList; overload;	Returns the ItemIdList of a parent folder that is a common ancestor for all included ItemIdLists.
	function GetUIObject(const pInterfaceID: TGUID): IInterface;	Wrapper for IShellFolder.GetUIObjectOf() which retrieves a COM object for the ItemIdLists in this collection.
	function HaveSameParent: Boolean;	Returns if the ItemIdLists in this collection all have the same direct parent.
	function ToString: string; override;	Returns the path of all elements in this instance as string.

IItemIdListCollection Properties

Jam.Shell.Types.IItemIdListCollection

	Name	Description
	property Items [Index: Integer]: IItemIdList read GetItem;	Allows to access the IItemIdLists in this collection by index.

ShellBrowser.TItemIdListCollection

	Name	Description
	property BaseFolder: IShellFolder read fBaseFolder write fBaseFolder;	If this property is assigned, all itemidlists must be relative to this folder, otherwise they are absolute
	property Items [Index: Integer]: IItemIdList read GetItem;	Allows to access the IItemIdLists in this collection by index.

Links

ShellBrowser, Legend, Members, Public Methods, Example, ICommandInvokable Methods, IItemIdListCollection Properties, See Also

Contents | Index | Home