ShellComboBox Class

The ShellComboBox is a simple component that allows to display folders and drives in a combo box with its associated icons. It is perfectly analogous to the windows explorer file selection dropdown list and provides an editable field as well.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsListControl
          System.Windows.FormsComboBox
            Jam.ShellCustomEditComboBox
              Jam.ShellCustomFolderComboBox
                Jam.ShellShellComboBox

Namespace: Jam.Shell
Assembly: ShellBrowser.Winforms (in ShellBrowser.Winforms.dll) Version: 6.3.1

Syntax

C++

Copy

public class ShellComboBox : CustomFolderComboBox, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

Public Class ShellComboBox
	Inherits CustomFolderComboBox
	Implements IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

public ref class ShellComboBox : public CustomFolderComboBox, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

type ShellComboBox =  
    class
        inherit CustomFolderComboBox
        interface IShellControl
        interface IShellControlConnectorTarget
        interface ISupportInitialize
        interface ISupportInitializeNotification
    end

The ShellComboBox type exposes the following members.

Constructors

	Name	Description
	ShellComboBox	Default constructor of the ShellComboBox

Top

Properties

	Name	Description
	AutomaticRefresh	Enables the automatic refreshes of the control, e.g. when a file is added or deleted in the current directory.
	CurrentFolderIdList	Get or set the ItemIdList of the currently selected folder, returns null if nothing is selected, may not be explicitly set to null.
	DrawMode	DrawMode must always be OwnerDrawFixed for the ShellCombo to work.
	DropDownStyle	If DropDownStyle is DropDown, the shell autocompletion mode is enabled. If it is DropDownList, the shell autocompletion is disabled, ie. no edit field is provided. The default value is DropDown. ComboBoxStyle.Simple is not supported and ignored.
	DropDownWidthAutoAdjust	Gets or sets a value indicating whether the combobox should adjust the width of the dropdown menu. The default value is true (In contrast to the default ComboBox which does not support this)
	FileSystemOnly	If this option is set to true, the ShellCombo will only show items of the filesystem and exclude virtual file items.
	Font	Gets or sets the font of the text displayed by the control and adapts UseSystemFont is set to false. (Inherited from CustomEditComboBox.)
	IsInitialized	Gets a value indicating whether the component is initialized. (Inherited from CustomEditComboBox.)
	Items	Gets an object representing the content of the CustomFolderComboBox
	NoFillOnStartup	If set to true the ShellCombo will not scan the filesystem and fill on startup, this is useful if the path to show is known only on runtime.
	OverlayTextBox	Provides access to the TextBox field of the control. (Inherited from CustomEditComboBox.)
	SelectedPath	Use this property to get or set the currently selected path the ShellCombo is displaying. The path may be empty if the user selected an object that does not belong to the filesystem (i.e. Network). If you'd like to also handle these virtual file items, consider using the CurrentFolderIdList property instead.
	ShellAutoCompletionMode	This property controls the availability of the shells autocompletion mode, if set to FileSystem, Url or both, the ComboBox provides a TextField the user can type to. If disabled the default combobox behavior without editing functionality is used. Both, FileSystem and Url can be specified at once and are enabled by default. ShellAutoComplete.Url needs to be used to also provide autocompletion for UNC-Paths. (Inherited from CustomEditComboBox.)
	ShellBrowser	A ShellBrowser instance that is used to navigate through the files.
	ShellControlConnector	Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
	ShowDesktopContent	If set to true, the ShellComboBox includes the first level of content of the Desktop folder.
	ShowDrives	If set to true, the ShellComboBox includes the Drives installed in the System.
	ShowFullPath	If set to true, the full path of the selected item is shown in the combobox (Inherited from CustomFolderComboBox.)
	ShowMyDocuments	If set to true, the ShellComboBox includes the files in the first level of the "My Documents" folder.
	ShowNethood	If set to true, the Nethood is shown in the ShellCombo.
	ShowNetwork	If set to true, the Network is shown in the ShellCombo.
	ShowRecycleBin	If set to true, the ShellCombo will show the Recycle Bin icon.
	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. (Inherited from CustomEditComboBox.)
	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. (Inherited from CustomEditComboBox.)
	Version	The current version of the ShellBrowser.

