Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

NavigationBarRenderer Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Navigation
Assembly:
ActiproSoftware.Navigation.WinForms.dll

Provides a base renderer for the NavigationBar control.

[ToolboxBitmap(typeof(NavigationBarRenderer))]
[TypeConverter(typeof(GenericExpandableNullableObjectConverter))]
public abstract class NavigationBarRenderer : UIRenderer, IDisposable, INavigationBarRenderer, IUIRenderer
Inheritance:
object DisposableObjectBase UIRenderer object
Derived:
OfficeLunaNavigationBarRenderer
Implements:
IDisposable INavigationBarRenderer IUIRenderer

Constructors

NavigationBarRenderer()

Initializes an instance of the class.

public NavigationBarRenderer()

NavigationBarRenderer(IWindowsColorScheme)

Initializes an instance of the class.

protected NavigationBarRenderer(IWindowsColorScheme colorScheme)
Parameter Type Description
colorScheme IWindowsColorScheme

The IWindowsColorScheme to use as a base for the colors.

Properties

NavigationBarOverflowMenuButtonWidth

The width of a NavigationBar overflow menu button.

public virtual int NavigationBarOverflowMenuButtonWidth { get; set; }

Property Value

int

NavigationBarSplitterHeight

The height of a NavigationBar splitter.

public virtual int NavigationBarSplitterHeight { get; set; }

Property Value

int

NavigationPaneButtonHeight

The height of a NavigationPaneButton.

public virtual int NavigationPaneButtonHeight { get; set; }

Property Value

int

NavigationPaneButtonOverflowWidth

The width of a NavigationPaneButton in the overflow area.

public virtual int NavigationPaneButtonOverflowWidth { get; set; }

Property Value

int

ResetAllPropertiesOnSystemColorChange

Indicates whether to reset all properties when a system color change event occurs.

public bool ResetAllPropertiesOnSystemColorChange { get; set; }

Property Value

bool:

true if all properties should be reset; otherwise, false.

Methods

DrawNavigationBarBackground(PaintEventArgs, Rectangle, NavigationBar)

Draws the background of a NavigationBar control.

public abstract void DrawNavigationBarBackground(PaintEventArgs e, Rectangle bounds, NavigationBar navigationBar)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
navigationBar NavigationBar

The NavigationBar being painted.

DrawNavigationBarHeader(PaintEventArgs, Rectangle, NavigationBar)

Draws the header of a NavigationBar control.

public abstract void DrawNavigationBarHeader(PaintEventArgs e, Rectangle bounds, NavigationBar navigationBar)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
navigationBar NavigationBar

The NavigationBar being painted.

DrawNavigationBarHeader(PaintEventArgs, Rectangle, NavigationBarPanel)

Draws the header of a NavigationBarPanel control.

public abstract void DrawNavigationBarHeader(PaintEventArgs e, Rectangle bounds, NavigationBarPanel navigationBarPanel)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
navigationBarPanel NavigationBarPanel

The NavigationBarPanel being painted.

DrawNavigationBarOverflowArea(PaintEventArgs, Rectangle, NavigationBar)

Draws the overflow area of a NavigationBar control.

public abstract void DrawNavigationBarOverflowArea(PaintEventArgs e, Rectangle bounds, NavigationBar navigationBar)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
navigationBar NavigationBar

The NavigationBar being painted.

DrawNavigationBarOverflowMenuButton(PaintEventArgs, Rectangle, NavigationBarOverflowMenuButton)

Draws the overflow menu button of a NavigationBar control.

public abstract void DrawNavigationBarOverflowMenuButton(PaintEventArgs e, Rectangle bounds, NavigationBarOverflowMenuButton menuButton)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
menuButton NavigationBarOverflowMenuButton

The NavigationBarOverflowMenuButton being painted.

DrawNavigationBarPanelBackground(PaintEventArgs, Rectangle, NavigationBarPanel)

Draws the background of a NavigationBarPanel control.

public abstract void DrawNavigationBarPanelBackground(PaintEventArgs e, Rectangle bounds, NavigationBarPanel navigationBarPanel)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
navigationBarPanel NavigationBarPanel

The NavigationBarPanel being painted.

DrawNavigationBarSplitter(PaintEventArgs, Rectangle, NavigationBar)

Draws the splitter of a NavigationBar control.

