Class
RadDocking

Represents the RadDocking for Silverlight control wrapper. Serves as a holder for the child split containers and tool windows.

Definition

Namespace:Telerik.WebAii.Controls.Xaml.Wpf

Assembly:Telerik.WebAii.Controls.Xaml.Wpf.dll

Syntax:

cs-api-definition
public class RadDocking : ItemsControl, IAutomationPeer, IPeerConverter, IRadDocking, IControl, IFrameworkElement, ITargetElement

Inheritance: objectAutomationObject<FrameworkElement>FrameworkElementWpfTestElementControlItemsControlRadDocking

Implements: IAutomationPeerIControlIFrameworkElementIPeerConverterIRadDockingITargetElement

Inherited Members ItemsControl.HasItemsPropertyItemsControl.DisplayMemberPathPropertyItemsControl.ItemStringFormatPropertyItemsControl.ItemBindingGroupPropertyItemsControl.IsGroupingPropertyItemsControl.AlternationCountPropertyItemsControl.IsTextSearchEnabledPropertyItemsControl.GetRealType()ItemsControl.HasItemsItemsControl.DisplayMemberPathItemsControl.ItemStringFormatItemsControl.ItemBindingGroupItemsControl.IsGroupingItemsControl.AlternationCountItemsControl.IsTextSearchEnabledControl.BorderBrushPropertyControl.BorderThicknessPropertyControl.BackgroundPropertyControl.ForegroundPropertyControl.FontSizePropertyControl.HorizontalContentAlignmentPropertyControl.VerticalContentAlignmentPropertyControl.TabIndexPropertyControl.IsTabStopPropertyControl.PaddingPropertyControl.FontFamilyPropertyControl.FontStretchPropertyControl.FontStylePropertyControl.FontWeightPropertyControl.BorderBrushControl.BorderThicknessControl.BackgroundControl.ForegroundControl.FontSizeControl.HorizontalContentAlignmentControl.VerticalContentAlignmentControl.TabIndexControl.IsTabStopControl.PaddingControl.FontFamilyControl.FontStretchControl.FontStyleControl.FontWeightWpfTestElement.OverridesDefaultStylePropertyWpfTestElement.BindingGroupPropertyWpfTestElement.InputScopePropertyWpfTestElement.LayoutTransformPropertyWpfTestElement.FlowDirectionPropertyWpfTestElement.ForceCursorPropertyWpfTestElement.ContextMenuPropertyWpfTestElement.IsMouseDirectlyOverPropertyWpfTestElement.IsMouseOverPropertyWpfTestElement.IsStylusOverPropertyWpfTestElement.IsKeyboardFocusWithinPropertyWpfTestElement.IsMouseCapturedPropertyWpfTestElement.IsMouseCaptureWithinPropertyWpfTestElement.IsStylusDirectlyOverPropertyWpfTestElement.IsStylusCapturedPropertyWpfTestElement.IsStylusCaptureWithinPropertyWpfTestElement.IsKeyboardFocusedPropertyWpfTestElement.AllowDropPropertyWpfTestElement.ClipToBoundsPropertyWpfTestElement.SnapsToDevicePixelsPropertyWpfTestElement.IsFocusedPropertyWpfTestElement.IsEnabledPropertyWpfTestElement.IsVisiblePropertyWpfTestElement.FocusablePropertyWpfTestElement.OverridesDefaultStyleWpfTestElement.BindingGroupWpfTestElement.InputScopeWpfTestElement.FlowDirectionWpfTestElement.ForceCursorWpfTestElement.ContextMenuWpfTestElement.IsMouseDirectlyOverWpfTestElement.IsMouseOverWpfTestElement.IsStylusOverWpfTestElement.IsKeyboardFocusWithinWpfTestElement.IsMouseCapturedWpfTestElement.IsMouseCaptureWithinWpfTestElement.IsStylusDirectlyOverWpfTestElement.IsStylusCapturedWpfTestElement.IsStylusCaptureWithinWpfTestElement.IsKeyboardFocusedWpfTestElement.AllowDropWpfTestElement.ClipToBoundsWpfTestElement.SnapsToDevicePixelsWpfTestElement.IsFocusedWpfTestElement.IsEnabledWpfTestElement.IsVisibleWpfTestElement.FocusableWpfTestElement.ComputedVisibilityFrameworkElement.ActualWidthPropertyFrameworkElement.ActualHeightPropertyFrameworkElement.WidthPropertyFrameworkElement.HeightPropertyFrameworkElement.MinWidthPropertyFrameworkElement.MaxWidthPropertyFrameworkElement.MinHeightPropertyFrameworkElement.MaxHeightPropertyFrameworkElement.HorizontalAlignmentPropertyFrameworkElement.VerticalAlignmentPropertyFrameworkElement.MarginPropertyFrameworkElement.DesiredSizePropertyFrameworkElement.RenderSizePropertyFrameworkElement.NamePropertyFrameworkElement.TagPropertyFrameworkElement.DataContextPropertyFrameworkElement.OpacityPropertyFrameworkElement.ClipPropertyFrameworkElement.RenderTransformPropertyFrameworkElement.OpacityMaskPropertyFrameworkElement.RenderTransformOriginPropertyFrameworkElement.IsHitTestVisiblePropertyFrameworkElement.VisibilityPropertyFrameworkElement.GetIdentifier(out string, out string)FrameworkElement.IsChild(FrameworkElement)FrameworkElement.GetChildTagIndex(FrameworkElement)FrameworkElement.InitializeMappings(MappingsCollection)FrameworkElement.As<T>()FrameworkElement.CastAs<T>()FrameworkElement.SetProxy(bool)FrameworkElement.SetUid(string)FrameworkElement.SetFindInfo(VisualFindInfo)FrameworkElement.SetXamlTag(string)FrameworkElement.KeyPress(Keys, int, int, int)FrameworkElement.GetRectangle()FrameworkElement.GetRectangle(FrameworkElement)FrameworkElement.GetIntRectangle()FrameworkElement.IsHitTest()FrameworkElement.IsHitTest(bool)FrameworkElement.IsHitTest(FrameworkElement, bool)FrameworkElement.Highlight()FrameworkElement.Highlight(bool)FrameworkElement.Parent()FrameworkElement.Parent<T>()FrameworkElement.Parent(string)FrameworkElement.Parent(string, bool)FrameworkElement.GetNextSibling()FrameworkElement.GetPrevSibling()FrameworkElement.NextSibling(string)FrameworkElement.NextSibling<T>()FrameworkElement.PreviousSibling(string)FrameworkElement.PreviousSibling<T>()FrameworkElement.AnySibling<T>()FrameworkElement.AnySibling(string)FrameworkElement.GetScreenRectangle()FrameworkElement.ScrollToVisible()FrameworkElement.ScrollToVisible(ScrollToVisibleType)FrameworkElement.EnsureClickable()FrameworkElement.ToXml()FrameworkElement.Refresh()FrameworkElement.Equals(object)FrameworkElement.GetHashCode()FrameworkElement.GetProperties()FrameworkElement.GetAttachedProperty<T>(string, string)FrameworkElement.SetAttachedProperty<T>(string, string, T)FrameworkElement.SetFocus()FrameworkElement.ValidateMouseLocationIfNeeded(Point)FrameworkElement.GetStringPresentation()FrameworkElement.ToRealObject()FrameworkElement.FromRealObject(object)FrameworkElement.ValidateType(Type, string)FrameworkElement.GetKnownControlTypes(TechnologyType)FrameworkElement.RegisterElement(Type, string)FrameworkElement.InitKnownWpfControlTypes()FrameworkElement.InitKnownSilverlightControlTypes()FrameworkElement.InitKnownXamlControlTypes(Type)FrameworkElement.GetControlTypeFromInterface(Type)FrameworkElement.Match(IFindExpression)FrameworkElement.SetDepth(int)FrameworkElement.AddChildNode(ITargetElement)FrameworkElement.SetClosingTag(ITargetElement)FrameworkElement.GetChildren()FrameworkElement.GetParent()FrameworkElement.GetHostParent()FrameworkElement.SetParent(ITargetElement)FrameworkElement.GetUniqueHashCode()FrameworkElement.ToString()FrameworkElement.Capture()FrameworkElement.CaptureImage()FrameworkElement.GetProperty<T>(string)FrameworkElement.GetPropertyTypeSafe(string)FrameworkElement.GetAutomationProperty(string)FrameworkElement.SetProperty(string, object)FrameworkElement.ActualWidthFrameworkElement.ActualHeightFrameworkElement.WidthFrameworkElement.HeightFrameworkElement.MinWidthFrameworkElement.MaxWidthFrameworkElement.MinHeightFrameworkElement.MaxHeightFrameworkElement.HorizontalAlignmentFrameworkElement.VerticalAlignmentFrameworkElement.MarginFrameworkElement.DesiredSizeFrameworkElement.RenderSizeFrameworkElement.NameFrameworkElement.OpacityFrameworkElement.ClipFrameworkElement.RenderTransformFrameworkElement.OpacityMaskFrameworkElement.RenderTransformOriginFrameworkElement.IsHitTestVisibleFrameworkElement.VisibilityFrameworkElement.UidFrameworkElement.MappingsFrameworkElement.AutomationIdFrameworkElement.XamlTagBaseFrameworkElement.TextFrameworkElement.TextBlockContentFrameworkElement.TextLiteralContentFrameworkElement.UserFrameworkElement.XamlTagFrameworkElement.WaitFrameworkElement.FindFrameworkElement.ApplicationFrameworkElement.AbsoluteTagIndexFrameworkElement.TagNameIndexFrameworkElement.AbsoluteSiblingTagIndexFrameworkElement.EnableValidateMouseLocationFrameworkElement.ToolTipTextFrameworkElement.ChildrenFrameworkElement.TechnologyTypeFrameworkElement.DepthFrameworkElement.IsTestRegionFrameworkElement.ParsedElementFrameworkElement.HostAutomationObject<FrameworkElement>.GetProperty(AutomationProperty)AutomationObject<FrameworkElement>.GetProperty(AutomationProperty, object)AutomationObject<FrameworkElement>.SetProperty(AutomationProperty, object)AutomationObject<FrameworkElement>.InvokeMethod(AutomationMethod, params object[])AutomationObject<FrameworkElement>.InvokeMethod(string, params object[])AutomationObject<FrameworkElement>.Serialize()AutomationObject<FrameworkElement>.Deserialize(string)AutomationObject<FrameworkElement>.ReferenceAutomationObject<FrameworkElement>.PropertyBag

