Class NavigationView

Breadcrumb navigation view.

Inheritance
System.Object
BaseControl
NavigationView
Implements
System.IDisposable
System.ComponentModel.ISupportInitialize
System.Windows.Forms.IMessageFilter
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class NavigationView : BaseControl, IThemeProvider, IDisposable, ISupportOffice2007Theme, ISuppportHistory, ISupportInitialize, IMessageFilter, IContainBars, IVisualStyle

Constructors

NavigationView()

Initializes a new instance of the NavigationView class.

Declaration
public NavigationView()

Fields

DefaultHeight

Default height of NavigationView control.

Declaration
public const int DefaultHeight = 22
Field Value
Type Description
System.Int32

DefaultPathSeparator

Default Bar's path separator.

Declaration
public const string DefaultPathSeparator = "\\"
Field Value
Type Description
System.String

Properties

AllowEditMode

Gets or sets a value indicating whether the bar should go into edit mode.

Declaration
public bool AllowEditMode { get; set; }
Property Value
Type Description
System.Boolean

BackColor

Gets or sets the background color for the control.

Declaration
public override Color BackColor { get; set; }
Property Value
Type Description
System.Drawing.Color

BackgroundImage

Gets or sets the background image displayed in the control.

Declaration
public override Image BackgroundImage { get; set; }
Property Value
Type Description
System.Drawing.Image

BackgroundImageLayout

Gets or sets the background image layout as defined in the System.Windows.Forms.ImageLayout enumeration.

