Click or drag to resize

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 Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      Jam.ShellShellControlConnector

Namespace: Jam.Shell
Assembly: ShellBrowser (in ShellBrowser.dll) Version: 7.2
Syntax
public class ShellControlConnector : Component, 
	IShellControlConnector

The ShellControlConnector type exposes the following members.

Constructors
 NameDescription
Public methodShellControlConnector The constructor for the ShellControlConnector class, it internally registers an EventHandler to its SelectionList change event.
Top
Properties
 NameDescription
Public propertyConsiderRootedAtProperty 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.
Public propertyEnabled Enabled returns true, if the messages should be passed through, false if the messages should be ignored.
Public propertyHistoryCount Get the count of the items available in the history.
Public propertyHistoryCursor This property contains the index of the current item in the history list
Public propertyHistoryItemsGets the list of entries currently stored in the history.
Public propertySelectionList If the Checkboxes property of a control connected to a ShellControlConnector is enabled, this property contains the checked items.
Public propertyShowParentfolderItem 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.
Public propertyVersion The current version of the ShellBrowser.
Top
Methods
 NameDescription
Public methodCanNavigate 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.
Public methodClearHistory Clears the history and adds the current folder as base again.
Public methodDeregisterShellControl Deregisters a control with the ShellControlConnector
Protected methodDispose Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean))
Public methodFullRefreshControls Calls the FullRefresh FullRefresh() method for all connected controls.
Public methodGetCaptionForHistoryElement Retrieve the caption of a history element at the index given.
Public methodGetHistoryElement Retrieve the history element at the index given.
Public methodIsMovePossible Checks if a move by delta steps in the history is possible.
Public methodMoveInHistory Move the pointer in the History by delta items. If delta is positive, move forward. Move backward if delta is negative.
Protected methodOnFileChanged Fire the OnFileChanged event.
Protected methodOnFolderChanged Triggers the FolderChanged event.
Public methodPathChanged This public method is used by the connected controls for synchronization. Usually this method should not be called by the user directly.
Public methodRefresh(RefreshLevel)Refreshes the information displayed in all controls connected with this ShellControlConnector.
Public methodRefresh(IShellControl, RefreshLevel, ItemIdList)Refreshes the information displayed in all controls connected with this ShellControlConnector except the passed control, which usually will be the caller.
Public methodRegisterShellControl Registers a control with the ShellControlConnector
Public methodSelectedFileChanged This public method is used by the connected controls for synchronization. Usually this method should not be called by the user directly.
Public methodSmartRefreshControls Calls the SmartRefresh SmartRefresh() method for all connected controls
Top
Events
 NameDescription
Public eventFileChanged Triggered when the selected files have changed in one of the connected controls.
Public eventFolderChanged Triggered when the path has changed in one of the connected controls.
Public eventCode exampleFolderChanging Occurs, when navigating a folder. You can intercept navigation by setting the Cancel parameter in the event arguments.
Top
See Also