public abstract void DrawNavigationBarSplitter(PaintEventArgs e, Rectangle bounds, NavigationBar navigationBar)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
navigationBar NavigationBar

The NavigationBar being painted.

DrawNavigationPaneBackground(PaintEventArgs, Rectangle, NavigationPane)

Draws the background of a NavigationPane control.

public abstract void DrawNavigationPaneBackground(PaintEventArgs e, Rectangle bounds, NavigationPane navigationPane)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
navigationPane NavigationPane

The NavigationPane being painted.

DrawNavigationPaneButton(PaintEventArgs, Rectangle, NavigationPaneButton)

Draws the NavigationPaneButton for a NavigationPane in a NavigationBar control.

public abstract void DrawNavigationPaneButton(PaintEventArgs e, Rectangle bounds, NavigationPaneButton button)
Parameter Type Description
e PaintEventArgs

The event data.
bounds Rectangle

The bounds in which to draw.
button NavigationPaneButton

The NavigationPaneButton to draw.

MeasureNavigationBarHeader(Graphics?, NavigationBar)

Measures the header for the specified NavigationBar.

public abstract Size MeasureNavigationBarHeader(Graphics? g, NavigationBar navigationBar)
Parameter Type Description
g Graphics

The Graphics object used to measure.
navigationBar NavigationBar

The NavigationBar whose header is being measured.

Returns

Size:

The Size of the header.

MeasureNavigationBarHeader(Graphics?, NavigationBarPanel)

Measures the header for the specified NavigationBarPanel.

public abstract Size MeasureNavigationBarHeader(Graphics? g, NavigationBarPanel navigationBarPanel)
Parameter Type Description
g Graphics

The Graphics object used to measure.
navigationBarPanel NavigationBarPanel

The NavigationBarPanel whose header is being measured.

Returns

Size:

The Size of the header.

OnSystemUserPreferenceColorChanged()

Occurs when user preferences are changed for the color category.

protected override void OnSystemUserPreferenceColorChanged()

Remarks

This method will only be invoked if IsSystemUserPreferenceColorChangeMonitored returns true.

ResetAll(bool)

Resets all property values to their defaults.

protected virtual void ResetAll(bool force)
Parameter Type Description
force bool

Whether to force resetting.

ResetNavigationBarOverflowMenuButtonWidth()

Resets the NavigationBarOverflowMenuButtonWidth property to its default value.

public virtual void ResetNavigationBarOverflowMenuButtonWidth()

ResetNavigationBarSplitterHeight()

Resets the NavigationBarSplitterHeight property to its default value.

public virtual void ResetNavigationBarSplitterHeight()

ResetNavigationPaneButtonHeight()

Resets the NavigationPaneButtonHeight property to its default value.

public virtual void ResetNavigationPaneButtonHeight()

ResetNavigationPaneButtonOverflowWidth()

Resets the NavigationPaneButtonOverflowWidth property to its default value.

public virtual void ResetNavigationPaneButtonOverflowWidth()

ResetResetAllPropertiesOnSystemColorChange()

Resets the ResetAllPropertiesOnSystemColorChange property to its default value.

public virtual void ResetResetAllPropertiesOnSystemColorChange()

ShouldSerializeNavigationBarOverflowMenuButtonWidth()

Indicates whether the NavigationBarOverflowMenuButtonWidth property should be persisted.

public virtual bool ShouldSerializeNavigationBarOverflowMenuButtonWidth()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeNavigationBarSplitterHeight()

Indicates whether the NavigationBarSplitterHeight property should be persisted.

public virtual bool ShouldSerializeNavigationBarSplitterHeight()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeNavigationPaneButtonHeight()

Indicates whether the NavigationPaneButtonHeight property should be persisted.

public virtual bool ShouldSerializeNavigationPaneButtonHeight()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeNavigationPaneButtonOverflowWidth()

Indicates whether the NavigationPaneButtonOverflowWidth property should be persisted.

public virtual bool ShouldSerializeNavigationPaneButtonOverflowWidth()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeResetAllPropertiesOnSystemColorChange()

Indicates whether the ResetAllPropertiesOnSystemColorChange property should be persisted.

public virtual bool ShouldSerializeResetAllPropertiesOnSystemColorChange()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

Inherited Members

Extension Methods