ToolBar Class
Represents a standalone toolbar control.
public class ToolBar : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDisposable, IBarControl, IBarObject, IWeakEventListener
- Implements:
- IUIControl IUIElement ILogicalTreeNode IDisposable IBarControl IBarObject IWeakEventListener
Constructors
ToolBar()
Initializes a new instance of the ToolBar
class.
public ToolBar()
Properties
BarManager
Gets or sets the BarManager that is managing the toolbar.
public virtual BarManager BarManager { get; set; }
Property Value
- BarManager:
The BarManager that is managing the toolbar.
BodyBounds
Gets the bounds of the toolbar body area that contains the command links.
public Rectangle BodyBounds { get; }
Property Value
- Rectangle:
The bounds of the toolbar body area that contains the command links.
CommandLinks
Gets the BarCommandLinkCollection containing the command links for use in the control.
public BarCommandLinkCollection CommandLinks { get; }
Property Value
- BarCommandLinkCollection:
The BarCommandLinkCollection containing the command links for use in the control.
DefaultToolBarStyledMenuWrapWidth
Gets or sets the default menu wrap width, in pixels.
public int DefaultToolBarStyledMenuWrapWidth { get; set; }
Property Value
- Int32:
The default menu wrap width, in pixels.
Remarks
This property value is primarily used for menus that have a toolbar style.
Key
Gets or sets a string-based key that uniquely identifies the toolbar.
public string Key { get; set; }
Property Value
- String:
A string-based key that uniquely identifies the toolbar.
Orientation
Gets or sets the orientation of the toolbar.
public Orientation Orientation { get; set; }
Property Value
- Orientation:
A Orientation that specifies the orientation.
Renderer
Gets or sets the control-specific IBarRenderer used to render the control.
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.
RendererResolved
Gets the IBarRenderer used to render the control.
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.
ScreenBounds
Gets the screen bounds of the control.
public Rectangle ScreenBounds { get; }
Property Value
- Rectangle:
A
Rectangle
specifying 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
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
Remarks
By default no child collection is created.
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. |
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.
OnCommandClick(BarCommandLinkEventArgs)
Raises the CommandClick
event.
protected virtual void OnCommandClick(BarCommandLinkEventArgs e)
Parameter | Type | Description |
---|---|---|
e | BarCommandLinkEventArgs | A |
OnCommandPopup(BarCommandLinkEventArgs)
Raises the CommandPopup
event.
protected virtual void OnCommandPopup(BarCommandLinkEventArgs e)
Parameter | Type | Description |
---|---|---|
e | BarCommandLinkEventArgs | A |
OnCommandUpdate(BarCommandLinkEventArgs)
Raises the CommandUpdate
event.
protected virtual void OnCommandUpdate(BarCommandLinkEventArgs e)
Parameter | Type | Description |
---|---|---|
e | BarCommandLinkEventArgs | A |
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 OnMouseLeave
event.
protected override void OnMouseLeave(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An EventArgs that contains the event data. |
OnMouseMove(MouseEventArgs)
Raises the OnMouseMove
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 | A PaintEventArgs that contains the event data. |
OnRenderChildElements(PaintEventArgs)
Renders the child elements.
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.
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.
Explicit Interface Implementations
IBarControl.Close(BarPopupCloseReason)
Closes the IBarControl, if on a popup.
void IBarControl.Close(BarPopupCloseReason closeReason)
Parameter | Type | Description |
---|---|---|
closeReason | BarPopupCloseReason | A BarPopupCloseReason specifying the close reason. |
IBarControl.CloseAllPopups(BarPopupCloseReason)
Closes all active popups.
void IBarControl.CloseAllPopups(BarPopupCloseReason closeReason)
Parameter | Type | Description |
---|---|---|
closeReason | BarPopupCloseReason | A BarPopupCloseReason specifying the close reason. |
IBarControl.CloseChildPopup(BarPopupCloseReason)
Closes the child popup of the IBarControl.
void IBarControl.CloseChildPopup(BarPopupCloseReason closeReason)
Parameter | Type | Description |
---|---|---|
closeReason | BarPopupCloseReason | A BarPopupCloseReason specifying the close reason. |
IBarControl.Control
Gets the Control that contains the IBarControl.
IBarControl.DisplayOrientation
Gets the current display orientation of the bar control, if docked.
Orientation IBarControl.DisplayOrientation { get; }
Returns
- Orientation:
A Orientation that specifies the orientation.
IBarControl.DisplayStyle
Gets the display style of command links in the bar control.
BarControlDisplayStyle IBarControl.DisplayStyle { get; }
Returns
- BarControlDisplayStyle:
A BarControlDisplayStyle that specifies the display style.
IBarControl.Guid
Gets a GUID that uniquely identifies the IBarControl.
IBarControl.HasGripper
Gets whether the bar control has a gripper.
bool IBarControl.HasGripper { get; }
Returns
- Boolean:
true
if the bar control has a gripper; otherwise,false
.
IBarControl.HitTest(Point)
Hit tests the specified screen Point
for a BarCommandLink.
BarCommandLink IBarControl.HitTest(Point point)
Parameter | Type | Description |
---|---|---|
point | Point | The screen |
Returns
- BarCommandLink:
The BarCommandLink at the specified
Point
.
IBarControl.HitTestForCustomizeDropTarget(BarCommandLink, Point)
Hit tests the specified screen Point
for a customize drop target.
BarCustomizeDropTarget IBarControl.HitTestForCustomizeDropTarget(BarCommandLink sourceCommandLink, Point point)
Parameter | Type | Description |
---|---|---|
sourceCommandLink | BarCommandLink | The source BarCommandLink. |
point | Point | The screen |
Returns
- BarCustomizeDropTarget:
A BarCustomizeDropTarget that specifies a customize drop target.
IBarControl.InCustomizeMode
Gets whether the bar control is in customize mode.
bool IBarControl.InCustomizeMode { get; }
Returns
- Boolean:
true
if the bar control is in customize mode; otherwise,false
.
IBarControl.InDesignMode
Gets whether the bar control is in design mode.
bool IBarControl.InDesignMode { get; }
Returns
- Boolean:
true
if the bar control is in design mode; otherwise,false
.
IBarControl.IsOnPopup
Gets whether the control is on a popup.
bool IBarControl.IsOnPopup { get; }
Returns
- Boolean:
true
if the control is on a popup; otherwise,false
.
IBarControl.LayoutOrientation
Gets the current layout orientation of the bar control, if docked.
Orientation IBarControl.LayoutOrientation { get; }
Returns
- Orientation:
A Orientation that specifies the orientation.
IBarControl.LayoutStyle
Gets the layout style of command links in the bar control.
BarControlLayoutStyle IBarControl.LayoutStyle { get; }
Returns
- BarControlLayoutStyle:
A BarControlLayoutStyle that specifies the layout style.
IBarControl.OwnerCommandLink
Gets the BarCommandLink that owns the bar control, if on a popup.
BarCommandLink IBarControl.OwnerCommandLink { get; }
Returns
- BarCommandLink:
The BarCommandLink that owns the bar control, if on a popup.
IBarControl.OwnerCommandLinkDisplaySide
Gets or sets the side of the OwnerCommandLink that the bar control is displayed, if on a popup.
Sides IBarControl.OwnerCommandLinkDisplaySide { get; set; }
Returns
IBarControl.Process(BarProcessEventArgs)
Performs processing based on some sort of event.
void IBarControl.Process(BarProcessEventArgs e)
Parameter | Type | Description |
---|---|---|
e | BarProcessEventArgs | A |
IBarControl.SelectedCommandLink
Gets or sets the selected BarCommandLink.
BarCommandLink IBarControl.SelectedCommandLink { get; set; }
Returns
- BarCommandLink:
The selected BarCommandLink.
IBarControl.SelectNextCommandLink()
Selects the next command link.
BarCommandLink IBarControl.SelectNextCommandLink()
Returns
- BarCommandLink:
The BarCommandLink that was selected.
IBarControl.SelectPreviousCommandLink()
Selects the previous command link.
BarCommandLink IBarControl.SelectPreviousCommandLink()
Returns
- BarCommandLink:
The BarCommandLink that was selected.
IBarControl.Update()
void IBarControl.Update()
IBarObject.BarManager
Gets the BarManager that is managing the command link.
BarManager IBarObject.BarManager { get; }
Returns
- BarManager:
The BarManager that is managing the command link.
IWeakEventListener.ReceiveWeakEvent(Type, Object, EventArgs)
Handles a weak event.
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
.
Inherited Members
- UIControl.ILogicalTreeNode.FindAncestor(Type)
- UIControl.ILogicalTreeNode.GetCommonAncestor(ILogicalTreeNode)
- UIControl.ILogicalTreeNode.IsAncestorOf(ILogicalTreeNode)
- UIControl.ILogicalTreeNode.IsDescendantOf(ILogicalTreeNode)
- UIControl.IUIControl.AddPendingGraphicsInversion(Rectangle)
- UIControl.IUIControl.AddPendingScrollOperation(Rectangle, Orientation, Int32)
- UIControl.IUIControl.AddPendingScrollOperation(Rectangle, Int32, Int32)
- UIControl.IUIControl.AddToInvalidatedRegion(Rectangle)
- UIControl.IUIElement.GetDrawState()
- UIControl.IUIElement.HitTest(PointHitTestParameters)
- UIControl.IUIElement.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIControl.IUIElement.HitTestRecursive(PointHitTestParameters)
- UIControl.IUIElement.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIControl.IUIElement.NotifyChildDesiredSizeChanged()
- UIControl.IUIElement.NotifyMouseLeaveEvent()
- UIControl.AddPendingGraphicsInversion(Rectangle)
- UIControl.AddPendingScrollOperation(Rectangle, Orientation, Int32)
- UIControl.AddPendingScrollOperation(Rectangle, Int32, Int32)
- UIControl.AddToInvalidatedRegion()
- UIControl.AddToInvalidatedRegion(Rectangle)
- UIControl.Arrange(Rectangle)
- UIControl.ContainsLocation(Point)
- UIControl.GetCursor(Point)
- UIControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIControl.InvalidateArrange()
- UIControl.InvalidateMeasure()
- UIControl.Measure(Graphics, Size)
- UIControl.OnClick(EventArgs)
- UIControl.OnDoubleClick(EventArgs)
- UIControl.OnHandleCreated(EventArgs)
- UIControl.OnLayout(LayoutEventArgs)
- UIControl.OnLocationChanged(EventArgs)
- UIControl.OnMouseEnter(EventArgs)
- UIControl.OnMouseHover(EventArgs)
- UIControl.OnMouseWheel(MouseEventArgs)
- UIControl.OnPaint(PaintEventArgs)
- UIControl.OnPaintBackground(PaintEventArgs)
- UIControl.OnParentChanged()
- UIControl.OnResize(EventArgs)
- UIControl.OnRightToLeftChanged(EventArgs)
- UIControl.OnVisibleChanged(EventArgs)
- UIControl.Render(PaintEventArgs)
- UIControl.ResetDoubleBufferCanvas(Boolean)
- UIControl.ResumePainting()
- UIControl.SuspendPainting()
- UIControl.TransformToAncestor(IUIElement)
- UIControl.TransformToDescendant(IUIElement)
- UIControl.UpdateLayout()
- UIControl.IUIElement.CreateGraphics()
- UIControl.ILogicalTreeNode.Children
- UIControl.ILogicalTreeNode.Parent
- UIControl.IUIControl.MouseCaptureElement
- UIControl.IUIControl.Capture
- UIControl.IUIElement.Bounds
- UIControl.IUIElement.Size
- UIControl.IUIElement.Visibility
- UIControl.IUIElement.VisualOffset
- UIControl.ActualHeight
- UIControl.ActualWidth
- UIControl.BackColor
- UIControl.BackgroundImage
- UIControl.CaptureMouseWhenPressed
- UIControl.ClipBounds
- UIControl.DesiredSize
- UIControl.Font
- UIControl.ForeColor
- UIControl.IsArrangeValid
- UIControl.IsMeasureValid
- UIControl.IsPaintValid
- UIControl.IsRightToLeft
- UIControl.LastMouseUpButton
- UIControl.PaintingSuspended
- UIControl.UseControlGraphicsForMeasure
- UIControl.UseExtendedDoubleBuffering