ShellControls.TJamShellListItem

Objects of the type TJamShellListItem are used to populate the TJamShellList control.

Syntax

Pascal

TJamShellListItem = class(TJamCheckableListItem);

Remarks

The TJamShellListItem provides extended information compared to the ListItem, which it is derived from. Each node represents an item of the shell namespace and provides information like the FullPath or more detailed information, like if it is a folder, compressed or encrypted. Of course it also offers the user the method GetNextItem to iterate over the items.

Namespace

ShellControls

Public Methods

	Name	Description
	constructor Create(AOwner: TListItems); override;	Creates an instance of a TJamCheckableListItem component.
	destructor Destroy; override;	Destructor of a TJamCheckableListItem component.

ShellControls.TJamShellListItem

	Name	Description
	constructor Create(AOwner: TListItems); override;	Creates an instance of a TJamShellListItem component.

TJamCheckableListItem Methods

	Name	Description
	procedure FullRefresh; virtual;	Reloads the complete item.
	function GetNextItem(Direction: TSearchDirection; States: TItemStates): TJamCheckableListItem;	Call GetNextItem to find the next list item after StartItem in the given direction. Only items in the state indicated by the States parameter are considered.
	function GetValue(pColumnId: TShellColumnId; pLoaded: Boolean = true): string;	Retrieves the value for a column and returns the value as string.
	procedure SetValue(const pSubItemIndex: integer; const pValue: string); overload;	Sets the subitem value or the caption.
	procedure SetValue(const pSubItemIndex: integer; const pValue: string; const pVariantValue: Variant); virtual; overload;	Sets the subitem value or the caption.

ShellControls.TJamShellListItem

	Name	Description
	function Compare(const pRelativeItemIdList: IItemIdList; pShellIndex: Integer = -1): Integer; override; overload;	Compares a given ItemIdList with this item based on the current TJamShellList.SortColumn.
	function Compare(pItem2: TJamCheckableListItem): Integer; override; overload;	Compares a given TJamFileListItem with this item based on the current TJamShellList.SortColumn.
	function GetNextItem(Direction: TSearchDirection; States: TItemStates): TJamShellListItem;	Returns the next list item after the StartItem in the specified direction.

TJamCheckableListItem Properties

	Name	Description
	property AbsoluteItemIdList: IItemIdList read GetAbsoluteItemIdList write SetAbsoluteItemIdList;	AbsoluteItemIdList returns a pointer to a fully qualified ItemIdList of the current object.
	property Caption: string read GetCaption write SetCaption;	See TListItem.Caption
	property Checked: Boolean read GetChecked write SetChecked;	If this property is set to true, the corresponding file or folder will be marked as checked and added to the TJamSelectionList. If it set to false, it will be marked as unchecked and automatically removed from the TJamSelectionList.
	property CheckState: TJamSelectionState read GetCheckState write SetCheckState;	This property is used to determine, if it is fully, partially or not checked.
	property Initialized: Boolean read fInitialized;	Indicates whether the item has been initialized.
	property ListView: TJamBaseShellListView read GetListView;	Indicates the list view control that displays the list item.
	property Path: UnicodeString read GetPath;	Use the property Path to get the fully qualified path of the current object.
	property RelativePIDL: IItemIdList read GetRelativePIDL write fRelativeItemIdList;	Use the property Path to get the full qualified path of the current object.
	property SubItems: TStrings read GetSubitems write SetSubitems;	Get or set the subitems of the current item.
	property TextColor: TColor read fTextColor write SetTextColor default clWindowText;	Defines the color of the text of this item.

ShellControls.TJamShellListItem

	Name	Description
	property FullPath: UnicodeString read GetPath;	Use the property FullPath to get the full qualified path of the current object.
	property IsCompressed: Boolean read GetIsCompressed write SetIsCompressed;	Use the property IsCompressed to check if the current object is compressed.
	property IsEncrypted: Boolean read GetIsEncrypted write SetIsEncrypted;	Use the property IsEncrypted to check if the current object is encrypted.
	property IsFolder: Boolean read GetIsFolder;	Use the property IsFolder to check if the current object is a folder.
	property IsParentFolderItem: Boolean read GetIsParentFolderItem;	Use this property to determine if the current object is the additional ".." folder, that allows the user to navigate to the parent folder of the current folder.
	property ListView: TJamShellList read GetListView;	Indicates the container control.
	property Owner: TJamShellListItems read GetJamOwner;	Specifies the TListItems object that owns the list item.
	property VariantColumnTexts: VariantArray read fVariantColumnTexts write fVariantColumnTexts;	This array holds the column texts of the item. It`s filled in FillSubitems.

Links

ShellControls, Legend, Members, Public Methods, TJamCheckableListItem Methods, TJamCheckableListItem Properties

Contents | Index | Home