ShellControls.TJamShellTree

A TJamShellTree control looks and behaves like the left pane of the Windows Explorer.

Syntax

Pascal

TJamShellTree = class(TCustomTreeView, IDropTarget, IDropSource, IJamShellControl, IIconViewer, ICheckBoxViewer, IUICommandInvokable, ICancellationToken, IJamSupportsFilter);

Remarks

A TJamShellTree displays the shell namespace in a tree. When the user right clicks on a folder, it will automatically show the context menu. TJamShellTree is derived from Delphi's TTreeView control, so you can use most of the properties and methods of this class.

Use the SelectedFolder property to get the currently selected path, use the SpecialFolder property to check if a special folder like the Control Panel is currently selected. Usually a TJamShellTree component will be rooted the desktop folder, but you can use the RootedAt property to choose a different root folder. This control does not have a Font property, because it automatically uses the same font the Windows Explorer uses. Use the Popup property to merge your Delphi popup menus with the Shell Context menu. You can synchronize a TJamShellList.ShellLink with a JamShellTree by using the TJamShellList.ShellLink property.

Namespace

ShellControls

Public Methods

ShellControls.TJamShellTree

	Name	Description
	constructor Create(AOwner: TComponent); override;	Creates an instance of a TJamShellTree component.
	destructor Destroy; override;	Destroys the instance of a JamShellTree component.

TJamShellTree Events

ShellControls.TJamShellTree

	Name	Description
	property OnAddFolder: TOnAddNode read fOnAddFolder write fOnAddFolder;	Occurs if a new folder is added.
	property OnBeforeCommand: TOnBeforeCommand read GetOnBeforeCommand write SetOnBeforeCommand;	This event occurs, before a context menu command is executed.
	property OnBeforeShellCommand: TOnBeforeShellCommand read GetOnBeforeShellCommand write SetOnBeforeShellCommand;	This event occurs, before a context menu command is executed. This event is deprecated and will be removed. Use OnBeforeCommand instead.
	property OnBeforeShellDrag: TOnBeforeShellDragEvent read fOnBeforeShellDrag write fOnBeforeShellDrag;	Happens when the user starts a shell drag operation.
	property OnBeforeShellDrop: TOnBeforeShellDropEvent read fOnBeforeShellDrop write fOnBeforeShellDrop;	Allows you to prevent unwanted shell drops.
	property OnContextMenuSelect: TOnContextMenuSelectEvent read fOnContextMenuSelect write fOnContextMenuSelect;	This event occurs, if the user has selected a menu item of the shell context menu.
	property OnEditCanceled: TTVEditCanceled read fOnEditCanceled write fOnEditCanceled;	This event will be triggered, if the user cancels the rename of a folder and so the name remains unchanged.
	property OnOperation: TOnOperation read fOnOperation write fOnOperation;	The OnOperation event occurs after the TJamShellTreeView executed a shell operation like pasting or dragging and dropping folders.
	property OnSelectionChanged: TItemIdListEvent read fOnSelectionChange write fOnSelectionChange;	This event will be triggered whenever the selection changes.
	property OnShellDragOver: TOnShellDragOverEvent read fOnShellDragOver write fOnShellDragOver;	Allows you to influence the Drop Operation that is performed when dropping a shell item.
	property OnSort: TOnSort read fOnSort write fOnSort;	This event is triggered before and after the sort.
	property OnTreeNodeCheckStateChanged: TOnTreeNodeCheckStateChanged read fOnCheckStateChanged write fOnCheckStateChanged;	This event is fired, if the state of a checkbox was changed by the user.
	property OnUpdatedFolder: TOnUpdatedFolder read fOnUpdatedFolder write fOnUpdatedFolder;	Event occurs when a folder is added or updated.

IUICommandInvokable Methods

	Name	Description
	function GetSelCount: Integer;	Returns the number of selected Objects in the control.
	function InvokeCommandOnSelected(const pCommand: TShellCommand): Boolean;	Executes a shell command on the objects selected in the control.
	function ShowContextMenu(const pPosition: TPoint): String;	Displays a context menu for the selected items.

