In This Article

BarDockArea Class

Represents a bar dock area.

public class BarDockArea : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IWeakEventListener
Inheritance:
object MarshalByRefObject Component Control ScrollableControl UIControl object
Implements:
IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IWeakEventListener

Constructors

BarDockArea()

Initializes a new instance of the BarDockArea class.

public BarDockArea()

Properties

BarManager

Gets or sets the BarManager that is managing the control.

public BarManager BarManager { get; set; }

Property Value

BarManager:

The BarManager that is managing the control.

Orientation

Gets the current orientation of the dock area.

[Browsable(false)]
public Orientation Orientation { get; }

Property Value

Orientation:

A Orientation that specifies the orientation.

RendererResolved

Gets the IBarRenderer used to render the control.

[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.

Rows

Gets the collection of toolbar rows that are contained in the dock area.

[Browsable(false)]
public DockableToolBarRowCollection Rows { get; }

Property Value

DockableToolBarRowCollection:

A DockableToolBarRowCollection containing the rows.

TabIndex

Gets or sets the tab order of the control within its container.

[Browsable(false)]
public int TabIndex { get; set; }

Property Value

int:

The index value of the control within the set of controls within its container that are included in the tab order.

TabStop

Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.

[Browsable(false)]
public bool TabStop { get; set; }

Property Value

bool:

true if the user can give the focus to the control using the TAB key; otherwise, false. The default is true.

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.

HitTestForDockableToolBar(Point)

Hit tests for the DockableToolBar at the specified Point.

public DockableToolBar HitTestForDockableToolBar(Point point)
Parameter Type Description
point Point

The Point to examine.

Returns

DockableToolBar:

The DockableToolBar at the specified Point.

OnLayout(LayoutEventArgs)

Raises the Layout event.

protected override void OnLayout(LayoutEventArgs e)
Parameter Type Description
e LayoutEventArgs

An LayoutEventArgs that contains 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 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.

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.

Inherited Members