NavigationBar Class

public class NavigationBar : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDisposable, ISupportInitialize, IWeakEventListener

public NavigationBar()

Remarks

The default constructor initializes all fields to their default values.

public bool CanShowFewerBarButtons { get; }

Property Value

Boolean:

true if the showing of fewer bar buttons is permitted; otherwise, false.

public bool CanShowMoreBarButtons { get; }

Property Value

Boolean:

true if the showing of more bar buttons is permitted; otherwise, false.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

public override Rectangle DisplayRectangle { get; }

Property Value

Rectangle:

A Rectangle that represents the display area of the control.

public ImageList LargeImageList { get; set; }

Property Value

ImageList:

An ImageList. The default value is null.

Remarks

The size of the images should be 32x32 however it looks best to leave some outer padding in the images themselves.

public XmlDocument LayoutData { get; set; }

Property Value

XmlDocument:

An XmlDocument containing the layout data of the NavigationBar layout.

Remarks

This property may throw an exception while loading if the layout data is invalid.

public int MaximumBarButtonCount { get; set; }

Property Value

Int32:

The maximum number of bar buttons to display.

public bool OverflowMenuButtonVisible { get; set; }

Property Value

Boolean:

true if the overflow menu button is visible; otherwise, false.

public NavigationPaneCollection Panes { get; }

Property Value

NavigationPaneCollection:

The NavigationPaneCollection containing the panes in 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.

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.

public int SelectedIndex { get; set; }

Property Value

Int32:

The index of the selected item. If there are no items in the control, this property returns -1.

Remarks

The index is zero-based.

public NavigationPane SelectedPane { get; set; }

Property Value

NavigationPane:

The NavigationPane that is currently selected.

public ImageList SmallImageList { get; set; }

Property Value

ImageList:

An ImageList. The default value is null.

Remarks

The size of the images should be 16x16.

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.

public bool CanMoveNavigationPaneDown(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to test.

Returns

Boolean:

true if the NavigationPane can be moved down; otherwise false.

See Also

• CanMoveNavigationPaneUp(NavigationPane)
• MoveNavigationPaneDown(NavigationPane)
• MoveNavigationPaneUp(NavigationPane)

public bool CanMoveNavigationPaneUp(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to test.

Returns

Boolean:

true if the NavigationPane can be moved up; otherwise false.

See Also

• MoveNavigationPaneUp(NavigationPane)
• MoveNavigationPaneDown(NavigationPane)
• CanMoveNavigationPaneDown(NavigationPane)

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

protected override Control.ControlCollection CreateControlsInstance()

Returns

Control.ControlCollection:

A new instance of a Control.ControlCollection assigned to the control.

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	Boolean	Whether the object is being disposed.

public NavigationPane HitTest(Point point)

Parameter	Type	Description
point	Point	The Point to test.

Returns

NavigationPane:

A NavigationPane whose button contains the Point.

public void LoadLayoutFromFile(string path)

Parameter	Type	Description
path	String	Path to the NavigationBar layout data file.

Remarks

This method may throw an exception if the file is not found or if the layout data is invalid.

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.

public void MoveNavigationPaneDown(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to move.

Exceptions

Type	Condition
ArgumentNullException	Thrown if the argument is null.
ArgumentException	Thrown if the NavigationPane is not a child of this control.
InvalidOperationException	Thrown if the NavigationPane is already at the lowest position.

See Also

• MoveNavigationPaneUp(NavigationPane)
• CanMoveNavigationPaneDown(NavigationPane)
• CanMoveNavigationPaneUp(NavigationPane)

public void MoveNavigationPaneUp(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to move.

Exceptions

Type	Condition
ArgumentNullException	Thrown if the argument is null.
ArgumentException	Thrown if the NavigationPane is not a child of this control.
InvalidOperationException	Thrown if the NavigationPane is already at the highest position.

See Also

• MoveNavigationPaneDown(NavigationPane)
• CanMoveNavigationPaneDown(NavigationPane)
• CanMoveNavigationPaneUp(NavigationPane)

protected virtual void OnContextMenuRequested(NavigationBarContextMenuEventArgs e)

Parameter	Type	Description
e	NavigationBarContextMenuEventArgs	A NavigationBarContextMenuEventArgs that contains the event data.

protected virtual void OnMaximumBarButtonCountChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnMouseLeave(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnMouseMove(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected virtual void OnNavigationPaneActiveChanging(NavigationPaneCancelEventArgs e)

Parameter	Type	Description
e	NavigationPaneCancelEventArgs	A NavigationPaneCancelEventArgs that contains the event data.

protected virtual void OnNavigationPanesReordered(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnRender(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.

protected virtual void OnSelectionChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnSelectionChanging(NavigationPaneCancelEventArgs e)

Parameter	Type	Description
e	NavigationPaneCancelEventArgs	A NavigationPaneCancelEventArgs that contains the event data.

public virtual void ResetLargeImageList()

public virtual void ResetSmallImageList()

public void SaveLayoutToFile(string path)

Parameter	Type	Description
path	String	Path to the NavigationBar layout data file.

Remarks

The output layout data is stored in XML format.

public virtual bool ShouldSerializeLargeImageList()

Returns

Boolean:

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

public virtual bool ShouldSerializeSmallImageList()

Returns

Boolean:

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

public void ShowNavigationBarOptionsForm(Form ownerForm)

Parameter	Type	Description
ownerForm	Form	The owner Form.

protected override void WndProc(ref Message m)

Parameter	Type	Description
m	Message	Information about the message.

public event NavigationBarContextMenuEventHandler ContextMenuRequested

Event Type

NavigationBarContextMenuEventHandler

Remarks

The display of the default menu may be cancelled by setting the Cancel property of the event arguments to true.

public event EventHandler MaximumBarButtonCountChanged

Event Type

EventHandler

public event NavigationPaneCancelEventHandler NavigationPaneActiveChanging

Event Type

NavigationPaneCancelEventHandler

Remarks

Use this event to perform any processing that should occur before the Active property on a NavigationPane changes. The NavigationPane property of the event arguments indicates the NavigationPane that is affected. The property change may be cancelled by setting the Cancel property of the event arguments to true.

public event EventHandler NavigationPanesReordered

Event Type

EventHandler

public event EventHandler SelectionChanged

Event Type

EventHandler

Remarks

Use this event to perform any processing that should occur after the selection changes.

public event NavigationPaneCancelEventHandler SelectionChanging

Event Type

NavigationPaneCancelEventHandler

Remarks

Use this event to perform any processing that should occur before selection changes. The NavigationPane property of the event arguments indicates the NavigationPane about to be selected. The selection change may be cancelled by setting the Cancel property of the event arguments to true.

bool IWeakEventListener.ReceiveWeakEvent(Type managerType, object sender, EventArgs e)

Parameter	Type	Description
managerType	Type	The type of weak event manager.
sender	Object	The sender of the event.
e	EventArgs	The event arguments.

Returns

Boolean:

true if the listener handled the event; otherwise, false.