DockableToolBar Class

[TypeConverter(typeof(DockableToolBarConverter))]
public class DockableToolBar : UIElement, IInputElement, IUIElement, ILogicalTreeNode, IDisposable, IBarControl, IBarObject, IDpiAwareElement, IOrientedElement, IHasDefaultCommandLinks

public DockableToolBar(string key)

Parameter	Type	Description
key	string	A string-based key that uniquely identifies the toolbar.

public bool Active { get; set; }

Property Value

bool:

true if the toolbar is active (visible); otherwise, false.

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

Property Value

int:

The index of the row in which the toolbar is actually docked, or -1 if not docked or visible.

Remarks

This value provides the actual docked row of the toolbar, as opposed to the DockedRow property, which provides the desired docked row.

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

Property Value

bool:

true if the toolbar should be made visible or hidden depending on the mode; otherwise, false.

Remarks

This property is auto-updated when the Active property value changes and should not generally be set externally.

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

Property Value

Rectangle:

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

public DefaultableBoolean CanClose { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the toolbar may be closed.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting.

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

Property Value

bool:

true if the toolbar may be closed; otherwise, false.

public DefaultableBoolean CanDockHostBottom { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the toolbar may be docked to the bottom of the host container control.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting.

public DefaultableBoolean CanDockHostLeft { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the toolbar may be docked to the left of the host container control.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting.

public DefaultableBoolean CanDockHostRight { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the toolbar may be docked to the right of the host container control.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting.

public DefaultableBoolean CanDockHostTop { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the toolbar may be docked to the top of the host container control.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting.

public DefaultableBoolean CanDrag { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the toolbar may be dragged to another location.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting.

public DefaultableBoolean CanFloat { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the toolbar may be contained in a floating window.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting.

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

Property Value

BarCommandLinkCollection:

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

public DockableToolBarCreationStyle CreationStyle { get; set; }

Property Value

DockableToolBarCreationStyle:

A DockableToolBarCreationStyle indicating the creation style of the toolbar.

Remarks

Non-custom toolbars may not be renamed or deleted by the end-user.

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

Property Value

BarCommandLinkCollection:

The BarCommandLinkCollection containing the default command links used when resetting the toolbar.

public int DockedColumn { get; set; }

Property Value

int:

The index of the column in which the toolbar should be docked within the current row.

public int DockedRow { get; set; }

Property Value

int:

The index of the row in which the toolbar should be docked.

public Point FloatingLocation { get; set; }

Property Value

Point:

The Point at which the toolbar is located when floating.

public virtual DefaultableBoolean HasOptionsButton { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean indicating whether the toolbar has an options button.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global ActiproSoftware.UI.WinForms.Controls.Bars.DockableToolBar.BarManager setting. If this value resolves to true then the toolbar will display an options button.

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

Property Value

bool:

true if the toolbar has overflowed command links; otherwise, false.

public string Key { get; set; }

Property Value

string:

A string-based key that uniquely identifies the toolbar.

public BarModeCollection Modes { get; }

Property Value

BarModeCollection:

A BarModeCollection containing the names of the modes in which the toolbar is automatically made visible or hidden.

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

Property Value

Orientation:

A Orientation that specifies the orientation.

public DockableToolBarPosition Position { get; set; }

Property Value

DockableToolBarPosition:

The DockableToolBarPosition that indicates the position of the toolbar.

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

public virtual bool RequiresFullRow { get; set; }

Property Value

bool:

true if the toolbar requires a full row in the layout; otherwise, false.

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

Property Value

Rectangle:

A Rectangle specifying the screen bounds of the control.

public string Text { get; set; }

Property Value

string:

The text of the toolbar that is displayed in the user interface.

Remarks

If this value is null, the value of the Key property will be used for the user interface.

[Browsable(false)]
public string TitleBarText { get; }

Property Value

string:

The text of the toolbar that is displayed in floating toolbar captions and customize dialogs.

Remarks

This property returns the value of the Text property if it is not null. Otherwise, the value of the Key property is returned.

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.

public void DockTo(DockableToolBarPosition position, int dockedRow, int dockedColumn, bool requiresNewRow)

Parameter	Type	Description
position	DockableToolBarPosition	The DockableToolBarPosition that indicates the dock position of the toolbar.
dockedRow	int	The index of the row in which the toolbar should be docked.
dockedColumn	int	The index of the column in which the toolbar should be docked within the row.
requiresNewRow	bool	Whether the docking requires a new row. Even if false, other conditions may insert the toolbar in a new row anyhow.

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 override void OnMouseDown(MouseEventArgs e)

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

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 virtual void ReadAttributesFromXml(BarLayoutXmlSerializer serializer)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.

protected virtual void ReadElementFromXml(BarLayoutXmlSerializer serializer)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.

public void Redock()

public virtual void Reset()

public virtual void ResetActive()

public virtual void ResetCanClose()

public virtual void ResetCanDockHostBottom()

public virtual void ResetCanDockHostLeft()

public virtual void ResetCanDockHostRight()

public virtual void ResetCanDockHostTop()

public virtual void ResetCanDrag()

public virtual void ResetCanFloat()

public virtual void ResetCreationStyle()

public virtual void ResetDockedColumn()

public virtual void ResetDockedRow()

public virtual void ResetFloatingLocation()

public virtual void ResetHasOptionsButton()

public virtual void ResetPosition()

public virtual void ResetRequiresFullRow()

public virtual void ResetText()

public virtual bool ShouldSerializeActive()

Returns

bool:

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

public virtual bool ShouldSerializeCanClose()

Returns

bool:

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

public virtual bool ShouldSerializeCanDockHostBottom()

Returns

bool:

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

public virtual bool ShouldSerializeCanDockHostLeft()

Returns

bool:

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

public virtual bool ShouldSerializeCanDockHostRight()

Returns

bool:

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

public virtual bool ShouldSerializeCanDockHostTop()

Returns

bool:

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

public virtual bool ShouldSerializeCanDrag()

Returns

bool:

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

public virtual bool ShouldSerializeCanFloat()

Returns

bool:

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

public virtual bool ShouldSerializeCreationStyle()

Returns

bool:

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

public virtual bool ShouldSerializeDockedColumn()

Returns

bool:

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

public virtual bool ShouldSerializeDockedRow()

Returns

bool:

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

public virtual bool ShouldSerializeFloatingLocation()

Returns

bool:

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

public virtual bool ShouldSerializeHasOptionsButton()

Returns

bool:

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

public virtual bool ShouldSerializePosition()

Returns

bool:

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

public virtual bool ShouldSerializeRequiresFullRow()

Returns

bool:

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

public virtual bool ShouldSerializeText()

Returns

bool:

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

public void Undock()

protected virtual void WriteAttributesToXml(BarLayoutXmlSerializer serializer)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.

protected virtual void WriteElementsToXml(BarLayoutXmlSerializer serializer)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.