ClassDockHelper
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
Default maximum size.
Methods
CenterRect(Rectangle, Size)
Retrieves a Rectangle structure, that is aligned within the specified bounds, and is with the desired size.
CleanupContainer(RadSplitContainer, RadDock)
Performs a clean-up logic upon the specified RadSplitContainer instance, associated with the specified RadDock instance.
Declaration
public static void CleanupContainer(RadSplitContainer container, RadDock dockManager)
Parameters
container
dockManager
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.
Declaration
public static void CollapseOrDisposeStrips(RadSplitContainer container, RadDock dockManager)
Parameters
container
dockManager
EnsureSizeBounds(Size, Size, Size)
Applies Minimum and Maximum constraints to the specified Size structure.
EnsureSizeBounds(SizeF, SizeF, SizeF)
Applies Minimum and Maximum constraints to the specified SizeF structure.
EnsureSizeMaxBounds(Size, Size)
Applies Maximum constraint to the specified Size structure.
EnsureSizeMinBounds(Size, Size)
Applies Minimum constraint to the specified Size structure.
FindCommonAncestor(SplitPanel, SplitPanel)
Finds the first RadSplitContainer instance, which contains both specified panels.
Declaration
public static RadSplitContainer FindCommonAncestor(SplitPanel child1, SplitPanel child2)
Parameters
child1
child2
Returns
GetAllowedDockState(DockState)
Retrieves an AllowedDockState value from the specified DockState.
Declaration
public static AllowedDockState GetAllowedDockState(DockState state)
Parameters
state
Returns
GetAutoHidePosition(DockPosition)
Retrieves an AutoHidePosition value from the specified DockPosition.
Declaration
public static AutoHidePosition GetAutoHidePosition(DockPosition position)
Parameters
position
Returns
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.
Declaration
public static SplitPanel GetDirectChildContainingPanel(RadSplitContainer container, SplitPanel descendant)
Parameters
container
descendant
Returns
GetDockPosition(AllowedDockPosition)
Retrieves a DockPosition value from the specified AllowedDockPosition.
Declaration
public static DockPosition GetDockPosition(AllowedDockPosition position)
Parameters
position
Returns
GetDockTabStrips<T>(Control, bool, RadDock)
Collects all the DockTabStrip instances, residing on the specified parent, and associated with the provided RadDock instance.
GetDockWindows(Control, bool, RadDock)
Collects all the DockWindow instances, residing on the specified parent, and associated with the provided RadDock instance.
Declaration
public static List<DockWindow> GetDockWindows(Control parent, bool recursive, RadDock dockManager)
Parameters
parent
recursive
dockManager
Returns
List<DockWindow>
GetSplitContainers(Control, bool, RadDock)
Collects all the RadSplitContainer instances, residing on the specified parent, and associated with the provided RadDock instance.
Declaration
public static List<RadSplitContainer> GetSplitContainers(Control parent, bool recursive, RadDock dockManager)
Parameters
parent
recursive
dockManager
Returns
List<RadSplitContainer>
MergeContainers(RadSplitContainer)
Defragments the tree of RadSplitContainer instances. Used by a RadDock control to clean-up unnecessary containers.
Declaration
public static void MergeContainers(RadSplitContainer parentContainer)
Parameters
parentContainer
ShouldBeginDrag(Point, Point)
Determines whether a Drag operation should be started.
ToAllowedDockState(DockState)
Declaration
public static AllowedDockState ToAllowedDockState(this DockState dockstate)
Parameters
dockstate
Returns