Click or drag to resize

ShellAddressBar Class

The addressbar found on top of Windows Explorer.
Inheritance Hierarchy

Namespace:  Jam.Shell
Assembly:  ShellBrowser (in ShellBrowser.dll) Version: 6.2
Syntax
public class ShellAddressBar : ContainerControl, 
	ISupportInitializeNotification, ISupportInitialize, IShellControl, IShellControlConnectorTarget

The ShellAddressBar type exposes the following members.

Constructors
  NameDescription
Public methodShellAddressBar
Constructor for creating an ShellAddressBar instance.
Top
Properties
  NameDescription
Public propertyAbsoluteItemIdList
Gets or sets the displayed path.
Public propertyAutomaticRefresh
Gets or sets if breadcrumbs should be refreshed according to filesystem changes.
Public propertyBackColor
Gets or sets the background color for the control.
(Overrides ControlBackColor.)
Public propertyBreadCrumbBar
The ShellBreadCrumbBar in the middle.
Public propertyCanOverflow
Determines how the control handles overflow of items if there is not enough space for all breadcrumbs.
Protected propertyDefaultImeMode
Gets the default Input Method Editor (IME) mode supported by the control.
(Overrides ControlDefaultImeMode.)
Protected propertyDefaultSize
Gets the default size of the control.
(Overrides ControlDefaultSize.)
Public propertyDock
Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
(Overrides ControlDock.)
Public propertyFont
The font used to display text in the control.
(Overrides ControlFont.)
Public propertyForeColor
Gets or sets the foreground color of the control.
(Overrides ControlForeColor.)
Public propertyHistoryToolBar
The ShellHistoryToolBar on left side.
Public propertyImeMode
Gets or sets the Input Method Editor (IME) mode of the control.
Public propertyIsInitialized
Gets a value indicating whether the component is initialized.
Public propertyMaxDropDownCount
Gets or sets the number of items that should be displayed without vertical scrollbar.
Public propertyMinOverflowButtonCount
Gets or sets the minimum number of buttons that should be shown when control is in overflow mode.
Public propertyMinOverflowButtonWidth
Gets or sets the minimum button width in pixels if control is in overflow mode.
Public propertyOverflowThreshold
Gets or sets the minimum space in pixels between right side and last breadcrumb before overflow is started.
Public propertyPath
Gets or sets the displayed path.
Public propertyProgress
Gets or sets the current progress value.
Public propertyProgressMax
Gets or sets the maximum value of the progress bar.
Public propertyProgressMin
Gets or sets the minimum value of the progress bar.
Public propertyRightToLeft
Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
(Overrides ControlRightToLeft.)
Public propertyRootedAt
Gets or sets the root of the AddressBar.
Public propertyRootedAtFileSystemFolder
Gets or sets the root of the AddressBar.
Public propertyRootedAtFolderIdList
Gets or sets the root of the AddressBar.
Protected propertyScaleChildren
Gets a value that determines the scaling of child controls.
(Overrides ControlScaleChildren.)
Public propertySearchEdit
The ShellSearchEdit on right side.
Public propertyShellControlConnector
Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
Public propertyShowErrorMessages
Gets or sets if error messages should be shown.
Public propertyShowHidden
Is set to 'true', hidden elements will also be shown.
Public propertySpecialFolder
Gets or sets the special folder.
Public propertyTabStop
Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
Public propertyText
Gets or sets the text associated with this control.
(Overrides ControlText.)
Public propertyUseSystemFont
Set this property to true if you want the component to utilize the default system font.
Public propertyVersion
The current version of the ShellBrowser components.
Public propertyVisiblePanes
Gets or sets the visible panes.
Top
Methods
  NameDescription
Public methodBeginInit
Begins an initialize.
Public methodEndInit
Ends an initialize.
Public methodFolderChanged
Folder changed.
Public methodFullRefresh
Triggers a full refresh for all connected controls.
Public methodGoUp
Move in all connected controls from the current to the parent folder.
Protected methodOnBeforePathChange
Raises the BeforePathChange event.
Protected methodOnCreateControl (Overrides ContainerControlOnCreateControl.)
Protected methodOnFontChanged
Raises the FontChanged event.
(Overrides ContainerControlOnFontChanged(EventArgs).)
Protected methodOnHandleCreated
Raises the HandleCreated event.
(Overrides ControlOnHandleCreated(EventArgs).)
Protected methodOnPathSelected
Executes the path selected event.
Public methodRefresh(RefreshLevel)
This method indicates that the control should perform a refresh of its contents.
Public methodRefresh(RefreshLevel, ItemIdList)
This method indicates that the control should perform a refresh of its contents.
Protected methodScaleControl
Scales a control's location, size, padding and margin.
(Overrides ScrollableControlScaleControl(SizeF, BoundsSpecified).)
Public methodSelectedFileChange
Selected file change.
Protected methodSetBoundsCore
Performs the work of setting the specified bounds of this control.
(Overrides ControlSetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified).)
Protected methodSetFont
Sets the font without adjusting other properties.
Public methodSmartRefresh
Triggers a smart refresh for all connected controls.
Top
Events
  NameDescription
Public eventBeforePathChange
This event is fired before a path is selected in the control. Setting the path can be canceled.
Public eventEditModeEnter
Occurs if edit mode is entered.
Public eventEditModeLeave
Occurs if edit mode is left.
Public eventForeColorChanged
Occurs when the ForeColor property value changes.
Public eventImeModeChanged
Occurs when the ImeMode property has changed.
Public eventInitialized
Occurs when initialization of the component is completed.
Public eventPaint
Occurs when the control is redrawn.
Public eventPathChanged
Occurs if the path represented by AbsoluteItemIdList has changed.
Public eventPathSelected
Occurs if a new path was set through the ShellAddressBar.
Public eventRightToLeftChanged
Occurs when the RightToLeft property value changes.
Public eventTextChanged
Occurs when the Text property value changes.
Top
Extension Methods
  NameDescription
Public Extension MethodHandleNeeded
A Control extension method that ensures that the handle for a control is created.
(Defined by ExtensionMethods.)
Public Extension MethodScaledPixels
An extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with.
(Defined by ExtensionMethods.)
Public Extension MethodScaleFont
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.

See Also