Constructors

RadDocking()

Initializes a new instance of the RadDocking class.

Declaration

cs-api-definition
public RadDocking()

Properties

BottomAutoHide

Get the auto hide area positioned on bottom.

Declaration

cs-api-definition
public AutoHideArea BottomAutoHide { get; }

Property Value

AutoHideArea

CompassButtons

Gets a collection of all compass buttons that are visisble.

Declaration

cs-api-definition
public IList<FrameworkElement> CompassButtons { get; }

Property Value

IList<FrameworkElement>

Implements IRadDocking.CompassButtons

DocumentHost

Get the DocumentHost if defined.

Declaration

cs-api-definition
public DocumentHost DocumentHost { get; }

Property Value

DocumentHost

LeftAutoHide

Get the auto hide area positioned on the left.

Declaration

cs-api-definition
public AutoHideArea LeftAutoHide { get; }

Property Value

AutoHideArea

RightAutoHide

Get the auto hide area positioned on the right.

Declaration

cs-api-definition
public AutoHideArea RightAutoHide { get; }

Property Value

AutoHideArea

SplitContainers

Get the list of the root docking panel split containers. The property is cached so make sure to call RadDocking.Refresh() to update it when necessary.

Declaration

cs-api-definition
public IList<IRadSplitContainer> SplitContainers { get; }

