Class

RadDocking

Initializes a new instance of the RadDocking class.

Declaration

public RadDocking()

Identifies the ActivePaneChanged routed event.

Declaration

public static readonly RoutedEvent ActivePaneChangedEvent

Field Value

Identifies ActivePane dependency property.

Declaration

public static readonly DependencyProperty ActivePaneProperty

Field Value

Identifies the AllowDragReorder Property.

Declaration

public static readonly DependencyProperty AllowDragReorderProperty

Field Value

Identifies the CanAutoHideAreaExceedScreen dependency property.

Declaration

public static readonly DependencyProperty CanAutoHideAreaExceedScreenProperty

Field Value

Identifies the CloseButtonPosition Property.

Declaration

public static readonly DependencyProperty CloseButtonPositionProperty

Field Value

Identifies the Close routed event.

Declaration

public static readonly RoutedEvent CloseEvent

Field Value

Identifies the CompassStyle dependency property.

Declaration

public static readonly DependencyProperty CompassStyleProperty

Field Value

Identifies the ConstraintAutoHideArea Property.

Declaration

public static readonly DependencyProperty ConstraintAutoHideAreaProperty

Field Value

Identifies the CurrentSaveLoadLayoutHelper dependency property.

Declaration

public static readonly DependencyProperty CurrentSaveLoadLayoutHelperProperty

Field Value

Identifies the DocumentsProperty dependency property.

Declaration

public static readonly DependencyProperty DockStateProperty

Field Value

Identifies the DockingPanesFactory dependency property.

Declaration

public static readonly DependencyProperty DockingPanesFactoryProperty

Field Value

Identifies the DocumentHost dependency property.

Declaration

public static readonly DependencyProperty DocumentHostProperty

Field Value

Identifies the DragDropMode Property.

Declaration

public static readonly DependencyProperty DragDropModeProperty

Field Value

Identifies the ExcludedFromLayoutSave dependency property.

Declaration

public static readonly DependencyProperty ExcludedFromLayoutSaveProperty

Field Value

Identifies the DocumentsProperty dependency property.

Declaration

public static readonly DependencyProperty FloatingLocationProperty

Field Value

Identifies the FloatingSize dependency property.

Declaration

public static readonly DependencyProperty FloatingSizeProperty

Field Value

Identifies the FloatingWindowState dependency property.

Declaration

public static readonly DependencyProperty FloatingWindowStateProperty

Field Value

Identifies the FlyoutBehavior Property.

Declaration

public static readonly DependencyProperty FlyoutBehaviorProperty

Field Value

Identifies the FlyoutMinSize Property.

Declaration

public static readonly DependencyProperty FlyoutMinLengthProperty

Field Value

Identifies the GeneratedItemsFactory dependency property.

Declaration

public static readonly DependencyProperty GeneratedItemsFactoryProperty

Field Value

Identifies the HasDocumentHost dependency property.

Declaration

public static readonly DependencyProperty HasDocumentHostProperty

Field Value

Identifies the IsAutoGenerated Property.

Declaration

public static readonly DependencyProperty IsAutoGeneratedProperty

Field Value

Identifies the IsRestricted dependency property.

Declaration

public static readonly DependencyProperty IsRestrictedProperty

Field Value

Identifies the IsRestrictedWhenMaximized Property.

Declaration

public static readonly DependencyProperty IsRestrictedWhenMaximizedProperty

Field Value

Identifies the Navigator dependency property.

Declaration

public static readonly DependencyProperty NavigatorProperty

Field Value

Identifies the PaneActivationMode Property.

Declaration

public static readonly DependencyProperty PaneActivationModeProperty

Field Value

Identifies the PanesSource dependency property.

Declaration

public static readonly DependencyProperty PanesSourceProperty

Field Value

Identifies the Pin routed event.

Declaration

public static readonly RoutedEvent PinEvent

Field Value

Identifies the PreviewClose routed event.

Declaration

public static readonly RoutedEvent PreviewCloseEvent

Field Value

Identifies the PreviewPin routed event.

Declaration

public static readonly RoutedEvent PreviewPinEvent

Field Value

Identifies the PreviewShow routed event.

Declaration

public static readonly RoutedEvent PreviewShowEvent

Field Value

Identifies the PreviewUnpin routed event.

Declaration

public static readonly RoutedEvent PreviewUnpinEvent

Field Value

Identifies the RestrictedAreaMargin Property.

Declaration

public static readonly DependencyProperty RestrictedAreaMarginProperty

Field Value

Identifies the RetainPaneSizeMode Property.

Declaration

public static readonly DependencyProperty RetainPaneSizeModeProperty

Field Value

Identifies the RootCompassStyle dependency property.

Declaration

public static readonly DependencyProperty RootCompassStyleProperty

Field Value

Identifies the SerializationTag dependency property.

Declaration