Jam.Threading.ICancellationIndicator

	Name	Description
	function IsCancellationRequested: Boolean;	Gets whether cancellation has been requested for this token.

Jam.Threading.ICancellationToken

	Name	Description
	procedure Cancel;	Communicates a request for cancellation.

ShellLink.IJamShellControl

	Name	Description
	procedure FileChanged(FolderPIDL: IItemIdList; FilePIDL: IItemIdList);	This method is called by the ShellLink instance if the currently selected item has changed.
	function getShellLink: TJamShellLink;	Getter method for the ShellLink property.
	function GoUp: Boolean;	This method indicates that the callee should go up one level and display the contents of the current folder's parent folder.
	procedure PathChanged(FolderPIDL: IItemIdList);	This method is called by the ShellLink instance if the currently displayed folder has changed.
	procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure SelectAll;	This method indicates that the callee should select all item it currently displays.
	procedure setShellLink(aValue: TJamShellLink);	Setter method for the ShellLink property.

ShellLink.IJamSupportsFilter

	Name	Description
	procedure FilterChanged(const Filter: string);	Called by the ShellLink instance when the Filter is changed.

ShellControls.TJamShellTree

	Name	Description
	function AddHiddenItem(const aPath: UnicodeString): TJamShellTreeNode;	With this function you can add an object, which is hidden in the file system, to the tree like administrative shares (\ServerC$).
	function AddRoot(const pAbsoluteItemIdList: IItemIdList; pExpand: Boolean = True): TJamShellTreeNode;	Adds a new root node to the tree.
	procedure ClearRoots;	Removes all root nodes from the tree.
	procedure CreateDir(path: UnicodeString; foldername: UnicodeString; EditMode: Boolean);	Creates a new directory in the given path.
	procedure FullRefresh;	Refreshes the contents of the TJamShellTree.
	function GetItemSelectionState(index: Integer): TJamSelectionState;	Get the checkbox state of an item.
	function GetNodeAt(x: Integer; y: Integer): TJamShellTreeNode;	Returns the node that is found at the specified position.
	function GoUp: Boolean;	Goes up one level in the file system structure.
	function InvokeCommandOnSelected(const pCommand: TShellCommand): Boolean;	Executes a shell command on the objects selected in the control.
	function IsMovePossible(Delta: Integer): Boolean;	Checks if move is possible.
	function IsSpecialObject(nodeindex: Integer): TJamShellFolder; overload;	Returns if the node at the given index is a special folder like the Control Panel.
	function IsSpecialObject(Node: TJamShellTreeNode): TJamShellFolder; overload;	Returns if the given node is a special folder like the Control Panel.
	procedure MoveInHistory(Delta: Integer);	Jump back and forward to directories, which you selected before.
	procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure RefreshNode(Index: Integer; Recursive: Boolean; FullRefresh: Boolean = True); overload;	Refreshes the child nodes of a node in a JamShellTree.
	procedure RefreshNode(Node: TJamShellTreeNode; Recursive: Boolean; FullRefresh: Boolean = True); overload;	Refreshes the child nodes of a node in a JamShellTree.
	procedure Resort(const aNode: TJamShellTreeNode);	Triggers node sorting or resorting of the node's child nodes
	function SelectSubFolder(const foldername: UnicodeString): Boolean;	Use this method to select a sub folder of the current selected folder.
	function ShowContextMenu(const p: TPoint): String;	Show the context menu for the selected node.
	procedure SmartRefresh;	Performs a quick refresh of the contents of the TJamShellTree.

IJamShellControl Properties

ShellLink.IJamShellControl

	Name	Description
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	The TJamShellLink instance to which the current control connected.

