ShellBrowser Delphi Components Documentation
ContentsIndexHome
PreviousUpNext
ShellControls.TJamShellTree

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

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

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.  

 

ShellControls.TJamShellTree
 
Name 
Description 
 
Creates an instance of a TJamShellTree component.  
 
Destroys the instance of a JamShellTree component.  
ShellBrowser.IShellCommandInvokable
 
Name 
Description 
 
This event occurs, before a shell context menu command is executed.  
ShellControls.TJamShellTree
 
Name 
Description 
 
Occurs if a new folder is added.  
 
This event occurs, before a context menu command is executed.  
 
Happens when the user starts a shell drag operation.  
 
Allows you to prevent unwanted shell drops.  
 
This event occurs, if the user has selected a menu item of the shell context menu.  
 
This event will be triggered, if the user cancels the rename of a folder and so the name remains unchanged.  
 
The OnOperation event occurs after the TJamShellTreeView executed a shell operation like pasting or dragging and dropping folders.  
 
This event will be triggered whenever the selection changes.  
 
Allows you to influence the Drop Operation that is performed when dropping a shell item.  
 
This event is triggered before and after the sort. 
 
This event is fired, if the state of a checkbox was changed by the user.  
 
Event occurs when a folder is added or updated.  
 
Name 
Description 
 
Gets whether cancellation has been requested for this token. 
Jam.Shell.Types.ICancellationToken
 
Name 
Description 
 
Communicates a request for cancellation. 
Jam.Shell.Types.IUICommandInvokable
 
Name 
Description 
 
Returns the number of selected Objects in the control.  
 
Executes a shell command on the objects selected in the control.  
 
Displays a context menu for the selected items. 
ShellBrowser.IShellCommandInvokable
 
Name 
Description 
 
Getter for the OnBeforeShellCommand property.  
 
Setter for the OnBeforeShellCommand property.  
ShellLink.IJamShellControl
 
Name 
Description 
 
This method is called by the ShellLink instance if the currently selected item has changed. 
 
Getter method for the ShellLink property. 
 
GoUp 
This method indicates that the callee should go up one level and display the contents of the current folder's parent folder. 
 
This method is called by the ShellLink instance if the currently displayed folder has changed. 
 
This method indicates that the control should perform a refresh of its contents. 
 
This method indicates that the callee should select all item it currently displays. 
 
Setter method for the ShellLink property. 
ShellLink.IJamSupportsFilter
 
Name 
Description 
 
Called by the ShellLink instance when the Filter is changed.  
ShellControls.TJamShellTree
 
Name 
Description 
 
With this function you can add an object, which is hidden in the file system, to the tree like administrative shares (\ServerC$).  
 
Adds a new root node to the tree. 
 
Removes all root nodes from the tree.  
 
Creates a new directory in the given path.  
 
Refreshes the contents of the TJamShellTree.  
 
Get the checkbox state of an item.  
 
Returns the node that is found at the specified position. 
 
GoUp 
Goes up one level in the file system structure.  
 
Executes a shell command on the objects selected in the control.  
 
Checks if move is possible.  
 
Returns if the node at the given index is a special folder like the Control Panel.  
 
Jump back and forward to directories, which you selected before.  
 
This method indicates that the control should perform a refresh of its contents.  
 
Refreshes the child nodes of a node in a JamShellTree.  
 
Triggers node sorting or resorting of the node's child nodes 
 
Use this method to select a sub folder of the current selected folder.  
 
Show the context menu for the selected node.  
 
Performs a quick refresh of the contents of the TJamShellTree.  
ShellLink.IJamShellControl
 
Name 
Description 
 
The TJamShellLink instance to which the current control connected. 
ShellControls.TJamShellTree
 
Name 
Description 
 
Determines how the control aligns within its container (parent control). 
 
Allowed effects when dragging files/folders out of the control.  
 
Allowed effects when dropping files/folders on the control.  
 
Specifies how the control is anchored to its parent. 
 
Receives notifications about changes in the shell and performs refreshes automatically.  
 
Determines whether the list view displays a single line border.  
 
Specifies the delay between when a node is selected via keyboard and when the OnChange event occurs.  
 
Turns on/off checkboxes for file and folder selection.  
 
Specifies the background color of the control.  
 
Color compressed files.  
 
Color encrypted files.  
 
Specifies the size constraints for the control. 
 
Use CopyMode to control the Drag'n'Drop behaviour.  
 
Forces the creation of links for dropped objects.  
 
Determines whether a control has a three-dimensional (3-D) or two-dimensional look. 
 
Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.  
 
Specifies the image used to represent the mouse pointer when the control is being dragged. 
 
Specifies whether the control is being dragged normally or for docking. 
 
Specifies how the control initiates drag-and-drop or drag-and-dock operations. 
 
Controls whether the control responds to mouse, keyboard, and timer events.  
 
Can Expand a folder in the tree when selected.  
 
Use FileSystemOnly to determine, if only file system objects should be displayed.  
 
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.  
 