Property Value

IList<IRadSplitContainer>

Implements IRadDocking.SplitContainers

ToolWindows

Get the list of ToolWindow controls. The property is cached so make sure to call RadDocking.Refresh() to update it when necessary.

Declaration

cs-api-definition
public IList<IToolWindow> ToolWindows { get; }

Property Value

IList<IToolWindow>

TopAutoHide

Get the auto hide area positioned on top.

Declaration

cs-api-definition
public AutoHideArea TopAutoHide { get; }

Property Value

AutoHideArea

VisibleWindows

Get the list of currently visible windows.

Declaration

cs-api-definition
public IList<IToolWindow> VisibleWindows { get; }

Property Value

IList<IToolWindow>

Implements IRadDocking.VisibleWindows

Methods

AssignReference(AutomationReference)

Assign the reference and perform your custom class initialization.

Declaration

cs-api-definition
public override void AssignReference(AutomationReference reference)

Parameters

reference

AutomationReference

Overrides FrameworkElement.AssignReference(AutomationReference)

Implements IFrameworkElement.AssignReference(AutomationReference)

AutoHidePaneHeaderPin(AutoHideArea)

Simulates user clicking on the auto hide area pin button.

Declaration

cs-api-definition
public void AutoHidePaneHeaderPin(AutoHideArea autoHideArea)

