Click or drag to resize
RadDocking Class
Pane navigation control.
Inheritance Hierarchy

Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Docking (in Telerik.Windows.Controls.Docking.dll) Version: 2017.3.913.40 (2017.3.913.40)
Syntax
public class RadDocking : ItemsControl, IThemable, 
	INotifyLayoutChange

The RadDocking type exposes the following members.

Constructors
  NameDescription
Public methodRadDocking
Initializes a new instance of the RadDocking class.
Top
Methods
  NameDescription
Public methodAttachDefaultSaveLoadLayoutHelper
Attaches the default SaveLoadLayoutHelper.
Public methodDetachCurrentSaveLoadLayoutHelper
Detaches the current save load layout helper.
Public methodStatic memberGetDockState
Gets the value of DockState attached property. By design this method should accepts objects of type RadSplitContainer
Public methodStatic memberGetExcludedFromLayoutSave
Gets whether the element is excluded from the saving and loading logic of RadDocking's of layout.
Public methodStatic memberGetFloatingLocation
Gets the value of FloatingLocation attached property.
Public methodStatic memberGetFloatingSize
Gets the value of FloatingSize attached property.
Public methodStatic memberGetFloatingWindowState
Gets the value of FloatingWindowState attached property.
Public methodStatic memberGetIsAutoGenerated
Gets whether the elements is auto-generated from the Docking control or is set by the user as one.
Public methodStatic memberGetRadPane
Finds RadPane by visual element using the position of the element in the visual tree. This method implements internal logic of the RadDocking control that is able to associate a RadPane control to a visual element.
Public methodStatic memberGetSerializationTag
Gets the serialization tag.
Public methodLoadLayout(Stream)
Loads the layout.
Public methodLoadLayout(Stream, Boolean)
Loads the layout.
Protected methodMeasureOverride
Provides the behavior for the "measure" pass of Silverlight layout. Classes can override this method to define their own measure pass behavior.
(Overrides ControlMeasureOverride(Size).)
Protected methodOnActivePaneChanged
Raises the [E:ActivePaneChanged] routed event. This method is called when the ActivePane property is changed.
Public methodOnApplyTemplate
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate.
(Overrides FrameworkElementOnApplyTemplate.)
Protected methodOnClose
Raises the [E:Close] event.
Protected methodOnCreateAutomationPeer
Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
(Overrides UIElementOnCreateAutomationPeer.)
Protected methodOnCustomElementLoading
Raises the [E:CustomElementLoading] event.
Protected methodOnDockingElementDragged
Called when a dock item is dragged.
Protected methodOnDragContainer
Call this method to notify the Docking control that a SplitContainer is being dragged by the user.
Protected methodOnDropContainer
Call this method to notify the Docking control that a SplitContainer is being dropped by the user.
Protected methodOnElementCleaned
Raises the [E:ElementCleaned] event.
Protected methodOnElementCleaning
Raises the [E:ElementCleaning] event.
Protected methodOnElementLayoutCleaning
Raises the [E:ElementLayoutCleaning] event.
Protected methodOnElementLayoutSaving
Raises the [E:ElementLayoutSaving] event.
Protected methodOnElementLoaded
Raises the [E:ElementLoaded] event.
Protected methodOnElementLoading
Raises the [E:ElementLoading] event.
Protected methodOnElementSaved
Raises the [E:ElementSaved] event.
Protected methodOnElementSaving
Raises the [E:ElementSaving] event.
Protected methodOnInitialized
Raises the Initialized event and sets DefaultStyleKey from the active theme.
(Overrides FrameworkElementOnInitialized(EventArgs).)
Protected methodOnItemsChanged
Raises the [E:ItemsChanged] event.
(Overrides ItemsControlOnItemsChanged(NotifyCollectionChangedEventArgs).)
Protected methodOnLostKeyboardFocus
Invoked when an unhandled System.Windows.Input.Keyboard.LostKeyboardFocus attached event reaches an element in its route that is derived from this class. Tries to close the AutoHideArea if possible.
(Overrides UIElementOnLostKeyboardFocus(KeyboardFocusChangedEventArgs).)
Protected methodOnPaneGroupCreated
Raises the [E:PaneGroupCreated] event.
Protected methodOnPin
Raises the [E:Pin] event.
Protected methodOnPreviewClose
Raises the [E:PreviewClose] event.
Protected methodOnPreviewPin
Raises the [E:PreviewPin] event.
Protected methodOnPreviewShow
Raises the [E:PreviewShow] event.
Protected methodOnPreviewShowCompass
Raises the [E:PreviewShowCompass] event.
Protected methodOnPreviewUnpin
Raises the [E:PreviewUnpin] event.
Protected methodOnShow
Raises the [E:Show] event.
Protected methodOnSplitContainerCreated
Raises the [E:SplitContainerCreated] event.
Protected methodOnToolWindowCreated
Raises the [E:ToolWindowCreated] event.
Protected methodOnUnpin
Raises the [E:Pin] event.
Protected methodOpenInToolWindow(RadPane, Boolean)
Opens a ToolWindow for a RadPane and returns the window.
Protected methodOpenInToolWindow(RadPaneGroup, Boolean)
Opens a ToolWindow for a RadPaneGroup and returns the window.
Protected methodOpenInToolWindow(RadSplitContainer, Boolean)
Opens a ToolWindow for a RadSplitContainer and returns the window.
Public methodResetTheme
Resets the theme.
Public methodSaveLayout(Stream)
Saves the layout.
Public methodSaveLayout(Stream, Boolean)
Saves the layout.
Public methodStatic memberSetDockState
Sets the value of DockState attached property.
Public methodStatic memberSetExcludedFromLayoutSave
Sets whether the element is excluded from the saving and loading logic of RadDocking's of layout.
Public methodStatic memberSetFloatingLocation
Sets the value of FloatingLocation attached property.
Public methodStatic memberSetFloatingSize
Sets the value of FloatingSize attached property.
Public methodStatic memberSetFloatingWindowState
Sets the value of FloatingWindowState attached property.
Public methodStatic memberSetIsAutoGenerated
Sets whether the element is auto-generated from the Docking control or is set by the user as one.
Public methodStatic memberSetSerializationTag
Sets the serialization tag.
Top
Extension Methods
  NameDescription
