ShellTreeView Class |
Wrapper for the Winforms ShellTreeView.
Inheritance HierarchySystemObject
System.Windows.ThreadingDispatcherObject
System.WindowsDependencyObject
System.Windows.MediaVisual
System.WindowsUIElement
System.WindowsFrameworkElement
System.Windows.InteropHwndHost
System.Windows.Forms.IntegrationWindowsFormsHost
Jam.Shell.WPF.Controls.WinformsJamWindowsFormsHost
Jam.Shell.WPF.Controls.WinformsShellTreeView
System.Windows.ThreadingDispatcherObject
System.WindowsDependencyObject
System.Windows.MediaVisual
System.WindowsUIElement
System.WindowsFrameworkElement
System.Windows.InteropHwndHost
System.Windows.Forms.IntegrationWindowsFormsHost
Jam.Shell.WPF.Controls.WinformsJamWindowsFormsHost
Jam.Shell.WPF.Controls.WinformsShellTreeView
Namespace: Jam.Shell.WPF.Controls.Winforms
Assembly: ShellBrowser.Winforms (in ShellBrowser.Winforms.dll) Version: 6.3.1
SyntaxThe ShellTreeView type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShellTreeView | Default constructor. |
Properties| Name | Description | |
|---|---|---|
 | AllowDrag |
Use this property to turn on or off drag support with the Windows Explorer.
|
| 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.
|
| 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.
|
| Control | Returns the Winforms control wrapped by this instance. This might be necessary to access other properties not exposed by this wrapper. |
| CopyMode |
Copy mode allows you to control the behaviour when files or folders get dropped.
|
| 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'
|
| HideSelection |
Gets or sets a value indicating whether the selected tree node remains highlighted
even when the tree view has lost the focus.
|
| 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.
|
| 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.
|
| RootedAt |
Defines the root folder of this ShellTreeView |
| RootedAtFileSystemFolder |
Determines the root file system folder of a ShellTreeView.
|
| RootedAtLocation |
You can use this property to set the specific folder, which should be used as root for the
ShellTreeView. This is a dependency property.
|
| RootNode |
Returns the first root element of the type ShellTreeNode of this shell treeview.
|
| SelectedItemIdList | The item that is selected in the ShellTree. This is a dependency property. |
| SelectedNode |
Gets or sets the tree node that is currently selected in the ShellTreeView control.
|
| SelectedPath | Gets or sets the full pathname of the selected file/shell item. |
| 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. |
| 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.
|
| 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.
|
| ShowRootLines |
Indicates whether lines are displayed between root nodes.
|
| 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 | Gets or sets the selected special folder. |
| 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.
(Inherited from JamWindowsFormsHost.) |
 | WrappedControl | Gets or sets the control hosted by this instance. (Inherited from JamWindowsFormsHost.) |
Methods| Name | Description | |
|---|---|---|
| AddRoot(String) | Adds a root. |
| AddRoot(ItemIdList) | Adds a root. |
| AddRoot(ShellFolder) | Adds a root. |
 | AfterInit |
Must be called in "Initialized" eventhandler. Applies some common WPF settings to
Windows.Forms.Control.
(Overrides JamWindowsFormsHostAfterInit.) |
| ApplyBackGround | Applies the backround. (Inherited from JamWindowsFormsHost.) |
| ApplyFontSettings | Applies the font settings. (Inherited from JamWindowsFormsHost.) |
| ApplyForeGround | If possible, sets the ForeColor property of the inner control to the Foreground property of the wrapper. (Inherited from JamWindowsFormsHost.) |
| ClearRoots | Clears all roots in the ShellTreeView. |
| 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.
|
| FullRefresh |
Executes a full refresh of the contents of the control.
(Inherited from JamWindowsFormsHost.) |
| GoUp | (Inherited from JamWindowsFormsHost.) |
| OnPropertyChanged | Forces the translation of a mapped property. (Overrides JamWindowsFormsHostOnPropertyChanged(DependencyPropertyChangedEventArgs).) |
| Refresh(RefreshLevel) | This method indicates that the control should perform a refresh of its contents. (Inherited from JamWindowsFormsHost.) |
| Refresh(RefreshLevel, ItemIdList) | This method indicates that the control should perform a refresh of its contents. (Inherited from JamWindowsFormsHost.) |
| 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.
|
| SmartRefresh |
Executes a smart refresh of the contents of the control.
(Inherited from JamWindowsFormsHost.) |
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.
|
| CheckStateChanged |
This event is fired when the state of a checkbox was changed by the user.
|
| ControlInitialized |
Occurs when initialization of the component is completed.
|
| FolderUpdated |
This Event is triggered every time the details of a Node are updated
|
| 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.
|
Fields| Name | Description | |
|---|---|---|
  | RootedAtLocationProperty |
The DependencyProperty for RootedAtLocation.
|
| SelectedItemIdListProperty |
The DependencyProperty for SelectedItemIdList.
|
See Also