Parameters

autoHideArea

AutoHideArea

The auto hide are the pane to pin back belongs.

DockDocumentPaneInContainer(FrameworkElement, RadSplitContainer, DockPosition, DockingDragDirection)

Dock the document pane into container first undocking it from the current container.

Declaration

cs-api-definition
public void DockDocumentPaneInContainer(FrameworkElement pane, RadSplitContainer targetContainer, DockPosition position, DockingDragDirection undockDirection)

Parameters

pane

FrameworkElement

The document pane to be docked.

targetContainer

RadSplitContainer

The target container to dock to.

position

DockPosition

The position to dock to.

undockDirection

DockingDragDirection

The direction to undock to.

DockDocumentPaneInContainer(RadPane, RadSplitContainer, DockPosition)

Dock the document pane into container.

Declaration

cs-api-definition
public void DockDocumentPaneInContainer(RadPane pane, RadSplitContainer targetContainer, DockPosition position)

Parameters

pane

RadPane

The document pane to be docked.

targetContainer

RadSplitContainer

The target container to dock to.

position

DockPosition

The position to dock to.

DockDocumentPaneInPaneGroup(FrameworkElement, RadPaneGroup, DockPosition, DockingDragDirection)

Dock the document pane into PaneGroup first undocking it from the current container.

Declaration

cs-api-definition
public void DockDocumentPaneInPaneGroup(FrameworkElement pane, RadPaneGroup targetGroup, DockPosition position, DockingDragDirection undockDirection)

Parameters

pane

FrameworkElement

The document pane to be docked.

targetGroup

RadPaneGroup

The target Group to dock to.

position

DockPosition

The position to dock to.

undockDirection

DockingDragDirection

The direction to undock to.

DockDocumentPaneInPaneGroup(RadPane, RadPaneGroup, DockPosition)

Dock the document pane into container.

Declaration

cs-api-definition
public void DockDocumentPaneInPaneGroup(RadPane pane, RadPaneGroup targetGroup, DockPosition position)

Parameters

pane

RadPane

The document pane to be docked.

targetGroup

RadPaneGroup

The target Group to dock to.

position

DockPosition

The position to dock to.

DockGroupInContainer(RadPaneGroup, RadSplitContainer, DockPosition)

Dock the given group into the container undocking it first from the current container.

Declaration

cs-api-definition
public void DockGroupInContainer(RadPaneGroup paneGroup, RadSplitContainer targetContainer, DockPosition position)

Parameters

paneGroup

RadPaneGroup

The pane group to be docked.

targetContainer

RadSplitContainer

The target container to dock to.

position

DockPosition

The position to dock to.

DockGroupInContainer(RadPaneGroup, RadSplitContainer, DockPosition, DockingDragDirection)

Dock the given group into the container undocking it first from the current container.

Declaration

cs-api-definition
public void DockGroupInContainer(RadPaneGroup paneGroup, RadSplitContainer targetContainer, DockPosition position, DockingDragDirection undockDirection)

Parameters

paneGroup

RadPaneGroup

The pane group to be docked.

targetContainer

RadSplitContainer

The target container to dock to.

position

DockPosition

The dock position to dock with.

undockDirection

DockingDragDirection

