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.

public abstract class NavigationBarRenderer : DisposableObject, IDisposable, INavigationBarRenderer, IUIRenderer
Inheritance:
Object MarshalByRefObject DisposableObject Object
Derived:
Office2003NavigationBarRenderer
Implements:
IDisposable INavigationBarRenderer IUIRenderer

Constructors

NavigationBarRenderer()

Initializes a new instance of the NavigationBarRenderer class.

public NavigationBarRenderer()

Remarks

The default constructor initializes all fields to their default values.

Properties

DefaultRenderer

Gets a NavigationBarRenderer that should be used based on the current system settings.

public static NavigationBarRenderer DefaultRenderer { get; }

Property Value

NavigationBarRenderer:

A NavigationBarRenderer that should be used based on the current system settings.

NavigationBarOverflowMenuButtonWidth

Gets or sets the width of a NavigationBar overflow menu button.

public virtual int NavigationBarOverflowMenuButtonWidth { get; set; }

Property Value

Int32:

The width of a NavigationBar overflow menu button.

NavigationBarSplitterHeight

Gets or sets the height of a NavigationBar splitter.

public virtual int NavigationBarSplitterHeight { get; set; }

Property Value

Int32:

The height of a NavigationBar splitter.

NavigationPaneButtonHeight

Gets or sets the height of a NavigationPaneButton.

public virtual int NavigationPaneButtonHeight { get; set; }

Property Value

Int32:

The height of a NavigationPaneButton.

NavigationPaneButtonOverflowWidth

Gets or sets the width of a NavigationPaneButton in the overflow area.

public virtual int NavigationPaneButtonOverflowWidth { get; set; }

Property Value

Int32:

The width of a NavigationPaneButton in the overflow area.

ResetAllPropertiesOnSystemColorChange

Gets or sets whether to reset all properties when a system color change event occurs.

public bool ResetAllPropertiesOnSystemColorChange { get; set; }

Property Value

Boolean:

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

Methods

Dispose(Boolean)

Disposes any resources used by the object.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing Boolean

Whether the object is being disposed.

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

A PaintEventArgs that contains 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

A PaintEventArgs that contains 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

A PaintEventArgs that contains 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

A PaintEventArgs that contains 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

A PaintEventArgs that contains 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

A PaintEventArgs that contains 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

A PaintEventArgs that contains 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

A PaintEventArgs that contains 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

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
button NavigationPaneButton

The NavigationPaneButton to draw.

Equals(Object)

Determines whether the specified Object is equal to the current Object.

public override bool Equals(object obj)
Parameter Type Description
obj Object

The Object to compare to the current Object.

Returns

Boolean:

true if the specified Object is equal to the current Object; otherwise, false.

GetHashCode()

Returns a hash code for this object.

public override int GetHashCode()

Returns

Int32:

An integer value that specifies a hash value for this object.

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.

OnPropertyChanged(EventArgs)

Raises the PropertyChanged event.

protected virtual void OnPropertyChanged(EventArgs e)
Parameter Type Description
e EventArgs

An EventArgs that contains the event data.

ResetAll(Boolean)

Resets all property values to their defaults.

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

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

Boolean:

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

Boolean:

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

Boolean:

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

Boolean:

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

Boolean:

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

Events

PropertyChanged

Occurs after a property is changed.

public event EventHandler PropertyChanged

Event Type

EventHandler

Inherited Members