ShellTreeView Class

A ShellTreeView displays the shell namespace in a tree. When the user right clicks on a folder, it will automatically show the context menu. Use the SelectedPath property to get the currently selected path, use the SpecialFolder property to check if a special folder like the Control Panel is currently selected. You can configure the root nodes using the MultipleRoots property. A single root can be configured using the RootedAt or RootedAtFileSystemFolder properties. Set the ShellControlConnector to synchronize the ShellTree with other components, like a ShellListView. The AddTreeNode event can be used to customize single nodes in the Tree, including the icons that are displayed.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsTreeView
          Jam.ShellShellTreeView

Namespace: Jam.Shell
Assembly: ShellBrowser (in ShellBrowser.dll) Version: 7.1

Syntax

C++

Copy

public class ShellTreeView : TreeView, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification, IComparer, 
	IShellCommandInvokable

Public Class ShellTreeView
	Inherits TreeView
	Implements IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification, 
	IComparer, IShellCommandInvokable

public ref class ShellTreeView : public TreeView, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification, IComparer, 
	IShellCommandInvokable

type ShellTreeView =  
    class
        inherit TreeView
        interface IShellControl
        interface IShellControlConnectorTarget
        interface ISupportInitialize
        interface ISupportInitializeNotification
        interface IComparer
        interface IShellCommandInvokable
    end

The ShellTreeView type exposes the following members.

Constructors

	Name	Description
	ShellTreeView	Initializes a new instance of the ShellTreeView class.

Top

