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

AutoHideContainer Class

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

Represents a container that can hold tool windows in an auto-hide state.

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

Constructors

AutoHideContainer()

Initializes a new instance of the AutoHideContainer class.

public AutoHideContainer()

Properties

AutoHideTabStripPanel

Gets or sets the AutoHideTabStripPanel that contains the tabs for the tool windows.

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

Property Value

AutoHideTabStripPanel:

The AutoHideTabStripPanel that contains the tabs for the tool windows.

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.

DockManager

Gets or sets the DockManager that is managing the dock object.

public override DockManager DockManager { get; set; }

Property Value

DockManager:

The DockManager that is managing the dock object.

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.

RootDock

Gets the DockStyle that describes the root's dock style.

public override DockStyle RootDock { get; }

Property Value

DockStyle:

The DockStyle that describes the root's dock style.

SelectedToolWindow

Gets the selected ToolWindow.

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

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.

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.

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.

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.

Undock()

Undocks the DockContainer.

public override void Undock()

Remarks

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

UpdateTitleBar()

Updates the title bar.

protected override void UpdateTitleBar()

Inherited Members