Determines whether the list view gives a visual indication of which item is selected when focus shifts to another control.  
 
History manages a set of paths, which have been visited.  
 
Specifies whether list items are highlighted when the mouse passes over them.  
 
Determines which image list is associated with the tree view. 
 
Specifies the amount of indentation in pixels when a list of child nodes is expanded. 
 
Lists the individual nodes that appear in the tree view control.  
 
Configure if multiple root nodes can be shown. 
 
Prevent the control to be filled on startup of the application.  
 
Allow drag and drop operations with the Explorer.  
 
Occurs when new node is added. 
 
Occurs at discrete stages during the painting of the tree view control. 
 
Occurs at discrete stages during the painting of tree view nodes. 
 
Occurs when an attempt is made to resize the control. 
 
Occurs whenever the selection has changed from one node to another.  
 
Occurs when the selection is about to change from one node to another. 
 
Occurs when the user clicks the control.  
 
Occurs after a node has been collapsed. 
 
Occurs when a node is about to be collapsed. 
 
Occurs when two nodes must be compared during a sort of the nodes in the tree view. 
 
Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard). 
 
OnCreateNodeClass occurs when a new node object is about to be created.  
 
Occurs immediately prior to painting the tree view control. 
 
Occurs immediately prior to painting a node in a tree view control. 
 
Use the OnDblClick event to respond to mouse double-clicks.  
 
Occurs when a node in the tree view is deleted. 
 
Occurs when the user drops an object being dragged. 
 
Occurs when the user drags an object over a control. 
 
Occurs after the user edits the Text property of a node. 
 
Occurs when the user starts to edit the Text property of a node. 
 
Occurs when the dragging of an object ends, either by docking the object or by canceling the dragging. 
 
Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging. 
 
Occurs when a control receives the input focus. 
 
Occurs when the input focus shifts away from one control to another. 
 
Occurs after a node is expanded. 
 
Occurs when a node is about to be expanded. 
 
Occurs when the tree view looks up the ImageIndex of a node. 
 
Occurs when the tree view looks up the ImageIndex of a node. 
 
Occurs when a user presses any key while the control has focus. 
 
Occurs when key pressed.  
 
Occurs when the user releases a key that was pressed. 
 
Occurs when the user presses a mouse button with the mouse pointer over a control. 
 
Occurs when the mouse pointer moves over the control.  
 
Occurs when the mouse pointer moves off from over the control.  
 
Occurs when the user moves the mouse pointer while the mouse pointer is over a control. 
 
Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component. 
 
Occurs when the control is resized. 
 
Occurs when the user begins to drag a control with a DragKind of dkDock. 
 
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. 
 
Specifies where a control looks for its color information. 
 
Determines where a component looks to determine whether it should have a three-dimensional look. 
 
ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property. 
 
Specifies where a control looks for its font information. 
 
Specifies where a control looks to find out if its Help Hint should be shown. 
 
Specifies the pop-up menu associated with the control. 
 
Prevents operations that change the file system from being executed.  
 
Determines whether the Selected property returns nodes that are selected using the right mouse button.  
 
RootedAt determines the root folder of a TJamShellTree.  
 
Determines the root file system folder of a TJamShellTree.  
 
The root node of this treecontrol  
 
Specifies whether the entire row of the selected item is highlighted.  
 
Specifies the selected node in the tree view.  
 
Gets or sets the selected folder.  
 
The ItemIdList of the selected node. 
 
Automatically display the shell context menu.  
 
Connects this component to a JamShellLink in order to synchronize it to other shell controls.  
 
Specifies whether to display plus (+) and minus (-) buttons to the left side of each parent item.  
 
Show the context menu on the top of the supplied Delphi TPopupMenu.  
 
Allow Windows error messages.  
 
The property ShowFiles allows you to include the files in the TJamShellTree, similar to FrontPage 2000.  
 
With this property you can hide or show hidden folders like the recycle bin or some special directories in the Windows folder.  
 
ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. 
 
Specifies whether to display the lines that link child nodes to their corresponding parent nodes.  
 
If set to false, the Network Neighborhood will not be shown. The default value is true.  
 
Use this property to change the look and the objects displayed.  
 
Determines whether the overlay icons are displayed.  
 
Show the Recycle Bin.  
 
Specifies whether lines connecting top-level nodes are displayed.  
 
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.  
 
Set this value to true to avoid too much space between root nodes.  
 
Gets or sets the selected folder type.  
 
Determines which image list to use for state images. 
 
Specifies the style elements that are used by the control. 
 
Specifies the style name for this control. 
 
Indicates the position of the control in its parent's tab order. 
 
Determines whether the user can tab to a control. 
 
Specifies whether the items in the tree view have tool tips. 
 
Touch specifies the touch manager component associated with the control.  
 
Use the same Font as the Windows Explorer.  
 
Use the same styles as the Windows Explorer.  
 
The version number of the ShellBrowser controls. 
 
Determines whether the component appears onscreen.