Public Extension MethodChildrenOfTypeT
Gets all child elements recursively from the visual tree by given type.
(Defined by ChildrenOfTypeExtensions.)
Public Extension MethodClearIfNoBindingAndSet
Clears if set.
(Defined by CommonExtensions.)
Public Extension MethodClearIfSet
Clears the property if a value has been set.
(Defined by CommonExtensions.)
Public Extension MethodDeserializePrimitives
Deserializes some primitive properties of a control.
(Defined by SerializationExtensions.)
Public Extension MethodEnableLayoutRounding (Defined by LayoutRoundingHelperExtensions.)
Public Extension MethodFindChildByTypeT
Finds child element of the specified type. Uses breadth-first search.
(Defined by ChildrenOfTypeExtensions.)
Public Extension MethodGetAssociatedInlineUIContainer (Defined by ExtensionMethods.)
Public Extension MethodGetAssociatedLayoutBox (Defined by ExtensionMethods.)
Public Extension MethodGetBaseControlItemStatus
Gets a string that communicates the visual status of a Control.
(Defined by AutomationExtensions.)
Public Extension MethodGetBoundsRelativeTo
Gets the bounds relative to the current framework element.
(Defined by ExtensionMethods.)
Public Extension MethodGetGlobalMousePosition
(Defined by WindowHost.)
Public Extension MethodGetParents
Enumerates through element's parents in the visual tree.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodGetVisualParentT
Searches up in the visual tree for parent element of the specified type.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodIsAncestorOf(DependencyObject)Overloaded.
Determines whether the element is ancestor of the current UI element.
(Defined by ExtensionMethods.)
Public Extension MethodIsAncestorOf(DependencyObject)Overloaded.
Determines whether the element is an ancestor of the descendant.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodIsKeyboardFocusWithin
Determines whether keyboard focus is within the current UI element.
(Defined by KeyboardHelper.)
Public Extension MethodIsLocalValueSet(DependencyProperty)Overloaded.
Determines whether the specified dependency property local value is set.
(Defined by DependencyObjectExtensions.)
Public Extension MethodIsLocalValueSet(DependencyProperty)Overloaded.
Determines whether the specified dependency property local value is set.
(Defined by CommonExtensions.)
Public Extension MethodParentOfTypeT
Gets the parent element from the visual tree by given type.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodSerializePrimitives
Serializes some primitive properties of a control.
(Defined by SerializationExtensions.)
Public Extension MethodSetAssociatedLayoutBox (Defined by ExtensionMethods.)
Public Extension MethodSetIfDifferent
Sets the value of the dependencyProperty property if it's hasn't that value currently.
(Defined by CommonExtensions.)
Public Extension MethodSetLayout
Sets the location in the element in Canvas.
(Defined by CommonExtensions.)
Public Extension MethodSetLocation(Point)Overloaded.
Sets the location in the element in Canvas.
(Defined by CommonExtensions.)
Public Extension MethodSetLocation(Double, Double)Overloaded.
Sets the location in the element in Canvas.
(Defined by CommonExtensions.)
Public Extension MethodSlideInOverloaded.
Slides the given element into view. This is an extension method.
(Defined by CalendarAnimation.)
Public Extension MethodSlideIn(TimeSpan)Overloaded.
Slides the given element into view. This is an extension method.
(Defined by CalendarAnimation.)
Public Extension MethodSlideOutOverloaded.
Slides the given element out of view. This is an extension method.
(Defined by CalendarAnimation.)
Public Extension MethodSlideOut(TimeSpan)Overloaded.
Slides the given element out of view. This is an extension method.
(Defined by CalendarAnimation.)
Public Extension MethodTranslate(NullableDouble, NullableDouble, NullableDouble, NullableDouble, TimeSpan)Overloaded.
Translates the target element as requested by the parameters.
(Defined by CalendarAnimation.)
Public Extension MethodTranslate(NullableDouble, NullableDouble, NullableDouble, NullableDouble, TimeSpan, Action)Overloaded.
Translates the target element as requested by the parameters and executes the action request.
(Defined by CalendarAnimation.)
Top
Fields
  NameDescription
