ToolBar Class

[ToolboxBitmap(typeof(ToolBar))]
public class ToolBar : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDisposable, IBarControl, IBarObject, IDpiAwareElement, IOrientedElement, IWeakEventListener

public ToolBar()

public virtual BarManager BarManager { get; set; }

Property Value

BarManager:

The BarManager that is managing the toolbar.

[Browsable(false)]
public Rectangle BodyBounds { get; }

Property Value

Rectangle:

The bounds of the toolbar body area that contains the command links.

[Browsable(false)]
public BarCommandLinkCollection CommandLinks { get; }

Property Value

BarCommandLinkCollection:

The BarCommandLinkCollection containing the command links for use in the control.

public int DefaultToolBarStyledMenuWrapWidth { get; set; }

Property Value

int:

The default menu wrap width, in pixels.

Remarks

This property value is primarily used for menus that have a toolbar style.

public string Key { get; set; }

Property Value

string:

A string-based key that uniquely identifies the toolbar.

public Orientation Orientation { get; set; }

Property Value

Orientation:

A Orientation that specifies the orientation.

public IBarRenderer Renderer { get; set; }

Property Value

IBarRenderer:

The control-specific IBarRenderer used to render the control.

Remarks

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

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

Property Value

IBarRenderer:

The IBarRenderer used to render the control.

Remarks

This property will return a global renderer if there is no control instance renderer override.

[Browsable(false)]
public Rectangle ScreenBounds { get; }

Property Value

Rectangle:

A Rectangle specifying the screen bounds of the control.

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.

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 void Dispose(bool disposing)

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

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.

protected virtual void OnCommandClick(BarCommandLinkEventArgs e)

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

protected virtual void OnCommandPopup(BarCommandLinkEventArgs e)

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

protected virtual void OnCommandUpdate(BarCommandLinkEventArgs e)

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

protected override void OnMouseDown(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs 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 override void OnMouseUp(MouseEventArgs e)

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

protected override void OnRender(PaintEventArgs e)

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

protected override void OnRenderChildElements(PaintEventArgs e)

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

Remarks

This method should not generally be overridden. The default implementation of this method calls the Render(PaintEventArgs) method on all child elements.

protected override void WndProc(ref Message m)

Parameter	Type	Description
m	Message	Information about the message.

public event BarCommandLinkEventHandler CommandClick

Event Type

BarCommandLinkEventHandler

public event BarCommandLinkEventHandler CommandPopup

Event Type

BarCommandLinkEventHandler

public event BarCommandLinkEventHandler CommandUpdate

Event Type

BarCommandLinkEventHandler