ShellControls.TJamShellTree

	Name	Description
	property Align;	Determines how the control aligns within its container (parent control).
	property AllowedDragEffects: TJamDropEffects read fAllowedDragEffects write SetAllowedDragEffects default [deDefault];	Allowed effects when dragging files/folders out of the control.
	property AllowedDropEffects: TJamDropEffects read fAllowedDropEffects write SetAllowedDropEffects default [deDefault];	Allowed effects when dropping files/folders on the control.
	property Anchors;	Specifies how the control is anchored to its parent.
	property AutomaticRefresh: Boolean read GetAutomaticRefresh write SetAutomaticRefresh default True;	Receives notifications about changes in the shell and performs refreshes automatically.
	property BorderStyle;	Determines whether the list view displays a single line border.
	property ChangeDelay read fChangeDelay write SetChangeDelay default cDefaultChangeDelay;	Specifies the delay between when a node is selected via keyboard and when the OnChange event occurs.
	property Checkboxes: Boolean read fCheckBoxes write SetCheckBoxes default false;	Turns on/off checkboxes for file and folder selection.
	property Color;	Specifies the background color of the control.
	property ColorCompressed: Boolean read GetColorCompressed write SetColorCompressed default false;	Color compressed files.
	property ColorEncrypted: Boolean read GetColorEncrypted write SetColorEncrypted default false;	Color encrypted files.
	property Constraints;	Specifies the size constraints for the control.
	property CopyMode: TJamDropEffect read fCopyMode write fCopyMode default deDefault;	Use CopyMode to control the Drag'n'Drop behaviour.
	property CreateLinkOnDrop: Boolean read GetCreateLinkOnDrop write SetCreateLinkOnDrop stored false default false;	Forces the creation of links for dropped objects.
	property Ctl3D;	Determines whether a control has a three-dimensional (3-D) or two-dimensional look.
	property CustomIcons: Boolean read fCustomIcons write SetCustomIcons default true;	If activated, the TGlobalCustomIconHandler will be called, that allows you to set custom icons for list elements instead of using the system icons. If false, the event is not called for items in this instance.
	property DoubleBuffered default True;	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	property DragCursor;	Specifies the image used to represent the mouse pointer when the control is being dragged.
	property DragKind;	Specifies whether the control is being dragged normally or for docking.
	property DragMode default dmAutomatic;	Specifies how the control initiates drag-and-drop or drag-and-dock operations.
	property Enabled;	Controls whether the control responds to mouse, keyboard, and timer events.
	property ExpandOnSelected: Boolean read fExpandOnSelected write fExpandOnSelected default false;	Can Expand a folder in the tree when selected.
	property FileNameFormat: TJamFileNameFormat read fFileNameFormat write fFileNameFormat default TJamFileNameFormat;	Specifies if tree node captions contain a File Extension, or not, or if this according to Windows Explorer settings.
	property FileSystemOnly: Boolean read GetFileSystemOnly write SetFileSystemOnly default false;	Use FileSystemOnly to determine, if only file system objects should be displayed.
	property Filter: UnicodeString read GetFilter write SetFilter;	Allows you to filter files by filename patterns.
	property Font;	Controls the attributes of text written on or in the control. Make sure to turn off UseSystemFont before editing this control! Otherwise the changes will not persist.
	property HideSelection default false;	Determines whether the list view gives a visual indication of which item is selected when focus shifts to another control.
	property History: IJamShellHistory read fHistory;	History manages a set of paths, which have been visited.
	property HotTrack;	Specifies whether list items are highlighted when the mouse passes over them.
	property Images;	Determines which image list is associated with the tree view.
	property Indent default DefaultIndent;	Specifies the amount of indentation in pixels when a list of child nodes is expanded.
	property Items: TJamShellTreeNodes read GetTreeNodes;	Lists the individual nodes that appear in the tree view control.
	property MultipleRoots: TMultipleRoots read GetMultipleRoots write SetMultipleRoots default mrAuto;	Configure if multiple root nodes can be shown.
	property NoFillOnStartup: Boolean read GetNoFillOnStartup write SetNoFillOnStartup default false;	Prevent the control to be filled on startup of the application.
	property OleDragDrop: Boolean read fOleDragDrop write SetOleDragDrop default True;	Allow drag and drop operations with the Explorer.
	property OnAddition;	Occurs when new node is added.
	property OnAdvancedCustomDraw;	Occurs at discrete stages during the painting of the tree view control.
	property OnAdvancedCustomDrawItem;	Occurs at discrete stages during the painting of tree view nodes.
	property OnCanResize;	Occurs when an attempt is made to resize the control.
	property OnChange;	Occurs whenever the selection has changed from one node to another.
	property OnChanging;	Occurs when the selection is about to change from one node to another.
	property OnClick;	Occurs when the user clicks the control.
	property OnCollapsed;	Occurs after a node has been collapsed.
	property OnCollapsing;	Occurs when a node is about to be collapsed.
	property OnCompare;	Occurs when two nodes must be compared during a sort of the nodes in the tree view.
	property OnContextPopup;	Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard).
	property OnCreateNodeClass;	OnCreateNodeClass occurs when a new node object is about to be created.
	property OnCustomDraw;	Occurs immediately prior to painting the tree view control.
	property OnCustomDrawItem;	Occurs immediately prior to painting a node in a tree view control.
	property OnDblClick;	Use the OnDblClick event to respond to mouse double-clicks.
	property OnDeletion;	Occurs when a node in the tree view is deleted.
	property OnDragDrop;	Occurs when the user drops an object being dragged.
	property OnDragOver;	Occurs when the user drags an object over a control.
	property OnEdited;	Occurs after the user edits the Text property of a node.
	property OnEditing;	Occurs when the user starts to edit the Text property of a node.
	property OnEndDock;	Occurs when the dragging of an object ends, either by docking the object or by canceling the dragging.
	property OnEndDrag;	Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging.
	property OnEnter;	Occurs when a control receives the input focus.
	property OnExit;	Occurs when the input focus shifts away from one control to another.
	property OnExpanded;	Occurs after a node is expanded.
	property OnExpanding;	Occurs when a node is about to be expanded.
	property OnGetImageIndex;	Occurs when the tree view looks up the ImageIndex of a node.
	property OnGetSelectedIndex;	Occurs when the tree view looks up the ImageIndex of a node.
	property OnKeyDown;	Occurs when a user presses any key while the control has focus.
	property OnKeyPress;	Occurs when key pressed.
	property OnKeyUp;	Occurs when the user releases a key that was pressed.
	property OnMouseDown;	Occurs when the user presses a mouse button with the mouse pointer over a control.
	property OnMouseEnter;	Occurs when the mouse pointer moves over the control.
	property OnMouseLeave;	Occurs when the mouse pointer moves off from over the control.
	property OnMouseMove;	Occurs when the user moves the mouse pointer while the mouse pointer is over a control.
	property OnMouseUp;	Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.
	property OnMouseWheel;	Occurs when the mouse wheel is rotated.
	property OnResize;	Occurs when the control is resized.
	property OnStartDock;	Occurs when the user begins to drag a control with a DragKind of dkDock.
	property OnStartDrag;	Occurs when the user begins to drag the control or an object it contains by left-clicking the control and holding the mouse button down.
	property ParentColor default false;	Specifies where a control looks for its color information.
	property ParentCtl3D;	Determines where a component looks to determine whether it should have a three-dimensional look.
	property ParentDoubleBuffered default False;	ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
	property ParentFont default false;	Specifies where a control looks for its font information.
	property ParentShowHint;	Specifies where a control looks to find out if its Help Hint should be shown.
	property PopupMenu;	Specifies the pop-up menu associated with the control.
	property ReadOnly;	Prevents operations that change the file system from being executed.
	property RightClickSelect default True;	Determines whether the Selected property returns nodes that are selected using the right mouse button.
	property RootedAt: TJamShellFolder read GetRootedAt write SetRootedAt default SF_DESKTOP;	RootedAt determines the root folder of a TJamShellTree.
	property RootedAtFileSystemFolder: TFileName read fRootedAtFileSystemFolder write SetRootedAtFileSystemFolder;	Determines the root file system folder of a TJamShellTree.
	property RootNode: TJamShellTreeNode read GetRootNode;	The root node of this treecontrol
	property RowSelect write SetRowSelect2;	Specifies whether the entire row of the selected item is highlighted.
	property Selected: TJamShellTreeNode read GetSelected write SetSelected;	Specifies the selected node in the tree view.
	property SelectedFolder: TFileName read GetSelectedFolder write SetSelectedFolder stored NotStoreSpecialFolder;	Gets or sets the selected folder.
	property SelectedItemIdList: IItemIdList read GetSelectedItemIdList write SetSelectedItemIdList;	The ItemIdList of the selected node.
	property ShellContextMenu: Boolean read fContextMenu write fContextMenu default True;	Automatically display the shell context menu.
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	Connects this component to a JamShellLink in order to synchronize it to other shell controls.
	property ShowButtons;	Specifies whether to display plus (+) and minus (-) buttons to the left side of each parent item.
	property ShowContextMenuOnTop: Boolean read GetShowContextMenuOnTop write SetShowContextMenuOnTop default false;	Show the context menu on the top of the supplied Delphi TPopupMenu.
	property ShowErrorMessages: Boolean read GetShowErrorMessages write SetShowErrorMessages default false;	Allow Windows error messages.
	property ShowFiles: Boolean read GetShowFiles write SetShowFiles default false;	The property ShowFiles allows you to include the files in the TJamShellTree, similar to FrontPage 2000.
	property ShowHidden: Boolean read GetShowHidden write SetShowHidden default false;	With this property you can hide or show hidden folders like the recycle bin or some special directories in the Windows folder.
	property ShowHint;	ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control.
	property ShowLines default False;	Specifies whether to display the lines that link child nodes to their corresponding parent nodes.
	property ShowNethood: Boolean read GetShowNethood write SetShowNethood default True;	If set to false, the Network Neighborhood will not be shown. The default value is true.
	property ShowOptions: TJamShellShowOptions read fShowOptions write SetShowOptions stored false;	Use this property to change the look and the objects displayed.
	property ShowOverlayIcons: Boolean read fShowOverlayIcons write SetShowOverlayIcons default True;	Determines whether the overlay icons are displayed.
	property ShowRecycleBin: Boolean read GetShowRecycleBin write SetShowRecycleBin default True;	Show the Recycle Bin.
	property ShowRoot;	Specifies whether lines connecting top-level nodes are displayed.
	property ShowShellNames: Boolean read GetShowShellNames write SetShowShellNames default True;	If set to true (the default value) the potentially localized folder and object names will be shown. If set to false, the names will be used as they occur in the file system.
	property SingleSpacedRoots: Boolean read fSingleSpacedRoots write SetSingleSpacedRoots default false;	Set this value to true to avoid too much space between root nodes.
	property SpecialFolder: TJamShellFolder read GetSpecialFolder write SetSpecialFolder stored StoreSpecialFolder default SF_Desktop;	Gets or sets the selected folder type.
	property StateImages;	Determines which image list to use for state images.
	property StyleElements;	Specifies the style elements that are used by the control.
	property StyleName;	Specifies the style name for this control.
	property TabOrder;	Indicates the position of the control in its parent's tab order.
	property TabStop default True;	Determines whether the user can tab to a control.
	property ToolTips;	Specifies whether the items in the tree view have tool tips.
	property Touch;	Touch specifies the touch manager component associated with the control.
	property UseSystemFont: Boolean read fUseSystemFont write SetUseSystemFont default True;	Use the same Font as the Windows Explorer.
	property UseSystemStyles: Boolean read fUseSystemStyles write SetUseSystemStyles default True;	Use the same styles as the Windows Explorer.
	property Version: UnicodeString read GetVersion stored false;	The version number of the ShellBrowser controls.
	property Visible;	Determines whether the component appears onscreen.

Links

ShellControls, Legend, Members, Public Methods, TJamShellTree Events, IUICommandInvokable Methods, IJamShellControl Properties

Contents | Index | Home