ToolBar Class
Represents a standalone toolbar control.
[ToolboxBitmap(typeof(ToolBar))]
public class ToolBar : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDisposable, IBarControl, IBarObject, IDpiAwareElement, IOrientedElement, IWeakEventListener- Inheritance:
- object MarshalByRefObject Component Control ScrollableControl UIControl object
- Implements:
- IUIControl IUIElement ILogicalTreeNode IDisposable IBarControl IBarObject IDpiAwareElement IOrientedElement IWeakEventListener
Constructors
ToolBar()
Initializes an instance of the class.
public ToolBar()Properties
BarManager
The BarManager that is managing the toolbar.
BodyBounds
The bounds of the toolbar body area that contains the command links.
CommandLinks
The BarCommandLinkCollection containing the command links for use in the control.
[Browsable(false)]
public BarCommandLinkCollection CommandLinks { get; }Property Value
DefaultToolBarStyledMenuWrapWidth
The default menu wrap width, in pixels.
public int DefaultToolBarStyledMenuWrapWidth { get; set; }Property Value
Remarks
This property value is primarily used for menus that have a toolbar style.
Key
A string-based key that uniquely identifies the toolbar.
Orientation
The orientation of the toolbar.
Renderer
The control-specific IBarRenderer used to render the control.
public IBarRenderer? Renderer { get; set; }Property Value
Remarks
If this value is null, then the global renderer will be used instead.
RendererResolved
The IBarRenderer used to render the control.
[Browsable(false)]
public IBarRenderer RendererResolved { get; }Property Value
Remarks
This property will return a global renderer if there is no control instance renderer override.
ScreenBounds
The screen bounds of the control.
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(Rectangle) on each visible child element and position each child element. It is required that a parent element calls Arrange(Rectangle) on each child or they won't be rendered.
CreateChildren()
Invoked when the collection of child elements is to be created.
protected override IList<ILogicalTreeNode> CreateChildren()Returns
- IList<ILogicalTreeNode>:
The list that should be assigned to the Children property.
Remarks
By default, no child collection is created.
Dispose(bool)
Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources.
protected override void Dispose(bool disposing)| Parameter | Type | Description |
|---|---|---|
| disposing | bool |
|
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(Graphics?, Size) on each visible child element and determine the total size required.
OnCommandClick(BarCommandLinkEventArgs)
Raises the CommandClick event.
protected virtual void OnCommandClick(BarCommandLinkEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | BarCommandLinkEventArgs | The event data. |
OnCommandPopup(BarCommandLinkEventArgs)
Raises the CommandPopup event.
protected virtual void OnCommandPopup(BarCommandLinkEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | BarCommandLinkEventArgs | The event data. |
OnCommandUpdate(BarCommandLinkEventArgs)
Raises the CommandUpdate event.
protected virtual void OnCommandUpdate(BarCommandLinkEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | BarCommandLinkEventArgs | The event data. |
OnMouseDown(MouseEventArgs)
Raises the MouseDown event.
protected override void OnMouseDown(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A MouseEventArgs that contains the event data. |
OnMouseLeave(EventArgs)
Raises the MouseLeave event.
protected override void OnMouseLeave(EventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | An EventArgs that contains the event data. |
OnMouseMove(MouseEventArgs)
Raises the MouseMove event.
protected override void OnMouseMove(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A MouseEventArgs that contains the event data. |
OnMouseUp(MouseEventArgs)
Raises the MouseUp event.
protected override void OnMouseUp(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A MouseEventArgs that contains the event data. |
OnRender(PaintEventArgs)
Renders the element.
protected override void OnRender(PaintEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | PaintEventArgs | The event data. |
OnRenderChildElements(PaintEventArgs)
Renders the child elements.
protected override void OnRenderChildElements(PaintEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | PaintEventArgs | 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.
WndProc(ref Message)
Occurs when a message is sent to the control.
protected override void WndProc(ref Message m)| Parameter | Type | Description |
|---|---|---|
| m | Message | Information about the message. |
Events
CommandClick
Occurs when a BarCommand is clicked.
CommandPopup
Occurs when a BarCommand that causes a popup is clicked.
CommandUpdate
Occurs when a BarCommand should be updated.
Inherited Members
- UIControl.AddPendingGraphicsInversion(Rectangle)
- UIControl.AddPendingScrollOperation(Rectangle, Orientation, int)
- UIControl.AddPendingScrollOperation(Rectangle, int, int)
- UIControl.AddToInvalidatedRegion()
- UIControl.AddToInvalidatedRegion(Rectangle)
- UIControl.Arrange(Rectangle)
- UIControl.ContainsLocation(Point)
- UIControl.DpiScaleChanged(SizeF)
- UIControl.GetCursor(Point)
- UIControl.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIControl.InvalidateArrange()
- UIControl.InvalidateMeasure()
- UIControl.Measure(Graphics, Size)
- UIControl.OnClick(EventArgs)
- UIControl.OnDoubleClick(EventArgs)
- UIControl.OnDpiChangedAfterParent(EventArgs)
- UIControl.OnHandleCreated(EventArgs)
- UIControl.OnLayout(LayoutEventArgs)
- UIControl.OnLocationChanged(EventArgs)
- UIControl.OnMouseCaptureChanged(EventArgs)
- UIControl.OnMouseEnter(EventArgs)
- UIControl.OnMouseHover(EventArgs)
- UIControl.OnMouseWheel(MouseEventArgs)
- UIControl.OnPaint(PaintEventArgs)
- UIControl.OnPaintBackground(PaintEventArgs)
- UIControl.OnParentChanged()
- UIControl.OnParentChanged(EventArgs)
- UIControl.OnResize(EventArgs)
- UIControl.OnRightToLeftChanged(EventArgs)
- UIControl.OnVisibleChanged(EventArgs)
- UIControl.Render(PaintEventArgs)
- UIControl.ResetDoubleBufferCanvas(bool)
- UIControl.ResumePainting()
- UIControl.SuspendPainting()
- UIControl.TransformToAncestor(IUIElement)
- UIControl.TransformToDescendant(IUIElement)
- UIControl.UpdateCursor()
- UIControl.UpdateCursor(Point)
- UIControl.UpdateLayout()
- UIControl.ActualHeight
- UIControl.ActualWidth
- UIControl.BackColor
- UIControl.BackgroundImage
- UIControl.CaptureMouseWhenPressed
- UIControl.ClipBounds
- UIControl.DesiredSize
- UIControl.DpiScaleFactor
- UIControl.Font
- UIControl.ForeColor
- UIControl.IsArrangeValid
- UIControl.IsMeasureValid
- UIControl.IsPaintValid
- UIControl.IsRightToLeft
- UIControl.LastMouseUpButton
- UIControl.PaintingSuspended
- UIControl.UseControlGraphicsForMeasure
- UIControl.UseExtendedDoubleBuffering
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()