The direction to undock the group first.

DockGroupInPaneGroup(RadPaneGroup, RadPaneGroup, DockPosition)

Dock the given group into other pane group undocking it first from the current container.

Declaration

cs-api-definition
public void DockGroupInPaneGroup(RadPaneGroup paneGroup, RadPaneGroup targetGroup, DockPosition position)

Parameters

paneGroup

RadPaneGroup

The pane group to be docked.

targetGroup

RadPaneGroup

The target group to dock to.

position

DockPosition

The position to dock to.

DockGroupInPaneGroup(RadPaneGroup, RadPaneGroup, DockPosition, DockingDragDirection)

Dock the given group into other pane group undocking it first from the current container.

Declaration

cs-api-definition
public void DockGroupInPaneGroup(RadPaneGroup paneGroup, RadPaneGroup targetGroup, DockPosition position, DockingDragDirection undockDirection)

Parameters

paneGroup

RadPaneGroup

The pane group to be docked.

targetGroup

RadPaneGroup

The target group to dock to.

position

DockPosition

The dock position to dock with.

undockDirection

DockingDragDirection

The direction to undock the group first.

DockGroupInRoot(RadPaneGroup, DockPosition)

Dock the group into the docking panel root dock position.

Declaration

cs-api-definition
public void DockGroupInRoot(RadPaneGroup paneGroup, DockPosition position)

Parameters

paneGroup

RadPaneGroup

The pane group to be docked.

position

DockPosition

The dock position of the docking panel root.

DockPaneInContainer(FrameworkElement, RadSplitContainer, DockPosition, DockingDragDirection)

Dock the given pane into the container.

Declaration

cs-api-definition
public void DockPaneInContainer(FrameworkElement pane, RadSplitContainer targetContainer, DockPosition position, DockingDragDirection undockDirection)

Parameters

pane

FrameworkElement

The pane to be docked.

targetContainer

RadSplitContainer

The target container to dock to.

position

DockPosition

The position to dock to.

undockDirection

DockingDragDirection

The direction to undock to.

DockPaneInContainer(RadPane, RadSplitContainer, DockPosition)

Dock the given pane into the container.

Declaration

cs-api-definition
public void DockPaneInContainer(RadPane pane, RadSplitContainer targetContainer, DockPosition position)

Parameters

pane

RadPane

The pane to be docked.

targetContainer

RadSplitContainer

The target container to dock into.

position

DockPosition

The position to dock to.

DockPaneInRoot(RadPane, DockPosition)

Dock the pane into the docking root panel.

Declaration

cs-api-definition
public void DockPaneInRoot(RadPane pane, DockPosition position)

Parameters

pane

RadPane

The pane to be docked.

position

DockPosition

The dock position of the docking panel root.

DockWindowInContainer(IToolWindow, RadSplitContainer, DockPosition)

Simulates user docking a tool window into a split container undocking it first from the current container.

Declaration

cs-api-definition
public void DockWindowInContainer(IToolWindow window, RadSplitContainer targetContainer, DockPosition position)

Parameters

window

IToolWindow

The window to be docked.

targetContainer

RadSplitContainer

The target split container to dock to.

position

DockPosition

The dock position to drag to.

DockWindowInPaneGroup(IToolWindow, RadPaneGroup, DockPosition)

Simulates user docking a tool window into a PaneGroup undocking it first from the current container.

Declaration

cs-api-definition
public void DockWindowInPaneGroup(IToolWindow window, RadPaneGroup targetGroup, DockPosition position)

Parameters

window

IToolWindow

The window to be docked.

targetGroup

RadPaneGroup

The target PaneGroup to dock to.

position

DockPosition

The dock position to drag to.

DockWindowInRoot(ToolWindow, DockPosition)

Simulates user docking a tool window into the root of the docking panel.

Declaration

cs-api-definition
public void DockWindowInRoot(ToolWindow window, DockPosition position)

Parameters

window

ToolWindow

The window to be docked.

position

DockPosition

The docking position to drag to.

GroupHeaderClose(RadPaneGroup)

Simulates user clicking on the pane group close button. Recommended in case of update layout since an explicit Refresh() is needed.

