ShellControls.TJamShellTreeNode

Objects of the type JamShellTreeNode are used to populate the TJamShellTree control.

Syntax

Pascal

TJamShellTreeNode = class(TTreeNode);

Remarks

The JamShellTreeNode provides extended information compared to the TreeNode, 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 methods to iterate through the tree structure, e.g. like GetFirstChild, GetNext or GetNextSibling.

Namespace

ShellControls

Public Methods

	Name	Description
	constructor Create(AOwner: TTreeNodes); override;	Creates an instance of a TJamShellTreeNode component.
	destructor Destroy; override;	Destroys an instance of a TJamShellTreeNode component

TJamShellTreeNode Methods

	Name	Description
	function Compare(pAbsoluteItemIdList: IItemIdList): HRESULT; overload; deprecated;	Compares a given ItemIdList with this shell object
	function Compare(pNode: TJamShellTreeNode; pShellBrowser: TShellBrowser = nil): HRESULT; overload;	Compares a given TJamShellTreeNode with this object
	procedure Expand(Recurse: Boolean);	See TTreeNode.Expand
	function GetDropTarget: IDropTarget;	Returns the Windows IDropTarget interface for this item.
	function getFirstChild: TJamShellTreeNode;	Call GetFirstChild to get the first subnode of a node.
	function GetLastChild: TJamShellTreeNode;	Call GetLastChild to get the last subnode of a node.
	function GetNext: TJamShellTreeNode;	Returns the next node after the calling node in the tree view. To get the next node at the same level as the calling node, use GetNextSibling.
	function GetNextChild(Value: TJamShellTreeNode): TJamShellTreeNode;	Call GetNextChild to locate the next node in the list of immediate children of the tree view node.
	function getNextSibling: TJamShellTreeNode;	GetNextSibling will return the next node, regardless of whether it's visible. To find the next node in the tree view including child nodes, use GetNext.
	function getPrevSibling: TJamShellTreeNode;	Returns the previous node before the calling node and at the same level.
	procedure Refresh(Recursive: Boolean);	Refreshes the child nodes of a node.

TJamShellTreeNode Properties

	Name	Description
	property AbsoluteItemIdList: IItemIdList read fAbsoluteItemIdList;	AbsoluteItemIdList returns a pointer to a fully qualified ItemIdList of the current object.
	property Checked: Boolean read GetChecked write SetChecked;	Use Checked to manually mark an item as checked or unchecked.
	property CheckState: TJamSelectionState read GetJamSelectionState write SetJamSelectionState;	Use CheckState to determine if it is fully, partially or not checked.
	property FullPath: UnicodeString read GetFullPath;	Use the property FullPath to get the full qualified path of the current object.
	property IsCompressed: Boolean read GetIsCompressed;	Use the property IsCompressed to check if the current object is compressed.
	property IsEncrypted: Boolean read GetIsEncrypted;	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 IsGap: Boolean read GetIsGap;	Additional empty nodes are added to the ShellTree to introduce space between single root nodes. You can use this property to detect those nodes when e.g. iterating through the list.
	property Item [Index: Integer]: TJamShellTreeNode read GetItem;	Provides access to a child node by its position in the list of child nodes.
	property Parent: TJamShellTreeNode read GetParent;	Indicates the parent node of the current node.
	property ShellChangeNotifier: TJamShellChangeNotifier read GetShellChangeNotifier;	Returns the TJamShellChangeNotifier that is responsible for this node.
	property SpecialFolder: TJamShellFolder read GetSpecialFolder;	Gets the folder type.
	property TextColor: TColor read fTextColor write SetTextColor default clWindowText;	Defines the color of the text of this item.
	property TextStyle: TFontStyles read fTextStyle write SetTextStyle;	Defines the color of the text of this item.
	property TreeView: TJamShellTree read GetTreeView;	Indicates the container control.

Links

ShellControls, Legend, Members, Public Methods, TJamShellTreeNode Methods, TJamShellTreeNode Properties

Contents | Index | Home