Public fieldStatic memberActivePaneChangedEvent
Identifies the ActivePaneChanged routed event.
Public fieldStatic memberActivePaneProperty
Identifies ActivePane dependency property.
Public fieldStatic memberAllowDragReorderProperty
Identifies the AllowDragReorder Property.
Public fieldStatic memberCloseButtonPositionProperty
Identifies the CloseButtonPosition Property.
Public fieldStatic memberCloseEvent
Identifies the Close routed event.
Public fieldStatic memberCompassStyleProperty
Identifies the CompassStyle dependency property.
Public fieldStatic memberConstraintAutoHideAreaProperty
Identifies the ConstraintAutoHideArea Property.
Public fieldStatic memberCurrentSaveLoadLayoutHelperProperty
Identifies the CurrentSaveLoadLayoutHelper dependency property.
Public fieldStatic memberDockingPanesFactoryProperty
Identifies the DockingPanesFactory dependency property.
Public fieldStatic memberDockStateProperty
Identifies the DocumentsProperty dependency property.
Public fieldStatic memberDocumentHostProperty
Identifies the DocumentHost dependency property.
Public fieldStatic memberDragDropModeProperty
Identifies the DragDropMode Property.
Public fieldStatic memberExcludedFromLayoutSaveProperty
Identifies the ExcludedFromLayoutSave dependency property.
Public fieldStatic memberFloatingLocationProperty
Identifies the DocumentsProperty dependency property.
Public fieldStatic memberFloatingSizeProperty
Identifies the FloatingSize dependency property.
Public fieldStatic memberFloatingWindowStateProperty
Identifies the FloatingWindowState dependency property.
Public fieldStatic memberFlyoutBehaviorProperty
Identifies the FlyoutBehavior Property.
Public fieldStatic memberGeneratedItemsFactoryProperty
Identifies the GeneratedItemsFactory dependency property.
Public fieldStatic memberHasDocumentHostProperty
Identifies the HasDocumentHost dependency property.
Public fieldStatic memberIsAutoGeneratedProperty
Identifies the IsAutoGenerated Property.
Public fieldStatic memberIsRestrictedProperty
Identifies the IsRestricted dependency property.
Public fieldStatic memberIsRestrictedWhenMaximizedProperty
Identifies the IsRestrictedWhenMaximized Property.
Public fieldStatic memberPaneActivationModeProperty
Identifies the PaneActivationMode Property.
Public fieldStatic memberPanesSourceProperty
Identifies the PanesSource dependency property.
Public fieldStatic memberPinEvent
Identifies the Pin routed event.
Public fieldStatic memberPreviewCloseEvent
Identifies the PreviewClose routed event.
Public fieldStatic memberPreviewPinEvent
Identifies the PreviewPin routed event.
Public fieldStatic memberPreviewShowEvent
Identifies the PreviewShow routed event.
Public fieldStatic memberPreviewUnpinEvent
Identifies the PreviewUnpin routed event.
Public fieldStatic memberRestrictedAreaMarginProperty
Identifies the RestrictedAreaMargin Property.
Public fieldStatic memberRetainPaneSizeModeProperty
Identifies the RetainPaneSizeMode Property.
Public fieldStatic memberRootCompassStyleProperty
Identifies the RootCompassStyle dependency property.
Public fieldStatic memberSerializationTagProperty
Identifies the SerializationTag dependency property.
Public fieldStatic memberShowEvent
Identifies the Show routed event.
Public fieldStatic memberShowResizePreviewProperty
Identifies ShowResizePreview dependency property.
Public fieldStatic memberUnpinEvent
Identifies the Unpin routed event.
Public fieldStatic memberVisualCueStyleProperty
Identifies the VisualCueStyle dependency property.
Top
Properties
  NameDescription
