DockContainer Class

public abstract class DockContainer : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IDockObject

public DockContainer()

[Browsable(false)]
public virtual DockManager? DockManager { get; set; }

Property Value

DockManager

public abstract DockObjectType DockObjectType { get; }

Property Value

DockObjectType

[Browsable(false)]
public virtual DockStyle RootDock { get; }

Property Value

DockStyle

public virtual ToolWindow? SelectedToolWindow { get; set; }

Property Value

ToolWindow

Remarks

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

public abstract ToolWindowCollection ToolWindows { get; }

Property Value

ToolWindowCollection

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(Rectangle) on each visible child element and position each child element. It is required that a parent element calls Arrange(Rectangle) on each child or they won't be rendered.

public abstract void Close()

Remarks

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

protected abstract 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.

protected override IList<ILogicalTreeNode> CreateChildren()

Returns

IList<ILogicalTreeNode>:

The list 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	true to release both managed and unmanaged resources; false to release only unmanaged resources.

protected abstract int GetToolWindowCount()

Returns

int

protected virtual DockStyle HitTestForDock(Point point)

Parameter	Type	Description
point	Point	The Point to test.

Returns

DockStyle:

A DockStyle indicating the side of which to dock.

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(Graphics?, Size) on each visible child element and determine the total size required.

protected override void OnDockChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnEnter(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnLeave(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnRender(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	The event data.

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

Parameter	Type	Description
m	Message
keyData	Keys	One of the Keys values that represents the key to process.

Returns

bool:

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

public abstract void Undock()

Remarks

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

protected virtual void UpdateImageList()

public override void UpdateLayout()

Remarks

This ensures that UIElement objects with invalid measure or arrange states will get a call to their Measure(Graphics?, Size) and Arrange(Rectangle) methods, and all computed sizes will be validated. This method does nothing if layout is clean but it does work if layout is not clean so avoid calling it after each change in the element tree. It makes sense to either never call it (system will do this in a deferred manner) or only call it if you absolutely need updated sizes and positions after you do all changes.

protected virtual void UpdateTabStrip()

protected abstract void UpdateTitleBar()