ShellBreadCrumbBar Class

Embeds the native Windows BreadCrumbBar control into a .NET component.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        Jam.ShellShellBreadCrumbBar

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

Syntax

C++

Copy

public class ShellBreadCrumbBar : Control, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

Public Class ShellBreadCrumbBar
	Inherits Control
	Implements IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

public ref class ShellBreadCrumbBar : public Control, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

type ShellBreadCrumbBar = 
    class
        inherit Control
        interface IShellControl
        interface IShellControlConnectorTarget
        interface ISupportInitialize
        interface ISupportInitializeNotification
    end

The ShellBreadCrumbBar type exposes the following members.

Constructors

	Name	Description
	ShellBreadCrumbBar	Initializes a new instance of the Jam.Shell.ShellBreadCrumbBar class.
	ShellBreadCrumbBar(ShellAddressBar)	Constructor for creating a ShellBreadCrumbBar 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)
	BackgroundImage	Gets or sets the background image. (Overrides ControlBackgroundImage)
	BackgroundImageLayout	Gets or sets the layout for background image. (Overrides ControlBackgroundImageLayout)
	CanOverflow	Determines if control supports overflow.
	DefaultSize	Gets the default size of the control. (Overrides ControlDefaultSize)
	Editor	Gets the editor component.
	ForeColor	Gets or sets the forecolor . (Overrides ControlForeColor)
	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 inside drop-down menu 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 breadcrumb.
	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.
	TabIndex	Gets or sets the tab order of the control within its container.
	TabStop	Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
	Text	Gets the current displayed address for screenreaders. (Overrides ControlText)

Top

Methods

	Name	Description
	BeginInit	Signals the object that initialization is starting.
	CanNavigate	Called, before the ShellList displays a new folder. Calls the CanNavigate(Object, ItemIdList) implementation if assigned.
	EndInit	Signals the object that initialization is complete.
	FolderChanged	Changes the displayed folder in all connected controls. The Edit-Mode is left.
	FullRefresh	Triggers a full refresh for all connected controls.
	GoUp	Move in all connected controls from the current to the parent folder.
	OnBeforePathChange	Not implemented.
	OnCreateControl	Raises the CreateControl method. (Overrides ControlOnCreateControl)
	OnFontChanged	Raises the FontChanged event. (Overrides ControlOnFontChanged(EventArgs))
	OnHandleCreated	Raises the HandleCreated event. (Overrides ControlOnHandleCreated(EventArgs))
	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 ControlScaleControl(SizeF, BoundsSpecified))
	SelectedFileChange	Changes the displayed file in all connected controls.
	SetBoundsCore	Performs the work of setting the specified bounds of this control. (Overrides ControlSetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified))
	SmartRefresh	Triggers a smart refresh for all connected controls.

Top

Events

	Name	Description
	BackgroundImageChanged	Occurs when the BackgroundImage property changes.
	BackgroundImageLayoutChanged	Occurs when the BackgroundImageLayout property changes.
	EditModeEnter	Occurs if edit mode is entered.
	EditModeLeave	Occurs if edit mode is left.
	ForeColorChanged	Occurs when the ForeColor property changes.
	ImeModeChanged	Occurs when the ImeMode property changes.
	Initialized	Occurs when initialization of the component is completed.
	Paint	This member is not meaningful for this control.
	PathChanged	Occurs if AbsoluteItemIdList has changed.
	RightToLeftChanged	Occurs when the RightToLeft property value changes.
	TabIndexChanged	Occurs when the TabIndex property value changes.
	TextChanged	Occurs when the Text property changes.

Top

Extension Methods

	Name	Description
	GetSelfAndDescendants	Returns a flattened collection of a control and all of its descendant controls. (Defined by ExtensionMethods)
	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

This class provides a breadcrumb navigation known from the Windows Explorer. It uses the same theming whereby it has the look-and-feel of the current Windows version it is running on. Please note that this control cannot be used directly as it is embedded in ShellAddressBar.

The ShellBreadCrumbBar provides a drop-down menu when clicking on the drop-down portion of a breadcrumb item. The maximum number of items can be changed using MaxDropDownCount. Per default hidden items are also display. This can be changed using ShowHidden.

The control contains a progress bar in the background like the native BreadCrumbBar which can be used to inform the user about a long lasting operation. The progress range can be configured by using ProgressMin and ProgressMax. The progress has to be set by Progress.

The control always tries to ensure the readability of the path. If the path is too long and some breadcrumbs at the end cannot be displayed properly, the control starts hiding breadcrumbs at the front of path. This feature is called "overflow". Overflow can be enabled or disabled using CanOverflow and highly customized using OverflowThreshold, MinOverflowButtonCount and MinOverflowButtonWidth.

Reference

Jam.Shell Namespace

ShellAddressBar