Public propertyActivePane
Gets a value indicating whether this pane is active.
Public propertyAllowDragReorder
Gets or sets a value indicating whether reordering of RadPanes is allowed.
Public propertyAllowUnsafeMode
Gets or sets whether unsafe mode is allowed. Don't set this property to true if you are not sure you need to do this.
Public propertyCloseButtonPosition
Gets or sets the position of the CloseButton.
Public propertyCompassStyle
Gets or sets the style for the Compass control.
Public propertyConstraintAutoHideArea
Gets or sets a value indicating whether the RadDocking control should constraint its AutoHideArea to its size or not.
Public propertyCurrentSaveLoadLayoutHelper
Gets or sets the current save load layout helper.
Public propertyDockingPanesFactory
Gets or sets the current factory for generating items in MVVM scenarios.
Public propertyDocumentHost
Gets the content of the document host.
Public propertyDragDropMode
Gets or sets the drag drop mode of the RadDocking control.
Public propertyFlyoutBehavior
Gets or sets the behavior of the flyout of the AutoHideArea.
Public propertyGeneratedItemsFactory
Gets or sets the current factory for generating items.
Public propertyHasDocumentHost
Gets or sets a value indicating whether the RadDocking control has DocumentHost area or not.
Public propertyIsLayoutChanging
Gets a value indicating whether this instance is layout changing.
Public propertyIsRestricted
Gets or sets a value indicating whether the ToolWindows of the Docking control are restricted to the Restricted area of the control.
Public propertyIsRestrictedWhenMaximized
Gets or sets whether the ToolWindow will maximize to the full screen size or to the set restricted area margin.
Protected propertyLogicalChildren
Gets an enumerator for the logical child objects of the System.Windows.Controls.ItemsControl object.
(Overrides ItemsControlLogicalChildren.)
Public propertyPaneActivationMode
Gets or sets a value indicating which pane should be activated when the active pane is closed.
Public propertyPanes
Gets the list of panes.
Public propertyPanesSource
Gets or sets a collection used to generate the content of the RadDocking control.
Public propertyRestrictedAreaMargin
Gets or sets a value indicating the margin of the Restricted area from the application area when the IsRestricted property is set to true.
Public propertyRetainPaneSizeMode
Gets or sets a value indicating whether the pane size should be retained.
Public propertyRootCompassStyle
Gets or sets the style for the root Compass control.
Public propertyShowResizePreview
Gets or sets a value indicating whether a preview visual is shown while resizing.
Public propertySplitContainers
Gets the list of all split containers.
Public propertySplitItems
Gets the list of RadPaneGroup and RadSplitContainer objects.
Public propertyVisualCueStyle
Gets or sets the style of the element that will be used as snapping visual cue.
Top
Attached Properties
  NameDescription
