ShellControlConnector Class |
This component is able to synchronize several of the visual shell components (e.g. ShellTreeView, ShellListView). Just drop a ShellControlConnector component to this form and assign the ShellControlConnector property of all shell components to the ShellControlConnector component. You can refresh all connected shell controls by using the FullRefresh() method. If you want to use CheckBoxes in a ShellTreeView or ShellListView, that must be connected to a ShellControlConnector. The ShellControlConnector will synchronize the selected files and folder in the different shell controls.
Inheritance HierarchyNamespace: Jam.Shell
Assembly: ShellBrowser (in ShellBrowser.dll) Version: 7.1
SyntaxThe ShellControlConnector type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShellControlConnector |
The constructor for the ShellControlConnector class,
it internally registers an EventHandler to its SelectionList change event.
|
Properties| Name | Description | |
|---|---|---|
 | ConsiderRootedAtProperty |
If this property is set to true the ShellControlConnector will take the
RootedAt or RootedAtFileSystemFolder property
of a connected ShellTreeView control into account.
For example if RootedAt is set to "c:\" then the ShellControlConnector will filter out
any folder change event that would point connected controls like the ShellListView to
a folder that is not reachable by traversing the directory tree from the root given in the
RootedAt directory.
|
| Enabled |
Enabled returns true, if the messages should be passed through, false if the messages should be ignored.
|
| HistoryCount |
Get the count of the items available in the history.
|
| HistoryCursor |
This property contains the index of the current item in the history list
|
| HistoryItems | Gets the list of entries currently stored in the history. |
| SelectionList |
If the Checkboxes property of a control connected to a ShellControlConnector is enabled,
this property contains the checked items.
|
| ShowParentfolderItem |
true, if appropriate controls may display a parent folder item or may go to the parent folder.
false, if controls should prevent changing to the parent folder.
|
| Version |
The current version of the ShellBrowser.
|
Methods| Name | Description | |
|---|---|---|
| CanNavigate |
Use this function to check if navigating the passed ItemIdList is allowed.
It currently calls the cancellable FolderChanging event, that can be implemented to prohibit paths.
|
| ClearHistory |
Clears the history and adds the current folder as base again.
|
| DeregisterShellControl |
Deregisters a control with the ShellControlConnector
|
 | Dispose |
Releases the unmanaged resources used by the Component
and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean).) |
| FullRefreshControls |
Calls the FullRefresh FullRefresh() method for all connected controls.
|
| GetCaptionForHistoryElement |
Retrieve the caption of a history element at the index given.
|
| GetHistoryElement |
Retrieve the history element at the index given.
|
| IsMovePossible |
Checks if a move by delta steps in the history is possible.
|
| MoveInHistory |
Move the pointer in the History by delta items.
If delta is positive, move forward.
Move backward if delta is negative.
|
| OnFileChanged |
Fire the OnFileChanged event.
|
| OnFolderChanged |
Triggers the FolderChanged event.
|
| PathChanged |
This public method is used by the connected controls for synchronization. Usually this method should not be called by the user directly.
|
| Refresh(RefreshLevel) | Refreshes the information displayed in all controls connected with this ShellControlConnector. |
| Refresh(IShellControl, RefreshLevel, ItemIdList) | Refreshes the information displayed in all controls connected with this ShellControlConnector except the passed control, which usually will be the caller. |
| RegisterShellControl |
Registers a control with the ShellControlConnector
|
| SelectedFileChanged |
This public method is used by the connected controls for synchronization. Usually this method should not be called by the user directly.
|
| SmartRefreshControls |
Calls the SmartRefresh SmartRefresh() method for all connected controls
|
Events| Name | Description | |
|---|---|---|
 | FileChanged |
Triggered when the selected files have changed in one of the connected controls.
|
| FolderChanged |
Triggered when the path has changed in one of the connected controls.
|
 | FolderChanging |
Occurs, when navigating a folder. You can intercept navigation by setting the Cancel parameter in the event arguments.
|
See Also