TJamShellTree Class

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

Syntax

Pascal

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

File

ShellControls

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.

Public Methods

TJamShellTree Class

	Name	Description
	Create	Creates an instance of a TJamShellTree component.
	Destroy	Destroys the instance of a JamShellTree component.

public

	Name	Description
	ApplyCheckState	This is ApplyCheckState, a member of class ICheckBoxViewer.

IIconViewer Interface

	Name	Description
	SetIcon	This is SetIcon, a member of class IIconViewer.

IJamShellControl Interface

	Name	Description
	ShellLink	The TJamShellLink instance to which the current control connected.
	FileChanged	This method is called by the ShellLink instance if the currently selected item has changed.
	FullRefresh	This method indicates that the callee should perform a full refresh of its contents. This will usually be an entrie reload of the displyed items.
	getShellLink	Setter method for the ShellLink property.
	GoUp	This method indicates that the callee should go up one level and siplay the contents of the current folder's parent folder.
	PathChanged	This method is called by the ShellLink instance if the currently displayed folder has changed.
	SelectAll	This method indicates that the callee should select all item it currently displays.
	setShellLink	Getter method for the ShellLink property.
	SmartRefresh	This method indicates that the callee should perform a quick refresh of its contents. It is tolerable that changes in metadata are not detected. Removed and deleted items hsould be detected. The runtime of this method should be significantly faster thatn the one of the FullRefresh method.

TJamShellTree Class

	Name	Description
	ChangeDelay	Specifies the delay between when a node is selected and when the OnChange event occurs.
	CreateLinkOnDrop	Forces the creation of links for dropped objects.
	History	History manages a set of paths, which have been visited.
	Images	This is Images, a member of class TJamShellTree.
	Items	Lists the individual nodes that appear in the tree view control.
	MultipleRoots	This is MultipleRoots, a member of class TJamShellTree.
	RootNode	This is RootNode, a member of class TJamShellTree.
	Selected	Specifies the selected node in the tree view.
	SelectedItemIdList	This is SelectedItemIdList, a member of class TJamShellTree.
	ShowOptions	Use this property to change the look and the objects displayed.
	StateImages	This is StateImages, a member of class TJamShellTree.
	AddHiddenItem	With this function you can add an object, which is hidden in the file system, to the tree.
	CreateDir	Creates a new directory in the given path.
	FullRefresh	Refreshes the contents of the TJamShellTree.
	GetFullPath	Returns the file path for a TJamShellTreeNode referenced by its index.
	GetItemSelectionState	Get the checkbox state of an item.
	GetNodeAt	This is GetNodeAt, a member of class TJamShellTree.
	GoUp	Goes up one level in the file system structure.
	InvokeCommandOnSelected	Executes a context menu command for the selected item.
	IsMovePossible	Checks if move is possible.
	IsSpecialObject	Returns if the given item is a special folder like the Control Panel.
	MoveInHistory	Jump back and forward to directories, which you selected before.
	RefreshNode	This is RefreshNode, a member of class TJamShellTree.
	Resort	This is Resort, a member of class TJamShellTree.
	SelectSubFolder	Use this method to select a sub folder of the current selected folder.
	ShowContextMenu	Show the context menu for the selected node.
	SmartRefresh	Performs a quick refresh of the contents of the TJamShellTree.

published

