Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

ToolWindowContainer Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Docking
Assembly:
ActiproSoftware.Docking.WinForms.dll

Represents a dock container that can hold tool windows.

public class ToolWindowContainer : DockContainer, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IDockObject
Inheritance:
object MarshalByRefObject Component Control ScrollableControl UIControl DockContainer object
Implements:
IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IDockObject

Constructors

ToolWindowContainer()

Initializes a new instance of the ToolWindowContainer class.

public ToolWindowContainer()

Properties

DisplayRectangle

Gets the rectangle that represents the display area of the control.

public override Rectangle DisplayRectangle { get; }

Property Value

Rectangle:

A Rectangle that represents the display area of the control.

DockObjectType

Gets a DockObjectType specifying the type of dock object.

public override DockObjectType DockObjectType { get; }

Property Value

DockObjectType:

A DockObjectType specifying the type of dock object.

SelectedToolWindow

Gets or sets the selected ToolWindow.

[Browsable(false)]
public override ToolWindow SelectedToolWindow { get; set; }

Property Value

ToolWindow:

The selected ToolWindow.

ToolWindows

Gets the collection of child ToolWindow controls.

[Browsable(false)]
public override ToolWindowCollection ToolWindows { get; }

Property Value

ToolWindowCollection:

A ToolWindowCollection containing the collection of child ToolWindow controls.

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.

AutoHide()

Auto-hides the tool windows in the ToolWindowContainer.

public void AutoHide()

Close()

Closes all the tool windows in the DockContainer.

public override void Close()

Remarks

This method may only be called if the DockObjectType is ToolWindowContainer or AutoHideContainer.

ContainsToolWindow(string[])

Returns whether the container or one of its children contains a ToolWindow with any of the specified GUIDs.

protected override bool ContainsToolWindow(string[] guids)
Parameter Type Description
guids string[]

The array of GUIDs.

Returns

bool:

true if the container or one of its children contains a ToolWindow with any of the specified GUIDs; otherwise, false.

CreateControlsInstance()

Creates a new instance of the control collection for the control.

protected override Control.ControlCollection CreateControlsInstance()

Returns

Control.ControlCollection:

A new instance of a Control.ControlCollection assigned to the control.

GetToolWindowCount()

Returns the number of ToolWindow objects within the container or its child controls.

protected override int GetToolWindowCount()

Returns

int

HitTestForDock(Point)

Hits tests a Point to see if a dock should occur.

protected override DockStyle HitTestForDock(Point point)
Parameter Type Description
point Point

The Point to test.

Returns

DockStyle:

A DockStyle indicating the side of which to dock.

InvalidateTitleBar()

Invalidates the title bar.

public void InvalidateTitleBar()

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.

ProcessCmdKey(ref Message, Keys)

Processes a key.

protected override bool ProcessCmdKey(ref Message m, Keys keyData)
Parameter Type Description
m Message

The message to process.
keyData Keys

One of the Keys values that represents the key to process.

Returns

bool:

true if the key was processed by the control; otherwise, false.

ToString()

Converts the object to a String.

public override string ToString()

Returns

string:

A string whose value represents this object.

Undock()

Undocks the DockContainer.

public override void Undock()

Remarks

This method may only be called if the DockObjectType is ToolWindowContainer or AutoHideContainer.

UpdateImageList()

Updates the ImageList used with the container.

protected override void UpdateImageList()

UpdateTabStrip()

Updates the TabStrip used within the container.

protected override void UpdateTabStrip()

UpdateTitleBar()

Updates the title bar.

protected override void UpdateTitleBar()

Inherited Members