Declaration
public override ImageLayout BackgroundImageLayout { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageLayout
Exceptions
Type Condition
System.ComponentModel.InvalidEnumArgumentException

The specified enumeration value does not exist.

Bars

Gets the collection of Bars.

Declaration
public BarCollection Bars { get; }
Property Value
Type Description
BarCollection

BeforeTouchSize

Gets/Sets Control size before touch enabled

Declaration
public Size BeforeTouchSize { get; set; }
Property Value
Type Description
System.Drawing.Size

BorderColor

Gets or sets the color of the bars' area border.

Declaration
public Color BorderColor { get; set; }
Property Value
Type Description
System.Drawing.Color

The color of the border.

CustomButtons

Gets the collection of s.

Declaration
public CustomButtonCollection CustomButtons { get; }
Property Value
Type Description
CustomButtonCollection

CustomRender

Gets/Set the customized render for the NavigationView.

Declaration
public RendrerBase CustomRender { get; set; }
Property Value
Type Description
RendrerBase

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
Type Description
System.Drawing.Size

DisabledImageList

Gets or sets the disabled image list for Bars.

Declaration
public ImageList DisabledImageList { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageList

EnableTouchMode

Gets or sets value to enable or disable the Touchmode to the controls.

Declaration
public bool EnableTouchMode { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Scale factor will be updated automatically if scalefactor is equal to 1

Font

Declaration
public override Font Font { get; set; }
Property Value
Type Description
System.Drawing.Font

HistoryEnabled

Gets or sets a value indicating whether registered items are in history list.

Declaration
public bool HistoryEnabled { get; set; }
Property Value
Type Description
System.Boolean

HistoryManager

Gets or sets the HistoryManager to use.

Declaration
public HistoryManager HistoryManager { get; set; }
Property Value
Type Description
HistoryManager

ImageList

Gets or sets the image list for Bars.

Declaration
public ImageList ImageList { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageList

InEditingMode

Gets or sets a value indicating whether the control is in editing mode.

Declaration
public bool InEditingMode { get; set; }
Property Value
Type Description
System.Boolean

Initializing

Gets a value indicating whether this NavigationView is initializing.

Declaration
public bool Initializing { get; }
Property Value
Type Description
System.Boolean

Office2007ColorTheme

Gets or sets Office2007Theme to use.

Declaration
public Office2007Theme Office2007ColorTheme { get; set; }
Property Value
Type Description
Office2007Theme

Path

Gets or sets the chain (path) of the Bars ended with SelectedBar.

Declaration
protected List<Bar> Path { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Bar>

PopupDropDownSize

Gets or sets the size of the recently visited popup drop-down.

Declaration
public Size PopupDropDownSize { get; set; }
Property Value
Type Description
System.Drawing.Size

RecentlyVisitedPaths

Gets or sets the recently visited paths.

Declaration
public string[] RecentlyVisitedPaths { get; set; }
Property Value
Type Description
System.String[]

The array of strings.

SelectedBar

Gets or sets the current selected bar.

Declaration
public Bar SelectedBar { get; set; }
Property Value
Type Description
Bar

SelectedBars

Gets the chain (path) of the Bars ended with SelectedBar.

Declaration
public List<Bar> SelectedBars { get; }
Property Value
Type Description
System.Collections.Generic.List<Bar>

ShowBorder

Gets or sets a value indicating whether to show border.

Declaration
public bool ShowBorder { get; set; }
Property Value
Type Description
System.Boolean

true to show border; otherwise, false.

ShowHistoryButtons

Gets or sets a value indicating whether to show history buttons.

Declaration
public bool ShowHistoryButtons { get; set; }
Property Value
Type Description
System.Boolean

true to show history buttons; otherwise, false.

ShowRootBarText

Gets or sets a value indicating whether to show text of root Bars.

Declaration
public bool ShowRootBarText { get; set; }
Property Value
Type Description
System.Boolean

TextBox

Gets the text box for edit mode.

Declaration
protected TextBoxExt TextBox { get; }
Property Value
Type Description
TextBoxExt

ThemeStyle

Gets or sets the NavigationViewVisualStyle value used to customize the appearance of the NavigationView.

Declaration
public NavigationViewVisualStyle ThemeStyle { get; set; }
Property Value
Type Description
NavigationViewVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

VisibleBars

Gets the collection of visible Bars.

Declaration
public BarCollection VisibleBars { get; }
Property Value
Type Description
BarCollection

VisualStyle

Gets or sets the visual style.

Declaration
public VisualStyles VisualStyle { get; set; }
Property Value
Type Description
VisualStyles

Methods

ApplyCustomStyleColorTable(CustomStyleColorTable)

Apply the ColorTable for Custom style.

Declaration
public void ApplyCustomStyleColorTable(CustomStyleColorTable customStyleColorTable)
Parameters
Type Name Description
CustomStyleColorTable customStyleColorTable

ApplyScaleToControl(Single)

Scale the control based on the scale factor passed in the argument.

Declaration
public void ApplyScaleToControl(float scaleFactor)
Parameters
Type Name Description
System.Single scaleFactor

value to scale the factor based upon.

BeginInit()

Signals the object that initialization is starting.

Declaration
public void BeginInit()

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.

EndInit()

Signals the object that initialization is complete.

Declaration
public void EndInit()

GetBarDropDownArrowBounds(BarLayoutInfo, Image)

Gets the bounds of bar's drop-down button's arrow.

Declaration
protected Rectangle GetBarDropDownArrowBounds(BarLayoutInfo layout, Image image)
Parameters
Type Name Description
BarLayoutInfo layout

The bar's layout.
System.Drawing.Image image

The image.
Returns
Type Description
System.Drawing.Rectangle

The arrow bounds.

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName
Returns
Type Description
System.String
Overrides

IsValidBar(Bar)

Determines whether NavigationView contains the specified bar.

Declaration
public bool IsValidBar(Bar bar)
Parameters
Type Name Description
Bar bar

The bar to be verified.
Returns
Type Description
System.Boolean

true if the control contains the specified bar; otherwise, false.

IsValidBar(Bar, BarCollection, List<Bar>)

Determines whether BarCollection contains the specified bar.

Declaration
protected bool IsValidBar(Bar bar, BarCollection bars, List<Bar> path)
Parameters
Type Name Description
Bar bar

The bar to be verified.
BarCollection bars

The collection of bars.
System.Collections.Generic.List<Bar> path

If not null, will contain hierarchy of parent bars Bars of searched bar.
Returns
Type Description
System.Boolean

true if the collection contains the specified bar; otherwise, false.
Remarks

Method perfomes deep (recursive) search.

OnBarPopup(BarPopupEventArgs)

Declaration
protected virtual void OnBarPopup(BarPopupEventArgs e)
Parameters
Type Name Description
BarPopupEventArgs e

OnCanApplyThemeChanged(Boolean)

Helps to apply the CanApplyTheme settings in control

Declaration
public override void OnCanApplyThemeChanged(bool canApplyTheme)
Parameters
Type Name Description
System.Boolean canApplyTheme
Overrides

OnCanOverrideStyleChanged(Boolean)

Helps to apply the CanOverriderStyle settings in control

Declaration
public override void OnCanOverrideStyleChanged(bool canOverriderStyle)
Parameters
Type Name Description
System.Boolean canOverriderStyle
Overrides

OnControlAdded(ControlEventArgs)

Raises the System.Windows.Forms.Control.ControlAdded event.

Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

A System.Windows.Forms.ControlEventArgs that contains the event data.

OnControlRemoved(ControlEventArgs)

Raises the System.Windows.Forms.Control.ControlRemoved event.

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

A System.Windows.Forms.ControlEventArgs that contains the event data.

OnCustomButtonLayout(Object, LayoutEventArgs)

Declaration
public void OnCustomButtonLayout(object sender, LayoutEventArgs e)
Parameters
Type Name Description
System.Object sender
System.Windows.Forms.LayoutEventArgs e

OnFontChanged(EventArgs)

Raises the System.Windows.Forms.Control.FontChanged event.

Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.

OnHandleCreated(EventArgs)

Raises the System.Windows.Forms.Control.HandleCreated event.

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.

OnLayout(LayoutEventArgs)

Raises the System.Windows.Forms.Control.Layout event.

Declaration
protected override void OnLayout(LayoutEventArgs levent)
Parameters
Type Name Description
System.Windows.Forms.LayoutEventArgs levent

A System.Windows.Forms.LayoutEventArgs that contains the event data.

OnMouseClick(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseClick event.

Declaration
protected override void OnMouseClick(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseDown(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseDown event.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseLeave(EventArgs)

Raises the System.Windows.Forms.Control.MouseLeave event.

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseMove event.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseUp(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseUp event.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.

OnPaint(PaintEventArgs)

Raises the Paint event.

Declaration
protected override void OnPaint(PaintEventArgs pe)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs pe

The System.Windows.Forms.PaintEventArgs instance containing the event data.

OnRightToLeftChanged(EventArgs)

Raises the System.Windows.Forms.Control.RightToLeftChanged event.

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.

OnSizeChanged(EventArgs)

Size changed

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

RenderBar(Bar, BarLayoutInfo)

Renders the bar.

Declaration
protected void RenderBar(Bar bar, BarLayoutInfo layout)
Parameters
Type Name Description
Bar bar

The bar to be rendered.
BarLayoutInfo layout

The bar's layout info.

RenderBarBackground(Bar, BarLayoutInfo)

Renders the bar's background.

Declaration
protected void RenderBarBackground(Bar bar, BarLayoutInfo layout)
Parameters
Type Name Description
Bar bar

The bar to be rendered.
BarLayoutInfo layout

The bar's layout info.

RenderBarDropDown(Bar, BarLayoutInfo)

Renders the bar's drop down button.

Declaration
protected void RenderBarDropDown(Bar bar, BarLayoutInfo layout)
Parameters
Type Name Description
Bar bar

The bar to be rendered.
BarLayoutInfo layout

The bar's layout info.

RenderBarText(Bar, AreaStates, Rectangle)

Renders the bar's text.

Declaration
protected void RenderBarText(Bar bar, AreaStates state, Rectangle textBounds)
Parameters
Type Name Description
Bar bar

The bar to be rendered.
AreaStates state

The state.
System.Drawing.Rectangle textBounds

The text bounds.

RenderDropDown(LayoutInfo)

Renders the drop-down button.

Declaration
protected void RenderDropDown(LayoutInfo layout)
Parameters
Type Name Description
LayoutInfo layout

The drop-down button's layout.

RenderEditorArea(LayoutInfo)

Renders the textbox editor area.

Declaration
protected void RenderEditorArea(LayoutInfo layout)
Parameters
Type Name Description
LayoutInfo layout

RenderHistoryBackButton(LayoutInfo)

REnders the history back button.

Declaration
protected void RenderHistoryBackButton(LayoutInfo layout)
Parameters
Type Name Description
LayoutInfo layout

Layout

RenderHistoryDropDownButton(LayoutInfo)

Renders histroy dropdown button background.

Declaration
protected void RenderHistoryDropDownButton(LayoutInfo layout)
Parameters
Type Name Description
LayoutInfo layout

RenderHistoryForwardButton(LayoutInfo)

Renders the history forward button.

Declaration
protected void RenderHistoryForwardButton(LayoutInfo layout)
Parameters
Type Name Description
LayoutInfo layout

Layout

ResetCustomRender()

Reset the CustomRender.

Declaration
public void ResetCustomRender()

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Performs the work of setting the specified bounds of this control.

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
Type Name Description
System.Int32 x

The new System.Windows.Forms.Control.Left property value of the control.
System.Int32 y

The new System.Windows.Forms.Control.Top property value of the control.
System.Int32 width

The new System.Windows.Forms.Control.Width property value of the control.
System.Int32 height

The new System.Windows.Forms.Control.Height property value of the control.
System.Windows.Forms.BoundsSpecified specified

A bitwise combination of the System.Windows.Forms.BoundsSpecified values.

Events

BarAdded

Occurs when Bar is added to Bars collection.

Declaration
public event CollectionChangeEventHandler BarAdded
Event Type
Type Description
System.ComponentModel.CollectionChangeEventHandler

BarPopup

Declaration
public event EventHandler<BarPopupEventArgs> BarPopup
Event Type
Type Description
System.EventHandler<BarPopupEventArgs>

BarRemoved

Occurs when Bar is removed from Bars collection.

Declaration
public event CollectionChangeEventHandler BarRemoved
Event Type
Type Description
System.ComponentModel.CollectionChangeEventHandler

BarSelectionChanged

Occurs when SelectedBar property is changed.

Declaration
public event EventHandler<BarSelectionChangedEventArgs> BarSelectionChanged
Event Type
Type Description
System.EventHandler<BarSelectionChangedEventArgs>

BarSelectionChanging

Occurs when SelectedBar property is changing.

Declaration
public event EventHandler<BarSelectionChangingEventArgs> BarSelectionChanging
Event Type
Type Description
System.EventHandler<BarSelectionChangingEventArgs>

HistoryUpButtonMouseState

Event for find out the state of the HistoryUpButton.

Declaration
public event NavigationView.HistoryUpButtonState HistoryUpButtonMouseState
Event Type
Type Description
NavigationView.HistoryUpButtonState

PopupClosed

Occurs when when the recently visited popup is closed.

Declaration
public event EventHandler PopupClosed
Event Type
Type Description
System.EventHandler

PopupShown

Occurs when when the recently visited popup is shown.

Declaration
public event EventHandler PopupShown
Event Type
Type Description
System.EventHandler

Explicit Interface Implementations

ISupportOffice2007Theme.EnableOffice2007Style()

Enables rendering with Office2007Theme.

Declaration
void ISupportOffice2007Theme.EnableOffice2007Style()

IVisualStyle.VisualTheme

Declaration
string IVisualStyle.VisualTheme { get; set; }
Returns
Type Description
System.String

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize
System.Windows.Forms.IMessageFilter