ShellAddressBar Class

The addressbar found on top of Windows Explorer.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            Jam.ShellShellAddressBar

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

Syntax

C++

Copy

public class ShellAddressBar : ContainerControl, 
	ISupportInitializeNotification, ISupportInitialize, IShellControl, IShellControlConnectorTarget

Public Class ShellAddressBar
	Inherits ContainerControl
	Implements ISupportInitializeNotification, ISupportInitialize, IShellControl, IShellControlConnectorTarget

public ref class ShellAddressBar : public ContainerControl, 
	ISupportInitializeNotification, ISupportInitialize, IShellControl, IShellControlConnectorTarget

type ShellAddressBar =  
    class
        inherit ContainerControl
        interface ISupportInitializeNotification
        interface ISupportInitialize
        interface IShellControl
        interface IShellControlConnectorTarget
    end

The ShellAddressBar type exposes the following members.

Constructors

	Name	Description
	ShellAddressBar	Constructor for creating an ShellAddressBar instance.

Top

Properties

	Name	Description
	AbsoluteItemIdList	Gets or sets the displayed path.
	AutomaticRefresh	Gets or sets if breadcrumbs should be refreshed according to filesystem changes.
	BackColor	Gets or sets the background color for the control. (Overrides ControlBackColor.)
	BreadCrumbBar	The ShellBreadCrumbBar in the middle.
	CanOverflow	Determines how the control handles overflow of items if there is not enough space for all breadcrumbs.
	DefaultImeMode	Gets the default Input Method Editor (IME) mode supported by the control. (Overrides ControlDefaultImeMode.)
	DefaultSize	Gets the default size of the control. (Overrides ControlDefaultSize.)
	Dock	Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. (Overrides ControlDock.)
	Font	The font used to display text in the control. (Overrides ControlFont.)
	ForeColor	Gets or sets the foreground color of the control. (Overrides ControlForeColor.)
	HistoryToolBar	The ShellHistoryToolBar on left side.
	ImeMode	Gets or sets the Input Method Editor (IME) mode of the control.
	IsInitialized	Gets a value indicating whether the component is initialized.
	MaxDropDownCount	Gets or sets the number of items that should be displayed without vertical scrollbar.
	MinOverflowButtonCount	Gets or sets the minimum number of buttons that should be shown when control is in overflow mode.
	MinOverflowButtonWidth	Gets or sets the minimum button width in pixels if control is in overflow mode.
	OverflowThreshold	Gets or sets the minimum space in pixels between right side and last breadcrumb before overflow is started.
	Path	Gets or sets the displayed path.
	Progress	Gets or sets the current progress value.
	ProgressMax	Gets or sets the maximum value of the progress bar.
	ProgressMin	Gets or sets the minimum value of the progress bar.
	RightToLeft	Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. (Overrides ControlRightToLeft.)
	RootedAt	Gets or sets the root of the AddressBar.
	RootedAtFileSystemFolder	Gets or sets the root of the AddressBar.
	RootedAtFolderIdList	Gets or sets the root of the AddressBar.
	ScaleChildren	Gets a value that determines the scaling of child controls. (Overrides ControlScaleChildren.)
	SearchEdit	The ShellSearchEdit on right side.
	ShellControlConnector	Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
	ShowErrorMessages	Gets or sets if error messages should be shown.
	ShowHidden	Is set to 'true', hidden elements will also be shown.
	SpecialFolder	Gets or sets the special folder.
	TabStop	Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
	Text	Gets or sets the text associated with this control. (Overrides ControlText.)
	UseSystemFont	Set this property to true if you want the component to utilize the default system font.
	Version	The current version of the ShellBrowser components.
	VisiblePanes	Gets or sets the visible panes.

Top

Methods

	Name	Description
	BeginInit	Begins an initialize.
	EndInit	Ends an initialize.
	FolderChanged	Folder changed.
	FullRefresh	Triggers a full refresh for all connected controls.
	GoUp	Move in all connected controls from the current to the parent folder.
	OnBeforePathChange	Raises the BeforePathChange event.
	OnCreateControl	Raises the CreateControl method. (Overrides ContainerControlOnCreateControl.)
	OnFontChanged	Raises the FontChanged event. (Overrides ContainerControlOnFontChanged(EventArgs).)
	OnHandleCreated	Raises the HandleCreated event. (Overrides ControlOnHandleCreated(EventArgs).)
	OnPathSelected	Executes the path selected event.
	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.
	ScaleControl	Scales a control's location, size, padding and margin. (Overrides ScrollableControlScaleControl(SizeF, BoundsSpecified).)
	SelectedFileChange	Selected file change.
	SetBoundsCore	Performs the work of setting the specified bounds of this control. (Overrides ControlSetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified).)
	SetFont	Sets the font without adjusting other properties.
	ShouldSerializeRootedAtFileSystemFolder	Determine if we should serialize RootedAtFileSystemFolder.
	SmartRefresh	Triggers a smart refresh for all connected controls.

Top

Events

	Name	Description
	BeforePathChange	This event is fired before a path is selected in the control. Setting the path can be canceled.
	EditModeEnter	Occurs if edit mode is entered.
	EditModeLeave	Occurs if edit mode is left.
	ForeColorChanged	Occurs when the ForeColor property value changes.
	ImeModeChanged	Occurs when the ImeMode property has changed.
	Initialized	Occurs when initialization of the component is completed.
	Paint	Occurs when the control is redrawn.
	PathChanged	Occurs if the path represented by AbsoluteItemIdList has changed.
	PathSelected	Occurs if a new path was set through the ShellAddressBar.
	RightToLeftChanged	Occurs when the RightToLeft property value changes.
	TextChanged	Occurs when the Text property value changes.

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

Remarks

The ShellAddressBar is the addressbar found on top of Windows Explorer and contains ShellBreadCrumbBar, ShellHistoryToolBar and ShellSearchEdit. Some panes like the search box are optional and its visibility can be changed using property VisiblePanes.

This control is embedded in ExplorerBrowser.

Reference

Jam.Shell Namespace