ExplorerBrowser Class

This component embeds the native windows ExplorerBrowser control into a WPF component.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            System.Windows.InteropHwndHost
              Jam.Shell.WPF.ControlsJamBaseHwndHost
                Jam.Shell.WPF.ControlsExplorerBrowser

Namespace: Jam.Shell.WPF.Controls
Assembly: ShellBrowserWPF (in ShellBrowserWPF.dll) Version: 1.3.1

Syntax

C++

Copy

public class ExplorerBrowser : JamBaseHwndHost, 
	IShellControlConnectorTarget

Public Class ExplorerBrowser
	Inherits JamBaseHwndHost
	Implements IShellControlConnectorTarget

public ref class ExplorerBrowser : public JamBaseHwndHost, 
	IShellControlConnectorTarget

type ExplorerBrowser =  
    class
        inherit JamBaseHwndHost
        interface IShellControlConnectorTarget
    end

The ExplorerBrowser type exposes the following members.

Constructors

	Name	Description
	ExplorerBrowser	Default constructor.

Top

Properties

	Name	Description
	AllColumns	Gets a list of all columns that are supported in the current view. These depend on what the control currently displays.
	AutoCheckSelect	Gets or sets a value indicating whether the control displays checkboxes that can be used to set the selection
	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.
	IsAvailable	Gets a value indicating whether this instance is loaded and available.
	Items	Contains the Items 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.
	Location	Gets or sets the current location.
	MainWindow	Gets the main window. (Inherited from JamBaseHwndHost.)
	Path	Gets or sets the filesystem folder which contents should be displayed.
	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	Gets or sets a ShellControlConnector.
	ShowHeader	Gets or sets a value indicating if column headers should be shown.
	SpecialFolder	Gets or sets the special folder to be displayed.
	ThumbnailSize	Gets or sets the size of the icons that is applied when View is set to Thumbnail.
	Version	The current version of ShellBrowser Components WPF.
	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.

Top

Methods

	Name	Description
	BeginUpdate	Prevent that a FullRefresh is called until EndUpdate is called. Every call of BeginUpdate() increments an UpdateCounter variable.
	BuildWindowCore	When overridden in a derived class, creates the window to be hosted. (Inherited from JamBaseHwndHost.)
	CheckItem	Obsolete. Checks the item at the position passed by index.
	CreateWnd	Called after the Window has been created and the component has received a handle. (Overrides JamBaseHwndHostCreateWnd.)
	DeselectAll	Deselect all items in the listview.
	DestroyWindowCore	When overridden in a derived class, destroys the hosted window. (Overrides JamBaseHwndHostDestroyWindowCore(HandleRef).)
	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.
	IndexOf	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.
	InvokeCommandOnFolder(ShellCommand)	Executes a context menu command on the current folder.
	InvokeCommandOnFolder(ShellContextMenuCommand)	Executes a context menu command on the current folder.
	InvokeCommandOnSelected(ShellCommand)	Executes a context menu command on the selected items.
	InvokeCommandOnSelected(ShellContextMenuCommand)	Executes a context menu command on the selected items.
	IsUpdating	Query if this object is updating.
	OnBeforeFullRefresh	Issues the BeforeFullRefresh event.
	OnPropertyChanged	Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides OnPropertyChanged(DependencyPropertyChangedEventArgs). (Overrides FrameworkElementOnPropertyChanged(DependencyPropertyChangedEventArgs).)
	OnVisualParentChanged	Invoked when the parent of this element in the visual tree is changed. Overrides OnVisualParentChanged(DependencyObject) . Finds a ScrollViewer in the visual tree that contains this instance. (Inherited from JamBaseHwndHost.)
	OnWindowPositionChanged	Called when the hosted window's position changes. (Inherited from JamBaseHwndHost.)
	SelectedFileChange	Changes the displayed file in all connected controls.
	SelectItem	Selects the item at the position passed by index.
	TabIntoCore	Sets focus on either the first tab stop or the last tab stop of the sink. (Overrides HwndHostTabIntoCore(TraversalRequest).)
	TranslateAcceleratorCore	Processes keyboard input at the keydown message level. (Overrides HwndHostTranslateAcceleratorCore(MSG, ModifierKeys).)
	WndProc	Calls the DefWindowProc with the given message. This is sometimes necessary when processing messages in subclasses and setting handled to true. (Inherited from JamBaseHwndHost.)

Top

Events

	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 clicked on an item.
	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
	SelectionChanged	This event occurs, if a selection changed in the listview
	ViewChanged	This event happens on view changes of the control.

Top

Fields

	Name	Description
	LocationProperty	The DependencyProperty for ItemIdList.
	ViewProperty	The DependencyProperty for View.

Top

Remarks

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.

Reference

Jam.Shell.WPF.Controls Namespace