Top

Methods

	Name	Description
	AddDesktopContent	Adds the Desktop content if ShowDesktopContent is true
	AddIdListToCombo(ItemIdList)	Adds the folders of the given ItemIdList as non-persistent items to the combobox.
	AddIdListToCombo(ItemIdList, Boolean)	Adds the folders of the given ItemIdList as (non)persistent items to the combobox.
	AddPersistentRootItemDesktop	This adds the persistent root item for the virtual folder "Desktop"
	AddShellFolder	This method adds a list of persistent objects from a folder to the CustomFolderBox.
	AdjustTextBoxSize	Adjusts the size of the edit field so that it is inside the combo box. (Inherited from CustomEditComboBox.)
	BeginInit	Signals the object that initialization is starting. (Overrides CustomEditComboBoxBeginInit.)
	CustomFolderComboDrawItemHandler	This is the event handler registered to DrawItem(Control, DrawItemEventArgs, Boolean) it displays the items as files or folders (Inherited from CustomFolderComboBox.)
	CustomFolderComboSelectedIndexChanged	The event handler for the SelectedIndexChanged event. it notifies the ShellControlConnector about the selection change if it has been registered.
	EnableSystemStyles	Sets system specific behaviour, i.e. FullRowSelect in Vista and upwards. (Inherited from CustomEditComboBox.)
	EndInit	Signals the object that initialization is complete. (Overrides CustomEditComboBoxEndInit.)
	FolderChanged	Change the current folder to the one given in parameter throws ArgumentNullException if the argument was null
	FullRefresh	Rescans the folders and refreshes the components' entire display
	GetPersistentItems	This method is extended by RefreshPersistent to support more Special Folders to be displayed.
	GoUp	Go up one level in the tree, does nothing if the SelectedNode is null of if the SelectedNode has no Parent (is root)
	OnCreateControl	Recalculates the ItemHeight. Raises the CreateControl method. (Inherited from CustomEditComboBox.)
	OnDropDown	Refreshes the non-persistent items in the control (ie. if changes on the desktop occurred) (Overrides ComboBoxOnDropDown(EventArgs).)
	OnHandleCreated	This event is triggered after the handle of the control was created. (Inherited from CustomEditComboBox.)
	OnOverlayResize	This method is called from the OverlayTextBox.Resize Event. It calls the AdjusTextBoxSize method. (Inherited from CustomEditComboBox.)
	OnShowOptionChanged	This method needs to be called if a a ShowOption changed. (Inherited from CustomFolderComboBox.)
	OnSizeChanged	This event is triggered after the size of the combobox changed. Fixes bug #4397. (Inherited from CustomEditComboBox.)
	OverlayTextBoxClicked	If the OverlayTextBox is clicked, it's text is selected.
	OverlayTextBoxEntered	If the OverlayTextBox is clicked, it's text is selected.
	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.
	RefreshPersistent	This method also refreshes the persistent items - it is used if properties that are normally set at designtime are modified at runtime, e.g. IncludeRemoveableDrives is switched on, since those Items are persistent items, they are not refreshed by default
	RemoveNonPersistentItems	Removes Items from the ShellComboItems list that are not persistent.
	SelectedFileChange	This method does nothing because ShellCombo does not display files.
	SetFont	Sets the font without adjusting other properties. (Inherited from CustomEditComboBox.)
	SmartRefresh	The SmartRefresh only refreshes the non persistent items but its functionality equals a FullRefresh for the ShellCombo.
	UpdateOverlayTextBox	Updates the Text of the OverlayTextBox by either setting the items caption or the items path depending on the ShowFullPath property (Inherited from CustomFolderComboBox.)

Top

Events

	Name	Description
	Initialized	Occurs when initialization of the component is completed. (Inherited from CustomEditComboBox.)
	ShowOptionChangedEvent	Register to this event to get informed about an optionchange of the Show{...} properties. (Inherited from CustomFolderComboBox.)

Top

Extension Methods

	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.)

Top

Reference

Jam.Shell Namespace