TJamShellTree Class

	Name	Description
	Align	This is Align, a member of class TJamShellTree.
	Anchors	This is Anchors, a member of class TJamShellTree.
	AutomaticRefresh	Receives notifications about changes in the shell and performs refreshes automatically.
	BorderStyle	Determines whether the list view displays a single line border.
	Checkboxes	Turns on/off checkboxes for file and folder selection.
	Color	Specifies the background color of the control.
	ColorCompressed	Color compressed files.
	ColorEncrypted	Color encrypted files.
	Constraints	This is Constraints, a member of class TJamShellTree.
	CopyMode	Use CopyMode to control the Drag'n'Drop behaviour.
	Ctl3D	This is Ctl3D, a member of class TJamShellTree.
	DoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	DragCursor	This is DragCursor, a member of class TJamShellTree.
	DragKind	This is DragKind, a member of class TJamShellTree.
	DragMode	This is DragMode, a member of class TJamShellTree.
	Enabled	Controls whether the control responds to mouse, keyboard, and timer events.
	ExpandOnSelected	Can Expand a folder in the tree when selected.
	FileSystemOnly	Use FileSystemOnly to determine, if only file system objects should be displayed.
	Filter	Allows you to filter files by filename patterns.
	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.
	HideSelection	Determines whether the list view gives a visual indication of which item is selected when focus shifts to another control.
	HotTrack	Specifies whether list items are highlighted when the mouse passes over them.
	Indent	This is Indent, a member of class TJamShellTree.
	NoFillOnStartup	Prevent the control to be filled on startup of the application.
	OleDragDrop	Allow drag and drop operations with the Explorer.
	OnAddFolder	Occurs if a new folder is added.
	OnAddition	This is OnAddition, a member of class TJamShellTree.
	OnAdvancedCustomDraw	This is OnAdvancedCustomDraw, a member of class TJamShellTree.
	OnAdvancedCustomDrawItem	This is OnAdvancedCustomDrawItem, a member of class TJamShellTree.
	OnBeforeShellCommand	This event occurs, before a context menu command is executed.
	OnBeforeShellDrop	Allows you to prevent unwanted shell drops.
	OnCanResize	This is OnCanResize, a member of class TJamShellTree.
	OnChange	Occurs whenever the selection has changed from one node to another.
	OnChanging	This is OnChanging, a member of class TJamShellTree.
	OnCheckStateChanged	This event is fired, if the state of a checkbox was changed by the user.
	OnClick	Occurs when the user clicks the control.
	OnCollapsed	This is OnCollapsed, a member of class TJamShellTree.
	OnCollapsing	This is OnCollapsing, a member of class TJamShellTree.
	OnCompare	This is OnCompare, a member of class TJamShellTree.
	OnContextMenuSelect	This event occurs, if the user has selected a menu item of the shell context menu.
	OnContextPopup	This is OnContextPopup, a member of class TJamShellTree.
	OnCustomDraw	This is OnCustomDraw, a member of class TJamShellTree.
	OnCustomDrawItem	This is OnCustomDrawItem, a member of class TJamShellTree.
	OnDblClick	Use the OnDblClick event to respond to mouse double-clicks.
	OnDeletion	This is OnDeletion, a member of class TJamShellTree.
	OnDragDrop	This is OnDragDrop, a member of class TJamShellTree.
	OnDragOver	This is OnDragOver, a member of class TJamShellTree.
	OnEditCanceled	This event will be triggered, if the user cancels the rename of a folder and so the name remains unchanged.
	OnEdited	This is OnEdited, a member of class TJamShellTree.
	OnEditing	This is OnEditing, a member of class TJamShellTree.
	OnEndDock	This is OnEndDock, a member of class TJamShellTree.
	OnEndDrag	This is OnEndDrag, a member of class TJamShellTree.
	OnEnter	This is OnEnter, a member of class TJamShellTree.
	OnExit	This is OnExit, a member of class TJamShellTree.
	OnExpanded	This is OnExpanded, a member of class TJamShellTree.
	OnExpanding	This is OnExpanding, a member of class TJamShellTree.
	OnGetImageIndex	This is OnGetImageIndex, a member of class TJamShellTree.
	OnGetSelectedIndex	This is OnGetSelectedIndex, a member of class TJamShellTree.
	OnKeyDown	This is OnKeyDown, a member of class TJamShellTree.
	OnKeyPress	Occurs when key pressed.
	OnKeyUp	This is OnKeyUp, a member of class TJamShellTree.
	OnMouseDown	This is OnMouseDown, a member of class TJamShellTree.
	OnMouseEnter	Occurs when the mouse pointer moves over the control.
	OnMouseLeave	Occurs when the mouse pointer moves off from over the control.
	OnMouseMove	This is OnMouseMove, a member of class TJamShellTree.
	OnMouseUp	This is OnMouseUp, a member of class TJamShellTree.
	OnOperation	The OnOperation event occurs after the TJamShellTreeView executed a shell operation like pasting or dragging and dropping folders.
	OnStartDock	This is OnStartDock, a member of class TJamShellTree.
	OnStartDrag	This is OnStartDrag, a member of class TJamShellTree.
	OnUpdatedFolder	Event occurs when a folder is added or updated.
	ParentColor	This is ParentColor, a member of class TJamShellTree.
	ParentCtl3D	This is ParentCtl3D, a member of class TJamShellTree.
	ParentDoubleBuffered	This is ParentDoubleBuffered, a member of class TJamShellTree.
	ParentFont	This is ParentFont, a member of class TJamShellTree.
	ParentShowHint	This is ParentShowHint, a member of class TJamShellTree.
	PopupMenu	This is PopupMenu, a member of class TJamShellTree.
	ReadOnly	Prevents operations that change the file system from being executed.
	RightClickSelect	Determines whether the Selected property returns nodes that are selected using the right mouse button.
	RootedAt	RootedAt determines the root folder of a TJamShellTree.
	RootedAtFileSystemFolder	Determines the root file system folder of a TJamShellTree.
	SelectedFolder	Gets or sets the selected folder.
	ShellContextMenu	Automatically display the shell context menu.
	ShellLink	Connects this component to a JamShellLink in order to synchronize it to other shell controls.
	ShowButtons	Specifies whether to display plus (+) and minus (-) buttons to the left side of each parent item.
	ShowContextMenuOnTop	Show the context menu on the top of the supplied Delphi TPopupMenu.
	ShowErrorMessages	Allow Windows error messages.
	ShowFiles	The property ShowFiles allows you to include the files in the TJamShellTree, similar to FrontPage 2000.
	ShowHidden	With this property you can hide or show hidden folders like the recycle bin or some special directories in the Windows folder.
	ShowHint	This is ShowHint, a member of class TJamShellTree.
	ShowLines	Specifies whether to display the lines that link child nodes to their corresponding parent nodes.
	ShowNethood	If set to false, the Network Neighborhood will not be shown. The default value is true.
	ShowOverlayIcons	Determines whether the overlay icons are displayed.
	ShowRecycleBin	Show the Recycle Bin.
	ShowRoot	Specifies whether lines connecting top-level nodes are displayed.
	SpecialFolder	Gets or sets the selected folder type.
	TabOrder	This is TabOrder, a member of class TJamShellTree.
	TabStop	This is TabStop, a member of class TJamShellTree.
	ToolTips	This is ToolTips, a member of class TJamShellTree.
	UseSystemFont	Use the same Font as the Windows Explorer.
	UseSystemStyles	Use the same styles as the Windows Explorer.
	Version	The version number of the ShellBrower controls.
	Visible	Determines whether the component appears onscreen.

Links

Members, public, published

Contents | Index | Home