In This Article

NavigationBarPanel Class

Represents a panel for a navigation bar control.

[ToolboxBitmap(typeof(NavigationBarPanel))]
public class NavigationBarPanel : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IWeakEventListener
Inheritance:
object MarshalByRefObject Component Control ScrollableControl UIControl object
Implements:
IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IWeakEventListener

Constructors

NavigationBarPanel()

Initializes a new instance of the NavigationBarPanel class.

public NavigationBarPanel()

Remarks

The default constructor initializes all fields to their default values.

Properties

DefaultSize

Gets the default size of the control.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

DisplayRectangle

Gets the rectangle that represents the display area of the control.

public override Rectangle DisplayRectangle { get; }

Property Value

Rectangle:

A Rectangle that represents the display area of the control.

Image

Gets or sets the image that is displayed on the header.

public Image Image { get; set; }

Property Value

Image:

The Image displayed on the header. The default value is null.

Renderer

Gets or sets the control-specific INavigationBarRenderer used to render the control.

public INavigationBarRenderer Renderer { get; set; }

Property Value

INavigationBarRenderer:

The control-specific INavigationBarRenderer used to render the control.

Remarks

If this value is null, then the global renderer will be used instead.

RendererResolved

Gets the INavigationBarRenderer used to render the control.

[Browsable(false)]
public INavigationBarRenderer RendererResolved { get; }

Property Value

INavigationBarRenderer:

The INavigationBarRenderer used to render the control.

Remarks

This property will return a global renderer if there is no control instance renderer override. The registered renderer type with the UIRendererManager for this property is INavigationBarRenderer.

Style

Gets or sets a NavigationBarPanelStyle describing the rendering style of the control.

public NavigationBarPanelStyle Style { get; set; }

Property Value

NavigationBarPanelStyle:

A NavigationBarPanelStyle describing the rendering style of the control.

UseExtendedDoubleBuffering

Gets or sets whether to use extended double buffering for rendering.

protected override bool UseExtendedDoubleBuffering { get; }

Property Value

bool:

true if extended double buffering should be used; otherwise, false.

Methods

ArrangeOverride(Size)

Positions child elements and determines an arrange size.

protected override Size ArrangeOverride(Size finalSize)
Parameter Type Description
finalSize Size

The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

Remarks

Element authors should override this method, call Arrange on each visible child element and position each child element. It is required that a parent element calls Arrange on each child or they won't be rendered.

CreateChildren()

Invoked when the collection of child elements is to be created.

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

Dispose(bool)

Disposes any resources used by the object.

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

Whether the object is being disposed.

MeasureOverride(Graphics, Size)

Measures the size in layout required for child elements and determines a size for the element itself.

protected override Size MeasureOverride(Graphics g, Size availableSize)
Parameter Type Description
g Graphics

The Graphics object to use for measurement.

availableSize Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure on each visible child element and determine the total size required.

OnRender(PaintEventArgs)

Renders the element.

protected override void OnRender(PaintEventArgs e)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

OnTextChanged(EventArgs)

Occurs when the Text property is changed.

protected override void OnTextChanged(EventArgs e)
Parameter Type Description
e EventArgs

Event arguments.

Inherited Members