public static readonly DependencyProperty SerializationTagProperty

Field Value

Identifies the Show routed event.

Declaration

public static readonly RoutedEvent ShowEvent

Field Value

Identifies ShowResizePreview dependency property.

Declaration

public static readonly DependencyProperty ShowResizePreviewProperty

Field Value

Identifies the Unpin routed event.

Declaration

public static readonly RoutedEvent UnpinEvent

Field Value

Identifies the UseNativeInitialToolWindowDrag dependency property.

Declaration

public static readonly DependencyProperty UseNativeInitialToolWindowDragProperty

Field Value

Identifies the VisualCueStyle dependency property.

Declaration

public static readonly DependencyProperty VisualCueStyleProperty

Field Value

Gets or sets the active pane.

Declaration

public RadPane ActivePane { get; set; }

Property Value

Gets or sets a value indicating whether reordering of RadPanes is allowed.

Declaration

public bool AllowDragReorder { get; set; }

Property Value

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.

Declaration

public bool AllowUnsafeMode { get; set; }

Property Value

Gets or sets a value indicating whether the panes in the AutoHideArea could go outside of the screen. The default value is False - the unpinned panes respect the boundaries of the screen.

Declaration

public bool CanAutoHideAreaExceedScreen { get; set; }

Property Value

Gets or sets the position of the CloseButton.

Declaration

public CloseButtonPosition CloseButtonPosition { get; set; }

Property Value

Gets or sets the style for the Compass control.

Declaration

public Style CompassStyle { get; set; }

Property Value

Gets or sets a value indicating whether the RadDocking control should constraint its AutoHideArea to its size or not.

Declaration

public bool ConstraintAutoHideArea { get; set; }

Property Value

Gets or sets the current save load layout helper.

Declaration

public SaveLoadLayoutHelper CurrentSaveLoadLayoutHelper { get; set; }

Property Value

Gets or sets the current factory for generating items in MVVM scenarios.

Declaration

public DockingPanesFactory DockingPanesFactory { get; set; }

Property Value

Gets the content of the document host.

Declaration

public object DocumentHost { get; set; }

Property Value

Gets or sets the drag drop mode of the RadDocking control.

Declaration

public DockingDragDropMode DragDropMode { get; set; }

Property Value

Gets or sets the behavior of the flyout of the AutoHideArea.

Declaration

public IFlyoutBehavior FlyoutBehavior { get; set; }

Property Value

Remarks

Gets or sets the minimum size of the flyout element of the auto-hide area. The size determines the minimum width or height depending on the auto-hide area position - left/right or top/bottom.

Declaration

public double FlyoutMinLength { get; set; }

Property Value

Gets or sets the current factory for generating items.

Declaration

public IGeneratedItemsFactory GeneratedItemsFactory { get; set; }

Property Value

Gets or sets a value indicating whether the RadDocking control has DocumentHost area or not.

Declaration

public bool HasDocumentHost { get; set; }

Property Value

Gets a value indicating whether this instance is layout changing.

Declaration

public bool IsLayoutChanging { get; }

Property Value

Implements INotifyLayoutChange.IsLayoutChanging

Gets or sets a value indicating whether the ToolWindows of the Docking control are restricted to the Restricted area of the control.

Declaration

public bool IsRestricted { get; set; }

Property Value

Remarks

Gets or sets whether the ToolWindow will maximize to the full screen size or to the set restricted area margin.

Declaration

public bool IsRestrictedWhenMaximized { get; set; }

Property Value

Gets an enumerator for the logical child objects of the System.Windows.Controls.ItemsControl object.

Declaration

protected override IEnumerator LogicalChildren { get; }

Property Value

Gets or sets the PaneNavigator instance used in the docking control.

Declaration

public DockingNavigator Navigator { get; set; }

Property Value

Gets or sets a value indicating which pane should be activated when the active pane is closed.

Declaration

public ActivationMode PaneActivationMode { get; set; }

Property Value

Gets the list of panes.

Declaration

public IEnumerable<RadPane> Panes { get; }

Property Value

Gets or sets a collection used to generate the content of the RadDocking control.

Declaration

public IEnumerable PanesSource { get; set; }

Property Value

Gets or sets a value indicating the margin of the Restricted area from the application area when the IsRestricted property is set to true.

Declaration