Properties

	Name	Description
	AllowDrag	Use this property to turn on or off drag support with the Windows Explorer.
	AllowDrop	Use this property to turn on or off drag and drop support with the Windows Explorer. (Overrides ControlAllowDrop.)
	AutoExpandDelay	The delay in milliseconds after that a folder is expanded automatically during a drag and drop operation. A value of 0 disables the auto expand feature.
	AutomaticRefresh	Enables the automatic refreshes of the control, e.g. when a file is added or deleted in the current directory.
	AutoScrollDelay	The delay in milliseconds after that the control scrolls automatically during a drag and drop operation. A value of 0 disables the auto scroll feature.
	BackColor	A System.Drawing.Color that represents the background color of the control. The default is the value of the System.Windows.Forms.Control.DefaultBackColor property. (Overrides TreeViewBackColor.)
	ChangeDelay	Specifies the delay between when a node is selected and when the handling of this change is processed.
	CheckBoxes	Use this property to turn on or off the checkboxes for file and folder selection. The checkboxes will only work, if a ShellControlConnector instance has been assigned to the ShellControlConnector property of this component. It will automatically synchronize the selection state of the items in multiple shell controls linked together with this ShellControlConnector.
	CheckBoxMode	Use this property to display checkboxes for the control.
	CompactRoots	Reduces the space between the root nodes of the Tree.
	ContextMenuStrip	The ContextMenuStrip is converted to an ordinary ContextMenu. This makes it possible to merge your ContextMenuStrip with the Default ShellContextMenu provided by the system. The "Opening" and "Closing" events of the ContextMenuStrip will be raised if the ContextMenu "Popup"/"Collapse" event occurs. For menu items only the "Click" event is available. All other events are not available. All ToolStripMenuItems are converted, and ToolStripSeparators are recognized. The ShortCut Keys defined in a ToolStripMenuItem are not converted. If you would like to have the ShortCut-Keys, leave this Property null, instead set the ContextMenu property to your menu explicitly.
	CopyMode	Copy mode allows you to control the behaviour when files or folders get dropped.
	CustomImages	Contains an ImageList holding custom icons.
	DrawMode	The value of the DrawMode property must always be TreeViewDrawMode.OwnerDrawAll. This is why the Property is reimplemented here. A different setting is ignored, and a debug message is shown.
	EmptyIconIndex	Gets the zero-based index of the empty icon.
	FileNameFormat	Specifies, whether filename are presented with file extensions or not. By default, this depends on the respective setting in Windows Explorer.
	FileSystemOnly	If FileSystemOnly is set to True, objects and virtual folders which do not have a file system path, will not be displayed. Exceptions are 'My Computer', 'Libraries' and 'Network'
	Filter	You can use a single pattern, e.g. '.doc' or concatenate several patterns using semicolons to separate them, e.g. '.exe;*.com'.
	Font	The font used to display text in the control. (Overrides ControlFont.)
	HideSelection	Gets or sets a value indicating whether the selected tree node remains highlighted even when the tree view has lost the focus.
	ImageIndex	Not supported.
	ImageList	Gets or sets a list of images.
	IsEditing	Gets a value indicating whether the SelectedNode is in editing state.
	IsInitialized	Gets a value indicating whether the component is initialized.
	IsInitializing	The value this property is true between the calls BeginIniti() and EndInit() of the ISupportInitialize interface.
	ItemHeight	Gets or sets the height of each tree node in the tree view control.
	LabelEdit	Gets or sets a value indicating whether the label text of the tree nodes can be edited.
	LargeIcons	Set or get the ImageSize. True for LargeIcons, false for SmallIcons.
	MultipleRoots	Configuration of the roots that are displayed in the ShellTreeView
	Nodes	Returns a collection containing all child ShellTreeNodes of this ShellTreeNode.
	NoFillOnStartup	If set to true, the control will not fill automatically after it was created. The FullRefresh method must be called explicitly. Since filling shell control with the appropriate items is a costly operation, this property can be useful to prevent unnecessary refreshes of the control.
	ReadOnly	If true, the folder actions changing the contents of the folder are not allowed. E.g.: Adding, removing or renaming files via context menu, DragDrop, Copy/Paste.
	RootedAt	Defines the root folder of this ShellTreeView
	RootedAtFileSystemFolder	Determines the root file system folder of a ShellTreeView.
	RootNode	Returns the first root element of the type ShellTreeNode of this shell treeview.
	SelectedImageIndex	Not supported.
	SelectedNode	Gets or sets the tree node that is currently selected in the ShellTreeView control.
	SelectedPath	Use SelectedPath to get or set the path, which is currently selected in the ShellTreeView. If the currently selected path is not a file system folder, SelectedPath returns an empty string and you should use the SpecialFolder property to get the type of this path. If you`re looking for the path an operation was performed on (e.g. Drop), use the OperationPerformed event.
	ShellChangeNotifier	Returns the reference to the ShellChangeNotifier that is associated with this instance.
	ShellContextMenu	Indicates whether the Windows ShellContextMenu should be shown or not.
	ShellControlConnector	Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
	ShellDragDrop	Activates/deactivates the internal drag drop handling of the component.
	ShowColorCompressed	If set, compressed files an folders will be shown in that particular Color, if null have show normally
	ShowColorEncrypted	If set, encrypted files an folders will be shown in that particular color, show normally otherwise (if null).
	ShowContextMenu	If set to true, the Windows Explorer context menu will be shown, if the user right-clicks.
	ShowErrorMessages	If set to true, messages boxes will be shown to the user for errors that occured. If set to false, errors will be handled as well, but no message will be shown to the user.
	ShowFiles	If set to true, files will be shown in the control. If set to false, files will not be visible in the control.
	ShowHidden	Is set to 'true', hidden elements will be shown too.
	ShowLines	Indicates whether lines are displayed between tree nodes.
	ShowNetHood	If set to 'false', the Network Neighbourhood will be hidden.
	ShowOverlayIcons	If set to 'false', no overlay icons will be show, which improves the performance of the control.
	ShowRecycleBin	If set to true, the recycly bin will be visible. If set to false, the recycle bin will be hidden.
	ShowShellContextMenuOnTop	If set to to 'true', the shell context menu will be shown on top of the provided popup menu. If set to 'false', the shell context menu will be shown below the provided popup menu. The value true is currently not supported. The menu items will be shown correctly, however their Click event cannot be triggered.
	SpecialFolder	SpecialFolder allows you to check, if the currently selected folder is a special folder (e.g. the Control Panel) or to make a special folder the selected folder. Use the SelectedPath property if you want to deal with file system folders.
	UseSystemFont	Set this property to true if you want the component to utilize the default system font. It is also set to true if the UseSystemStyles property is set.
	UseSystemStyles	Use this property to turn on or off the usage of the system specific design, i.e. enable Vista visual styles of the explorer components.
	Version	The current version of the ShellBrowser.

Top

Methods

	Name	Description
	AddRoot(ItemIdList)	Adds a root.
	AddRoot(ShellFolder)	Adds a root.
	AddRoot(String)	Adds a root.
	AddShellItem	This methods adds the currently active object of the m_ShellBrowser to the TreeNode.
	BeginInit	Signals the object that initialization is starting.
	CanNavigate	Called, before the ShellList displays a new folder. Calls the CanNavigate(Object, ItemIdList) implementation if assigned.
	ChangeNotificationHandler	This method gets called by the ShellChangeNotifier object and informs about changes in the current folder. It sets the cursor of the ShellTreeView to the correct position if i.e. a file was renamed, a network drive was unmounted, etc.
	ClearRoots	Clears all roots in the ShellTreeView.
	Compare	Compares two ShellTreeNode objects by their ItemIdList.
	CompleteDetails	Completes the visual details of the given item, e.g. icon, overlay image etc.
	CreateDir(String, Boolean)	This method creates a new directory with the name of the string argument p_FolderName in the currently SelectedPath. If EditMode is True, the new folder will be switched to the edit mode after creation so that the user can change its name.
	CreateDir(String, String, Boolean)	This method creates a new directory with the name of the string argument foldername in the given path. If EditMode is True, the new folder will be switched to the edit mode after creation so that the user can change its name.
	CreateShellTreeNode	This methods creates a new ShellTreeNode but does not yet include it in the parentNode.
	DisplayContextMenu	Shows the shell context menu for the currently selected item
	Dispose	Remove reference to ShellControlConnector and implicitely remove this control from the list of known controls of the ShellControlConnector (Overrides TreeViewDispose(Boolean).)
	DoBeforeShowContextMenu	Calls the BeforeShowContextMenu event if assigned.
	EnableSystemStyles	Sets system specific behaviour, i.e. disables the lines in the ShellTreeView for Vista and upwards.
	EndInit	Signals the object that initialization is complete.
	FillFolder	Fills in the subfolders in a node
	FindNode(ItemIdList, Boolean)	Searches for the first node, that represents the passed ItemIdList. Checks all roots in the ShellTree.
	FindNode(ItemIdList, Boolean, ShellTreeNode)	Searches for the first node, that represents the passed ItemIdList. Checks all roots in the ShellTree.
	FindNode(ShellTreeNode, ItemIdList, Boolean, ShellTreeNode)	Searches for the first node, that represents the passed ItemIdList.
	FolderChanged	Change the current folder to the one given in parameter throws ArgumentNullException if the argument was null
	FullRefresh	Use the FullRefresh method if you want to refresh a ShellTreeView. All expanded branches of the file system structure will be refreshed. If you just want to refresh one node and its child nodes, use the RefreshNode(ShellTreeNode, Boolean, Boolean) method.
	GotoFolderIdList(ItemIdList)	Selects the ShellTreeNode for the given ItemIdList.
	GotoFolderIdList(ItemIdList, ShellTreeViewGotoFolderIdListAction)	Tries to find the ShellTreeNode for the given ItemIdList and executes the requested action on it.
	GoUp	Go up one level in the tree, does nothing if the SelectedNode is null of if the SelectedNode has no Parent (is root)
	InformPathChanged	Informs the ShellControlConnector that the selected shell folder has changed.
	InvokeCommandOnSelected	Invokes the Command given as a parameter on the currently selected Node, any necessary events are created
	OnAddTreeNode	Fires an event if an item is added to the tree.
	OnAfterInvokeCommand	Is called after the command has been called.
	OnAfterLabelEdit	This event is triggered if the user edited a treenode and renamed it it is only active if the property base.LabelEdit was set to true (Overrides TreeViewOnAfterLabelEdit(NodeLabelEditEventArgs).)
	OnAfterSelect	This member overrides OnAfterSelect(TreeViewEventArgs) (Overrides TreeViewOnAfterSelect(TreeViewEventArgs).)
	OnBeforeCollapse	Raises the BeforeCollapse event. (Overrides TreeViewOnBeforeCollapse(TreeViewCancelEventArgs).)
	OnBeforeExpand	This event is triggered before a tree node is expanded, by clicking on 'plus', in case the node has not been expanded before, it will instantly be filled with the files found in that particular path (by AddShellItem(ShellTreeNode, ShellBrowser)) (Overrides TreeViewOnBeforeExpand(TreeViewCancelEventArgs).)
	OnBeforeInvokeCommand	Is called before the command is called.
	OnBeforeLabelEdit	This event is triggered if the user just starts editing a label (Overrides TreeViewOnBeforeLabelEdit(NodeLabelEditEventArgs).)
	OnBeforeShellDrop	Calls the BeforeShellDrop event if it is assigned.
	OnBeforeShowContextMenu	Calls the BeforeShowContextMenu event.
	OnCheckStateChanged	Fires an event if the CheckState of an item has changed.
	OnCreateControl	Raises the CreateControl method. (Overrides ControlOnCreateControl.)
	OnDoubleClick	Override the OnDoubleClick event to try to perform the default action for the selected object if it is a file. (Overrides ControlOnDoubleClick(EventArgs).)
	OnDragDrop	This member overrides OnDragDrop(DragEventArgs) (Overrides ControlOnDragDrop(DragEventArgs).)
	OnDragEnter	This member overrides OnDragEnter(DragEventArgs) (Overrides ControlOnDragEnter(DragEventArgs).)
	OnDragLeave	This member overrides OnDragLeave(EventArgs) (Overrides ControlOnDragLeave(EventArgs).)
	OnDragOver	This member overrides OnDragOver(DragEventArgs) (Overrides ControlOnDragOver(DragEventArgs).)
	OnDrawNode	Loads the node and raises the draw tree node event. (Overrides TreeViewOnDrawNode(DrawTreeNodeEventArgs).)
	OnFolderUpdated	Fires the FolderUpdated event with the given argument and "this" as the sender
	OnHandleCreated	This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. (Overrides TreeViewOnHandleCreated(EventArgs).)
	OnItemChecked	Raises the OnItemCheckedEvent.
	OnItemDrag	This member overrides OnItemDrag(ItemDragEventArgs) (Overrides TreeViewOnItemDrag(ItemDragEventArgs).)
	OnKeyDown	Overrides the OnKeyDown event to handle key strokes for the currently selected item. Currently, if the spacebar is pressed, the checkboxes are toggled. (Overrides TreeViewOnKeyDown(KeyEventArgs).)
	OnKeyUp	Overrides the OnKeyUp event to handle key strokes for the currently selected item e.g. the ContextMenuPopup key (Overrides TreeViewOnKeyUp(KeyEventArgs).)
	OnMouseUp	Overrides the OnMouseUp event, to handle e.g. double clicks and right clicks on files or folders (Overrides ControlOnMouseUp(MouseEventArgs).)
	OnOperation	Fires an event if an operation was performed on the ShellTreeView, i.e. an Item was pasted.
	Refresh(RefreshLevel)	This method indicates that the control should perform a refresh of its contents.
	Refresh(RefreshLevel, ItemIdList)	This method indicates that the control should perform a refresh of its contents.
	RefreshNode	Refreshes a Node, by clearing its content, and refilling the sub-tree with new, probably more current information from the file-system OnBeforeExpand(TreeViewCancelEventArgs)
	ScaleControl	Scales a control's location, size, padding and margin. (Overrides ControlScaleControl(SizeF, BoundsSpecified).)
	SelectedFileChange	Change the currently selected file, if ShowFiles is true throws ArgumentNullException if the argument was null
	SelectSubFolder	Selects a sub folder (if existant) of the name given as a parameter if p_FolderName is null an ArgumentNullException is thrown. if no node is currently selected nothing happens and false is returned. if no sub folder of the given name exists the method returns false as well.
	SetFont	Sets the font without adjusting other properties.
	ShowContextMenuForNode	Shows the shell context menu for the item given as a parameter
	SmartRefresh	Use the SmartRefresh to update the contents of a ShellTreeView. In comparison to the FullRefresh method, SmartRefresh is much faster, but only removes objects which have been deleted and adds objects which have been added. It doesn't update changed file sizes or dates. Usually this method will be called automatically, when a file was added or deleted.
	WndProc	Overrides the WindProc function and filters ERASEBKGND to avoid flickering. (Overrides TreeViewWndProc(Message).)

Top

Events

	Name	Description
	AddTreeNode	This Event is triggered every time a ShellTreeNode is added to the ShellTreeView, that is, it's structure changed. You can use it to check and suppress nodes from being added to the ShellTreeView.
	BeforeInvokeCommandOnSelected	Obsolete. Assign this event to be able to control the behaviour of the control when the user double-clicks on an item to start the default action
	BeforeShellCommand	This event is fired when a shell command is to be executed, ie. via the context menu It is possible to permit the execution of the shell command by modifying the BeforeShellCommandEventArgs
	BeforeShellDrop	This event is fired before a ShellTreeView executes a shell drop.
	BeforeShowContextMenu	This event is called before the ShellContextMenu is displayed. You may use it to cancel the context menu appearing or to modify the custom menu entries in the ContextMenuStrip.
	CheckStateChanged	This event is fired when the state of a checkbox was changed by the user.
	FolderUpdated	This Event is triggered every time the details of a Node are updated
	Initialized	Occurs when initialization of the component is completed.
	NodeChecked	Occurs when the checked state of an item was changed by the user.
	OperationPerformed	This event is fired after a ShellTreeView executed a shell operation like pasting.
	ShowOptionChanged	This event is fired after a ShellTreeView executed a shell operation like pasting.

Top

Extension Methods

	Name	Description
	HandleNeeded	A Control extension method that ensures that the handle for a control is created. (Defined by ExtensionMethods.)
	ScaledPixels	An extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with. (Defined by ExtensionMethods.)
	ScaleFont	A Control extension method that scales font according to the passed factor. (Defined by ExtensionMethods.)

Top

Reference

Jam.Shell Namespace