Public attached propertyDockState
Identifies the DocumentsProperty dependency property.
Public attached propertyExcludedFromLayoutSave
Identifies the ExcludedFromLayoutSave dependency property.
Public attached propertyFloatingLocation
Identifies the DocumentsProperty dependency property.
Public attached propertyFloatingSize
Identifies the FloatingSize dependency property.
Public attached propertyFloatingWindowState
Identifies the FloatingWindowState dependency property.
Public attached propertyIsAutoGenerated
Identifies the IsAutoGenerated Property.
Public attached propertySerializationTag
Identifies the SerializationTag dependency property.
Top
Events
  NameDescription
Public eventActivePaneChanged
Occurs when the active pane is changed.
Public eventClose
Occurs when a pane or a group is closed.
Public eventCustomElementLoading
Occurs when an custom element starts loading.
Public eventElementCleaned
Occurs when an element is cleaned up.
Public eventElementCleaning Obsolete.
Occurs when an element starts cleaning up.
Public eventElementLayoutCleaning
Occurs when an element starts cleaning up.
Public eventElementLayoutSaving
Occurs when an element starts saving.
Public eventElementLoaded
Occurs when an element is loaded.
Public eventElementLoading
Occurs when an element starts loading.
Public eventElementSaved
Occurs when an element is saved.
Public eventElementSaving Obsolete.
Occurs when an element starts saving.
Public eventLayoutChangeEnded
Occurs when the layout change is ended.
Public eventLayoutChangeStarted
Occurs when the layout change is started.
Public eventPaneGroupCreated
Occurs when an RadPaneGroup instance is automatically created by the RadDocking control.
Public eventPaneStateChange
Occurs when the state of a RadPane is changed.
Public eventPin
Occurs when a pane or a group is pined.
Public eventPreviewClose
Occurs when a pane or a group is closed.
Public eventPreviewPin
Occurs when a pane or a group is pined.
Public eventPreviewShow
Occurs when a pane or a group is shown.
Public eventPreviewShowCompass
Occurs before the compass is shown.
Public eventPreviewUnpin
Occurs when a pane or a group is unpinned.
Public eventShow
Occurs when a pane or a group is shown.
Public eventSplitContainerCreated
Occurs when an RadSplitContainer instance is automatically created by the RadDocking control.
Public eventToolWindowCreated
Occurs when an ToolWindow instance is automatically created by the RadDocking control.
Public eventUnpin
Occurs when a pane or a group is unpinned.
Top
See Also