Declaration

cs-api-definition
public void GroupHeaderClose(RadPaneGroup paneGroup)

Parameters

paneGroup

RadPaneGroup

The group header the close button belongs to.

GroupHeaderPin(RadPaneGroup)

Simulates user clicking on the group header pin button. Recommended in case of update layout since an explicit Refresh() is needed.

Declaration

cs-api-definition
public void GroupHeaderPin(RadPaneGroup paneGroup)

Parameters

paneGroup

RadPaneGroup

The group header the pin button belongs to.

TogglePin(AutoHideArea)

Simulates user clicking on the pin button of the given auto hide are to pin the pane.

Declaration

cs-api-definition
public void TogglePin(AutoHideArea hideArea)

Parameters

hideArea

AutoHideArea

The auto hide are control.

TogglePin(RadPaneGroup)

Simulates user clicking on the pin button of the given group pane to unpin the pane.

Declaration

cs-api-definition
public void TogglePin(RadPaneGroup paneGroup)

Parameters

paneGroup

RadPaneGroup

The pane group control.

UndockDocumentPane(FrameworkElement, DockingDragDirection)

Undock a pane from the document host split container group.

Declaration

cs-api-definition
public void UndockDocumentPane(FrameworkElement documentPane, DockingDragDirection direction)

Parameters

documentPane

FrameworkElement

The document pane to be undocked.

direction

DockingDragDirection

The direction to drag to.

UndockGroup(RadPaneGroup, DockingDragDirection)

Undock the group from the split container.

Declaration

cs-api-definition
public void UndockGroup(RadPaneGroup paneGroup, DockingDragDirection direction)

Parameters

paneGroup

RadPaneGroup

The pane group to be undocked.

direction

DockingDragDirection

The direction to drag to.

UndockPane(FrameworkElement, DockingDragDirection)

Undock the pane from the split container group.

Declaration

cs-api-definition
public void UndockPane(FrameworkElement pane, DockingDragDirection direction)

Parameters

pane

FrameworkElement

The pane control to be undocked.

direction

DockingDragDirection

The direction to drag to.

In this article
DefinitionConstructorsRadDocking()PropertiesBottomAutoHideCompassButtonsDocumentHostLeftAutoHideRightAutoHideSplitContainersToolWindowsTopAutoHideVisibleWindowsMethodsAssignReference(AutomationReference)AutoHidePaneHeaderPin(AutoHideArea)DockDocumentPaneInContainer(FrameworkElement, RadSplitContainer, DockPosition, DockingDragDirection)DockDocumentPaneInContainer(RadPane, RadSplitContainer, DockPosition)DockDocumentPaneInPaneGroup(FrameworkElement, RadPaneGroup, DockPosition, DockingDragDirection)DockDocumentPaneInPaneGroup(RadPane, RadPaneGroup, DockPosition)DockGroupInContainer(RadPaneGroup, RadSplitContainer, DockPosition)DockGroupInContainer(RadPaneGroup, RadSplitContainer, DockPosition, DockingDragDirection)DockGroupInPaneGroup(RadPaneGroup, RadPaneGroup, DockPosition)DockGroupInPaneGroup(RadPaneGroup, RadPaneGroup, DockPosition, DockingDragDirection)DockGroupInRoot(RadPaneGroup, DockPosition)DockPaneInContainer(FrameworkElement, RadSplitContainer, DockPosition, DockingDragDirection)DockPaneInContainer(RadPane, RadSplitContainer, DockPosition)DockPaneInRoot(RadPane, DockPosition)DockWindowInContainer(IToolWindow, RadSplitContainer, DockPosition)DockWindowInPaneGroup(IToolWindow, RadPaneGroup, DockPosition)DockWindowInRoot(ToolWindow, DockPosition)GroupHeaderClose(RadPaneGroup)GroupHeaderPin(RadPaneGroup)TogglePin(AutoHideArea)TogglePin(RadPaneGroup)UndockDocumentPane(FrameworkElement, DockingDragDirection)UndockGroup(RadPaneGroup, DockingDragDirection)UndockPane(FrameworkElement, DockingDragDirection)
Not finding the help you need?
Contact Support