ExplorerBrowser Class |
Namespace: Jam.Shell
The ExplorerBrowser type exposes the following members.
Name | Description | |
---|---|---|
ExplorerBrowser |
Initializes a new instance of the ExplorerBrowser class.
|
Name | Description | |
---|---|---|
AddressBar |
The ShellAddressBar if available.
| |
AllColumns |
Gets a list of all columns that are supported in the current view. These depend on what the control currently displays.
| |
AllowDrop |
Gets or sets a value indicating whether the control can accept data that the user drags onto it.
(Overrides ControlAllowDrop.) | |
AutoCheckSelect |
Gets or sets a value indicating whether the control displays checkboxes
that can be used to set the selection
| |
BackColor |
This property is not implemented.
(Overrides ControlBackColor.) | |
BackgroundImage |
This property is not implemented.
(Overrides ControlBackgroundImage.) | |
BackgroundImageLayout |
This property is not implemented.
(Overrides ControlBackgroundImageLayout.) | |
CheckedItems | Obsolete.
Gets the checked items.
The collection is non-recursive - if a folder is checked its content is not included.
| |
CheckMode | Gets or sets a value defining the current CheckMode. | |
Columns |
Gets the ShellViewColumns the control currently displays.
| |
ContentFilter |
A ShellItemFilter specifiying filter criteria for this instance.
| |
FocusedPane | Retrieves the focused pane. | |
FolderIdList |
Gets or sets the current location.
| |
Font |
This property is not implemented.
(Overrides ControlFont.) | |
ForeColor |
This property is not implemented.
(Overrides ControlForeColor.) | |
GroupBy |
Gets or sets the view grouping.
| |
GroupDirection |
Gets or sets the group direction.
| |
IsInitialized |
Gets a value indicating whether the component is initialized.
| |
Items |
Contains the Items in the ExplorerBrowser.
The collection is gathered upon first retrieval. It is updated internally when the items change, i.e. by moving to another folder.
The items returned may be sorted differently than the view.
| |
Path |
Gets or sets the filesystem path which contents should be displayed.
| |
SelectedItemIdList |
Gets or sets the selected item identifier list. A previous selection is removed.
| |
SelectedItems |
Contains the selected item collection in the ExplorerBrowser.
The collection is gathered upon first retreival. It is updated internally when the items change, i.e. by moving to another folder.
The items returned may be sorted differently than the view.
| |
ShellControlConnector |
Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
| |
ShowErrorMessages |
If set to true the ShellList component will show a MessageBox if an error occured,
otherwise the errors will only be logged to the Debug output.
| |
ShowHeader |
Gets or sets a value indicating if column headers should be shown.
| |
SpecialFolder |
Gets or sets the special folder to be displayed.
| |
ThumbnailSize | ||
Version |
The current version of the ShellBrowser.
| |
View |
Allows to set the different view modes of the ExplorerBrowser control.
| |
ViewFolderFlags |
Get or set the FolderFlags that specify how the ListView displays
its content. The flags can be or'ed together, ie. "FolderFlags.NoColumnHeader | FolderFlags.AbbreviatedNames"
in the designer this is specified by a comma-separation.
| |
VisiblePanes |
Gets or sets the panes that are/should be visible.
|
Name | Description | |
---|---|---|
BeginInit |
Signals the object that initialization is starting.
| |
BeginUpdate |
Prevent that a FullRefresh is called until EndUpdate is called. Every call of BeginUpdate() increments an UpdateCounter variable.
| |
CanNavigate |
Called when browsing to a new folder.
| |
CheckItem | Obsolete.
Checks the item at the position passed by index.
| |
DeselectAll |
Deselect all items in the listview.
| |
Dispose |
Disposes the instance.
(Overrides ContainerControlDispose(Boolean).) | |
EndInit |
Signals the object that initialization is complete.
| |
EndUpdate |
End the updating mode.
| |
EnsureVisible |
Scrolls to the item at the specified index.
| |
FolderChanged |
Changes the displayed folder in all connected controls.
| |
FullRefresh |
Reloads the component.
| |
GoUp |
Move in all connected controls from the current to the parent folder.
| |
IndexOf(ItemIdList) |
Searches for the index of the ItemIdList within the listview. This function has O(n) complexity, since it iterates through all items within the list.
| |
IndexOf(String) |
Searches for the index of the given path within the shell-list.
This function has O(n) complexity, since it iterates through all items within the list
| |
InvokeCommand |
Executes a context menu command for listed folder or selected items depending on focus.
| |
InvokeCommandOnFolder |
Use InvokeCommandOnFolder to execute a command of the context menu for the listed folder.
| |
InvokeCommandOnSelected |
Invokes a ShellCommand on the selected item(s) of the ListView.
| |
IsColumnAvailable |
Determines whether the SHCOLUMNID passed is supported by the current view, no matter if it is currently displayed or not.
| |
IsUpdating | Query if this object is updating. | |
OnBeforeFullRefresh |
Issues the BeforeFullRefresh event.
| |
OnCreateControl |
Creates the internal ComObject and initializes it
(Overrides UserControlOnCreateControl.) | |
OnFocusChanged | Raises the focus changed event. | |
OnHandleDestroyed |
Cleans up the explorer browser events+object when the window is being taken down.
(Overrides ControlOnHandleDestroyed(EventArgs).) | |
OnKeyUp |
Raises the System.Windows.Forms.KeyUp event.
(Overrides ControlOnKeyUp(KeyEventArgs).) | |
OnPathChanged |
Issues the PathChanged event.
| |
OnResize |
Resizes the component to the new ClientArea.
(Overrides UserControlOnResize(EventArgs).) | |
PreFilterMessage |
Passes messages to the native Explorer Browser and/or raises matching events.
| |
ProcessTabKey | Process the tab key described by forward. (Overrides ContainerControlProcessTabKey(Boolean).) | |
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.
| |
SelectedFileChange |
Called when the selected file was changed in a connected control.
Not handled by this control
| |
SelectItem |
Selects the item at the position passed by index.
| |
SmartRefresh |
Refreshes the view. Contrary to FullRefresh, that reloads the whole control, only the view is updated.
| |
Ungroup |
Ungroups the items inside the current view.
| |
WndProc |
Processes Windows messages.
(Overrides UserControlWndProc(Message).) |
Name | Description | |
---|---|---|
AddItem |
This event occurs if a ListItem is to be added to the list.
If the "CanAdd" property of the event args is set to false in an
event handler, the item will not be added to the listview.
| |
BeforeFullRefresh |
This event occurs right before the FullRefresh method is called.
| |
DefaultAction |
This event occurs if the user triggers the default command e.g. double-click on an item.
| |
FocusChanged |
Occurs, when the focus inside the ExplorerBrowser changes.
Use FocusedPane to find out where the focus is.
| |
Initialized |
Occurs when initialization of the component is completed.
| |
NavigationComplete |
Occurs when navigating to a folder has been completed successfully.
| |
NavigationFailed |
Occurs when navigating to a folder has failed.
| |
NavigationPending |
Occurs before navigating to a folder. The operation can be cancelled using Cancel | |
PathChanged |
This event occurs if the path changed that the control displays.
| |
SelectionChanged |
This event occurs, if a selection changed in the listview
| |
ViewChanged |
This event happens on view changes of the control.
|
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.) |
This control displays the contents of a folder in a ListView like control. It is a true instance of the ExplorerBrowser (on Windows Vista and later) that is used by the Windows Explorer and therefore looks and behaves exactly like the Windows Explorer on the system it is running on.
There are some panes that can be shown or hidden by using the VisiblePanes property. The used view style can be changed using the View property. If Details is used columns are displayed. They can be edited by using Columns property.