New to Telerik UI for WinForms? Start a free 30-day trial

DockHelper

Class

A helper class that exposes common methods, used across a docking framework.

Definition

Namespace:Telerik.WinControls.UI.Docking

Assembly:Telerik.WinControls.RadDock.dll

Syntax:

public static class DockHelper

Inheritance: objectDockHelper

Fields

MaxSize

Size

Default maximum size.

public static readonly Size MaxSize

MinSize

Size

Default minimum size.

public static readonly Size MinSize

Methods

CenterRect(Rectangle, Size)

Retrieves a Rectangle structure, that is aligned within the specified bounds, and is with the desired size.

public static Rectangle CenterRect(Rectangle bounds, Size size)

Parameters:boundsRectangle

The outer Rectangle structure, used as an alignment

sizeSize

The size of the newly created rectangle.

Returns:

Rectangle

CleanupContainer(RadSplitContainer, RadDock)

Performs a clean-up logic upon the specified RadSplitContainer instance, associated with the specified RadDock instance.

public static void CleanupContainer(RadSplitContainer container, RadDock dockManager)

Parameters:containerRadSplitContainerdockManagerRadDock

CollapseOrDisposeStrips(RadSplitContainer, RadDock)

Asks all DockTabStrip instances to check whether they need to be collapsed or disposed. Used in a clean-up pass of RadDock for a control tree defragmentation.

public static void CollapseOrDisposeStrips(RadSplitContainer container, RadDock dockManager)

Parameters:containerRadSplitContainerdockManagerRadDock

EnsureSizeBounds(Size, Size, Size)

Applies Minimum and Maximum constraints to the specified Size structure.

public static Size EnsureSizeBounds(Size size, Size min, Size max)

Parameters:sizeSize

The size, which is the constraint target.

minSize

The size, which is the minimum allowed.

maxSize

The size, which is the maximum allowed.

Returns:

Size

EnsureSizeBounds(SizeF, SizeF, SizeF)

Applies Minimum and Maximum constraints to the specified SizeF structure.

public static SizeF EnsureSizeBounds(SizeF size, SizeF min, SizeF max)

Parameters:sizeSizeF

The size, which is the constraint target.

minSizeF

The size, which is the minimum allowed.

maxSizeF

he size, which is the maximum allowed.

Returns:

SizeF

EnsureSizeMaxBounds(Size, Size)

Applies Maximum constraint to the specified Size structure.

public static Size EnsureSizeMaxBounds(Size size, Size max)

Parameters:sizeSize

The size, which is the constraint target.

maxSize

The size, which is the maximum allowed.

Returns:

Size

EnsureSizeMinBounds(Size, Size)

Applies Minimum constraint to the specified Size structure.

public static Size EnsureSizeMinBounds(Size size, Size min)

Parameters:sizeSize

The size, which is the constraint target.

minSize

The size, which is the minimum allowed.

Returns:

Size

FindCommonAncestor(SplitPanel, SplitPanel)

Finds the first RadSplitContainer instance, which contains both specified panels.

public static RadSplitContainer FindCommonAncestor(SplitPanel child1, SplitPanel child2)

Parameters:child1SplitPanelchild2SplitPanelReturns:

RadSplitContainer

GetAllowedDockState(DockState)

Retrieves an AllowedDockState value from the specified DockState.

public static AllowedDockState GetAllowedDockState(DockState state)

Parameters:stateDockStateReturns:

AllowedDockState

GetAutoHidePosition(DockPosition)

Retrieves an AutoHidePosition value from the specified DockPosition.

public static AutoHidePosition GetAutoHidePosition(DockPosition position)

Parameters:positionDockPositionReturns:

AutoHidePosition

GetDirectChildContainingPanel(RadSplitContainer, SplitPanel)

Traverses the tree of split containers and finds the panel, which is direct child of the specified container and contains the specified split panel as a descendant.

public static SplitPanel GetDirectChildContainingPanel(RadSplitContainer container, SplitPanel descendant)

Parameters:containerRadSplitContainerdescendantSplitPanelReturns:

SplitPanel

GetDockPosition(AllowedDockPosition)

Retrieves a DockPosition value from the specified AllowedDockPosition.

public static DockPosition GetDockPosition(AllowedDockPosition position)

Parameters:positionAllowedDockPositionReturns:

DockPosition

GetDockTabStrips<T>(Control, bool, RadDock)

Collects all the DockTabStrip instances, residing on the specified parent, and associated with the provided RadDock instance.

public static List<T> GetDockTabStrips<T>(Control parent, bool recursive, RadDock dockManager) where T : DockTabStrip

Parameters:parentControlrecursivebooldockManagerRadDockReturns:

List<T>

GetDockWindows(Control, bool, RadDock)

Collects all the DockWindow instances, residing on the specified parent, and associated with the provided RadDock instance.

public static List<DockWindow> GetDockWindows(Control parent, bool recursive, RadDock dockManager)

Parameters:parentControlrecursivebooldockManagerRadDockReturns:

List<DockWindow>

GetSplitContainers(Control, bool, RadDock)

Collects all the RadSplitContainer instances, residing on the specified parent, and associated with the provided RadDock instance.

public static List<RadSplitContainer> GetSplitContainers(Control parent, bool recursive, RadDock dockManager)

Parameters:parentControlrecursivebooldockManagerRadDockReturns:

List<RadSplitContainer>

MergeContainers(RadSplitContainer)

Defragments the tree of RadSplitContainer instances. Used by a RadDock control to clean-up unnecessary containers.

public static void MergeContainers(RadSplitContainer parentContainer)

Parameters:parentContainerRadSplitContainer

ShouldBeginDrag(Point, Point)

Determines whether a Drag operation should be started.

public static bool ShouldBeginDrag(Point curr, Point capture)

Parameters:currPoint

The current cursor location.

capturePoint

The cursor location

Returns:

bool

ToAllowedDockState(DockState)

public static AllowedDockState ToAllowedDockState(this DockState dockstate)

Parameters:dockstateDockStateReturns:

AllowedDockState