public Thickness RestrictedAreaMargin { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether the pane size should be retained.

Declaration

public RetainSizeMode RetainPaneSizeMode { get; set; }

Property Value

Gets or sets the style for the root Compass control.

Declaration

public Style RootCompassStyle { get; set; }

Property Value

Gets or sets a value indicating whether a preview visual is shown while resizing.

Declaration

public bool ShowResizePreview { get; set; }

Property Value

Gets the list of all split containers.

Declaration

public IEnumerable<RadSplitContainer> SplitContainers { get; }

Property Value

Gets the list of RadPaneGroup and RadSplitContainer objects.

Declaration

public IEnumerable<ISplitItem> SplitItems { get; }

Property Value

Gets or sets a value indicating whether the native WPF Window drag should be used when undocking Pane or PaneGroup.

Declaration

public bool UseNativeInitialToolWindowDrag { get; set; }

Property Value

Gets or sets the style of the element that will be used as snapping visual cue.

Declaration

public Style VisualCueStyle { get; set; }

Property Value

Attaches the default SaveLoadLayoutHelper.

Declaration

public void AttachDefaultSaveLoadLayoutHelper()

Detaches the current save load layout helper.

Declaration

public void DetachCurrentSaveLoadLayoutHelper()

Gets the value of DockState attached property. By design this method should accepts objects of type RadSplitContainer

Declaration

public static DockState GetDockState(DependencyObject obj)

Parameters

Returns

Gets whether the element is excluded from the saving and loading logic of RadDocking's of layout.

Declaration

public static bool GetExcludedFromLayoutSave(DependencyObject obj)

Parameters

Returns

Gets the value of FloatingLocation attached property.

Declaration

public static Point GetFloatingLocation(DependencyObject obj)

Parameters

Returns

Gets the value of FloatingSize attached property.

Declaration

public static Size GetFloatingSize(DependencyObject obj)

Parameters

Returns

Gets the value of FloatingWindowState attached property.

Declaration

public static WindowState GetFloatingWindowState(DependencyObject obj)

Parameters

Returns

Gets whether the elements is auto-generated from the Docking control or is set by the user as one.

Declaration

public static bool GetIsAutoGenerated(DependencyObject obj)

Parameters

Returns

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.

Declaration

public static RadPane GetRadPane(UIElement element)

Parameters

Returns

Gets the serialization tag.

Declaration

public static string GetSerializationTag(DependencyObject obj)

Parameters

Returns

Loads the layout.

Declaration

public void LoadLayout(Stream source)

Parameters

Loads the layout.

Declaration

public void LoadLayout(Stream source, bool raiseEventsIfNoSerializationTag)

Parameters

Provides the behavior for the "measure" pass of Silverlight layout. Classes can override this method to define their own measure pass behavior.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Returns

Raises the routed event. This method is called when the ActivePane property is changed.

Declaration

protected virtual void OnActivePaneChanged(ActivePangeChangedEventArgs e)

Parameters

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .

Declaration

[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
public override void OnApplyTemplate()

Raises the event.

Declaration

protected virtual void OnClose(StateChangeEventArgs args)

Parameters

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Raises the event.

Declaration

protected virtual void OnCustomElementLoading(LayoutSerializationCustomLoadingEventArgs args)

Parameters

Called when a dock item is dragged.

Declaration

protected virtual void OnDockingElementDragged(Point globalPosition, object draggedElement)

Parameters

Call this method to notify the Docking control that a SplitContainer is being dragged by the user.

Declaration

protected void OnDragContainer(RadSplitContainer container, Point globalMousePosition)

Parameters

Call this method to notify the Docking control that a SplitContainer is being dropped by the user.

Declaration

protected bool OnDropContainer(RadSplitContainer container, Point globalMousePosition)

Parameters

Returns

Raises the event.

Declaration

protected virtual void OnElementCleaned(LayoutSerializationEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnElementLayoutCleaning(LayoutSerializationCleaningEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnElementLayoutSaving(LayoutSerializationSavingEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnElementLoaded(LayoutSerializationEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnElementLoading(LayoutSerializationLoadingEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnElementSaved(LayoutSerializationEventArgs args)

Parameters

Raises the event and sets from the active theme.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Raises the event.

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

Called before the event occurs.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

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.

Declaration

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnPaneGroupCreated(ElementCreatedEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnPin(StateChangeEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual bool OnPreviewClose(StateChangeEventArgs args)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewPin(StateChangeEventArgs args)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewShow(StateChangeEventArgs args)

Parameters

Returns

Raises the event.

Declaration

protected virtual void OnPreviewShowCompass(PreviewShowCompassEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual bool OnPreviewUnpin(StateChangeEventArgs args)

Parameters

Returns

Raises the event.

Declaration

protected virtual void OnShow(StateChangeEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnSplitContainerCreated(ElementCreatedEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnToolWindowCreated(ElementCreatedEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnUnpin(StateChangeEventArgs args)

Parameters

Opens a ToolWindow for a RadPane and returns the window.

Declaration

protected virtual ToolWindow OpenInToolWindow(RadPane pane, bool openImmediately = true)

Parameters

Returns

Opens a ToolWindow for a RadPaneGroup and returns the window.

Declaration

protected virtual ToolWindow OpenInToolWindow(RadPaneGroup radPaneGroup, bool openImmediately = true)

Parameters

Returns

Opens a ToolWindow for a RadSplitContainer and returns the window.

Declaration

protected virtual ToolWindow OpenInToolWindow(RadSplitContainer container, bool openImmediately = true)

Parameters

Returns

Resets the theme.

Declaration

public void ResetTheme()

Saves the layout.

Declaration

public void SaveLayout(Stream destination)

Parameters

Saves the layout.

Declaration

public void SaveLayout(Stream destination, bool raiseEventsIfNoSerializationTag)

Parameters

Sets the value of DockState attached property.

Declaration

public static void SetDockState(DependencyObject obj, DockState value)

Parameters

Sets whether the element is excluded from the saving and loading logic of RadDocking's of layout.

Declaration

public static void SetExcludedFromLayoutSave(DependencyObject obj, bool value)

Parameters

Sets the value of FloatingLocation attached property.

Declaration

public static void SetFloatingLocation(DependencyObject obj, Point value)

Parameters

Sets the value of FloatingSize attached property.

Declaration

public static void SetFloatingSize(DependencyObject obj, Size value)

Parameters

Sets the value of FloatingWindowState attached property.

Declaration

public static void SetFloatingWindowState(DependencyObject obj, WindowState value)

Parameters

Sets whether the element is auto-generated from the Docking control or is set by the user as one.

Declaration

public static void SetIsAutoGenerated(DependencyObject obj, bool value)

Parameters

Sets the serialization tag.

Declaration

public static void SetSerializationTag(DependencyObject obj, string value)

Parameters

Occurs when the active pane is changed.

Declaration

public event EventHandler<ActivePangeChangedEventArgs> ActivePaneChanged

Event Value

Occurs when a pane or a group is closed.

Declaration

public event EventHandler<StateChangeEventArgs> Close

Event Value

Occurs when an custom element starts loading.

Declaration

public event EventHandler<LayoutSerializationCustomLoadingEventArgs> CustomElementLoading

Event Value

Occurs when an element is cleaned up.

Declaration

public event EventHandler<LayoutSerializationEventArgs> ElementCleaned

Event Value

Occurs when an element starts cleaning up.

Declaration

public event EventHandler<LayoutSerializationCleaningEventArgs> ElementLayoutCleaning

Event Value

Occurs when an element starts saving.

Declaration

public event EventHandler<LayoutSerializationSavingEventArgs> ElementLayoutSaving

Event Value

Occurs when an element is loaded.

Declaration

public event EventHandler<LayoutSerializationEventArgs> ElementLoaded

Event Value

Occurs when an element starts loading.

Declaration

public event EventHandler<LayoutSerializationLoadingEventArgs> ElementLoading

Event Value

Occurs when an element is saved.

Declaration

public event EventHandler<LayoutSerializationEventArgs> ElementSaved

Event Value

Occurs when the layout change is ended.

Declaration

public event EventHandler LayoutChangeEnded

Event Value

Implements INotifyLayoutChange.LayoutChangeEnded

Occurs when the layout change is started.

Declaration

public event EventHandler LayoutChangeStarted

Event Value

Implements INotifyLayoutChange.LayoutChangeStarted

Occurs when an RadPaneGroup instance is automatically created by the RadDocking control.

Declaration

public event EventHandler<ElementCreatedEventArgs> PaneGroupCreated

Event Value

Occurs when the state of a RadPane is changed.

Declaration

public event EventHandler<RadRoutedEventArgs> PaneStateChange

Event Value

Occurs when a pane or a group is pined.

Declaration

public event EventHandler<StateChangeEventArgs> Pin

Event Value

Occurs when a pane or a group is closed.

Declaration

public event EventHandler<StateChangeEventArgs> PreviewClose

Event Value

Occurs when a pane or a group is pined.

Declaration

public event EventHandler<StateChangeEventArgs> PreviewPin

Event Value

Occurs when a pane or a group is shown.

Declaration

public event EventHandler<StateChangeEventArgs> PreviewShow

Event Value

Occurs before the compass is shown.

Declaration

public event EventHandler<PreviewShowCompassEventArgs> PreviewShowCompass

Event Value

Occurs when a pane or a group is unpinned.

Declaration

public event EventHandler<StateChangeEventArgs> PreviewUnpin

Event Value

Occurs when a pane or a group is shown.

Declaration

public event EventHandler<StateChangeEventArgs> Show

Event Value

Occurs when an RadSplitContainer instance is automatically created by the RadDocking control.

Declaration

public event EventHandler<ElementCreatedEventArgs> SplitContainerCreated

Event Value

Occurs when an ToolWindow instance is automatically created by the RadDocking control.

Declaration

public event EventHandler<ElementCreatedEventArgs> ToolWindowCreated

Event Value

Occurs when a pane or a group is unpinned.

Declaration

public event EventHandler<StateChangeEventArgs> Unpin

Event Value