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

DockContainerContainer Class

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

Represents a dock container that can hold other dock containers.

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

Constructors

DockContainerContainer()

Initializes a new instance of the DockContainerContainer class.

public DockContainerContainer()

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.

DockContainers

Gets the collection of child DockContainer controls.

[Browsable(false)]
public DockContainerCollection DockContainers { get; }

Property Value

DockContainerCollection:

A DockContainerCollection containing the collection of child DockContainer controls.

Remarks

If the DockObjectType of this object is not DockContainerContainer, this property will return null.

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.

Orientation

Gets or sets the Orientation that contains the orientation of child dock containers.

public Orientation Orientation { get; set; }

Property Value

Orientation:

The Orientation that contains the orientation of child dock containers.

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.

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

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