Class RadDocking
Pane navigation control.
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Docking.dll
Syntax
[TelerikToolboxCategory("Containers")]
public class RadDocking : ItemsControl, IThemable, INotifyLayoutChange
Constructors
RadDocking()
Fields
ActivePaneChangedEvent
Identifies the ActivePaneChanged routed event.
Declaration
public static readonly RoutedEvent ActivePaneChangedEvent
Field Value
RoutedEvent
|
ActivePaneProperty
Identifies ActivePane dependency property.
Declaration
public static readonly DependencyProperty ActivePaneProperty
Field Value
System.Windows.DependencyProperty
|
AllowDragReorderProperty
Identifies the
Declaration
public static readonly DependencyProperty AllowDragReorderProperty
Field Value
System.Windows.DependencyProperty
|
CloseButtonPositionProperty
Identifies the
Declaration
public static readonly DependencyProperty CloseButtonPositionProperty
Field Value
System.Windows.DependencyProperty
|
CloseEvent
Identifies the Close routed event.
Declaration
public static readonly RoutedEvent CloseEvent
Field Value
RoutedEvent
|
CompassStyleProperty
Identifies the CompassStyle dependency property.
Declaration
public static readonly DependencyProperty CompassStyleProperty
Field Value
System.Windows.DependencyProperty
|
ConstraintAutoHideAreaProperty
Identifies the
Declaration
public static readonly DependencyProperty ConstraintAutoHideAreaProperty
Field Value
System.Windows.DependencyProperty
|
CurrentSaveLoadLayoutHelperProperty
Identifies the CurrentSaveLoadLayoutHelper dependency property.
Declaration
public static readonly DependencyProperty CurrentSaveLoadLayoutHelperProperty
Field Value
System.Windows.DependencyProperty
|
DockingPanesFactoryProperty
Identifies the DockingPanesFactory dependency property.
Declaration
public static readonly DependencyProperty DockingPanesFactoryProperty
Field Value
System.Windows.DependencyProperty
|
DockStateProperty
Identifies the DocumentsProperty dependency property.
Declaration
public static readonly DependencyProperty DockStateProperty
Field Value
System.Windows.DependencyProperty
|
DocumentHostProperty
Identifies the DocumentHost dependency property.
Declaration
public static readonly DependencyProperty DocumentHostProperty
Field Value
System.Windows.DependencyProperty
|
DragDropModeProperty
Identifies the
Declaration
public static readonly DependencyProperty DragDropModeProperty
Field Value
System.Windows.DependencyProperty
|
ExcludedFromLayoutSaveProperty
Identifies the ExcludedFromLayoutSave dependency property.
Declaration
public static readonly DependencyProperty ExcludedFromLayoutSaveProperty
Field Value
System.Windows.DependencyProperty
|
FloatingLocationProperty
Identifies the DocumentsProperty dependency property.
Declaration
public static readonly DependencyProperty FloatingLocationProperty
Field Value
System.Windows.DependencyProperty
|
FloatingSizeProperty
Identifies the FloatingSize dependency property.
Declaration
public static readonly DependencyProperty FloatingSizeProperty
Field Value
System.Windows.DependencyProperty
|
FloatingWindowStateProperty
Identifies the FloatingWindowState dependency property.
Declaration
public static readonly DependencyProperty FloatingWindowStateProperty
Field Value
System.Windows.DependencyProperty
|
FlyoutBehaviorProperty
Identifies the
Declaration
public static readonly DependencyProperty FlyoutBehaviorProperty
Field Value
System.Windows.DependencyProperty
|
FlyoutMinLengthProperty
Identifies the
Declaration
public static readonly DependencyProperty FlyoutMinLengthProperty
Field Value
System.Windows.DependencyProperty
|
GeneratedItemsFactoryProperty
Identifies the GeneratedItemsFactory dependency property.
Declaration
public static readonly DependencyProperty GeneratedItemsFactoryProperty
Field Value
System.Windows.DependencyProperty
|
HasDocumentHostProperty
Identifies the HasDocumentHost dependency property.
Declaration
public static readonly DependencyProperty HasDocumentHostProperty
Field Value
System.Windows.DependencyProperty
|
IsAutoGeneratedProperty
Identifies the
Declaration
public static readonly DependencyProperty IsAutoGeneratedProperty
Field Value
System.Windows.DependencyProperty
|
IsRestrictedProperty
Identifies the IsRestricted dependency property.
Declaration
public static readonly DependencyProperty IsRestrictedProperty
Field Value
System.Windows.DependencyProperty
|
IsRestrictedWhenMaximizedProperty
Identifies the
Declaration
public static readonly DependencyProperty IsRestrictedWhenMaximizedProperty
Field Value
System.Windows.DependencyProperty
|
PaneActivationModeProperty
Identifies the
Declaration
public static readonly DependencyProperty PaneActivationModeProperty
Field Value
System.Windows.DependencyProperty
|
PanesSourceProperty
Identifies the PanesSource dependency property.
Declaration
public static readonly DependencyProperty PanesSourceProperty
Field Value
System.Windows.DependencyProperty
|
PinEvent
Identifies the Pin routed event.
Declaration
public static readonly RoutedEvent PinEvent
Field Value
RoutedEvent
|
PreviewCloseEvent
Identifies the PreviewClose routed event.
Declaration
public static readonly RoutedEvent PreviewCloseEvent
Field Value
RoutedEvent
|
PreviewPinEvent
Identifies the PreviewPin routed event.
Declaration
public static readonly RoutedEvent PreviewPinEvent
Field Value
RoutedEvent
|
PreviewShowEvent
Identifies the PreviewShow routed event.
Declaration
public static readonly RoutedEvent PreviewShowEvent
Field Value
RoutedEvent
|
PreviewUnpinEvent
Identifies the PreviewUnpin routed event.
Declaration
public static readonly RoutedEvent PreviewUnpinEvent
Field Value
RoutedEvent
|
RestrictedAreaMarginProperty
Identifies the
Declaration
public static readonly DependencyProperty RestrictedAreaMarginProperty
Field Value
System.Windows.DependencyProperty
|
RetainPaneSizeModeProperty
Identifies the
Declaration
public static readonly DependencyProperty RetainPaneSizeModeProperty
Field Value
System.Windows.DependencyProperty
|
RootCompassStyleProperty
Identifies the RootCompassStyle dependency property.
Declaration
public static readonly DependencyProperty RootCompassStyleProperty
Field Value
System.Windows.DependencyProperty
|
SerializationTagProperty
Identifies the SerializationTag dependency property.
Declaration
public static readonly DependencyProperty SerializationTagProperty
Field Value
System.Windows.DependencyProperty
|
ShowEvent
Identifies the Show routed event.
Declaration
public static readonly RoutedEvent ShowEvent
Field Value
RoutedEvent
|
ShowResizePreviewProperty
Identifies ShowResizePreview dependency property.
Declaration
public static readonly DependencyProperty ShowResizePreviewProperty
Field Value
System.Windows.DependencyProperty
|
UnpinEvent
Identifies the Unpin routed event.
Declaration
public static readonly RoutedEvent UnpinEvent
Field Value
RoutedEvent
|
VisualCueStyleProperty
Identifies the VisualCueStyle dependency property.
Declaration
public static readonly DependencyProperty VisualCueStyleProperty
Field Value
System.Windows.DependencyProperty
|
Properties
ActivePane
Gets or sets the active pane.
Declaration
public RadPane ActivePane { get; set; }
Property Value
RadPane
|
AllowDragReorder
Gets or sets a value indicating whether reordering of RadPanes is allowed.
Declaration
public bool AllowDragReorder { get; set; }
Property Value
System.Boolean
|
AllowUnsafeMode
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
System.Boolean
|
CloseButtonPosition
Gets or sets the position of the CloseButton.
Declaration
public CloseButtonPosition CloseButtonPosition { get; set; }
Property Value
CloseButtonPosition
|
CompassStyle
Gets or sets the style for the Compass control.
Declaration
public Style CompassStyle { get; set; }
Property Value
System.Windows.Style
|
ConstraintAutoHideArea
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
System.Boolean
|
CurrentSaveLoadLayoutHelper
Gets or sets the current save load layout helper.
Declaration
public SaveLoadLayoutHelper CurrentSaveLoadLayoutHelper { get; set; }
Property Value
SaveLoadLayoutHelper
The current save load layout helper. |
DockingPanesFactory
Gets or sets the current factory for generating items in MVVM scenarios.
Declaration
public DockingPanesFactory DockingPanesFactory { get; set; }
Property Value
DockingPanesFactory
The current factory for generating items. |
DocumentHost
Gets the content of the document host.
Declaration
public object DocumentHost { get; set; }
Property Value
System.Object
The content of the document host. |
DragDropMode
Gets or sets the drag drop mode of the RadDocking control.
Declaration
public DockingDragDropMode DragDropMode { get; set; }
Property Value
DockingDragDropMode
|
FlyoutBehavior
Gets or sets the behavior of the flyout of the AutoHideArea.
Declaration
public IFlyoutBehavior FlyoutBehavior { get; set; }
Property Value
IFlyoutBehavior
|
Remarks
This property could be set to either one of the existing implementations of the IFlyoutBehavior interface (HoverFlyoutBehavior, ClickFlyoutBehavior) or to a custom implementation.
FlyoutMinLength
Gets or sets the minimum size of the flyout element of the auto-hide area.
Declaration
public double FlyoutMinLength { get; set; }
Property Value
System.Double
|
GeneratedItemsFactory
Gets or sets the current factory for generating items.
Declaration
public IGeneratedItemsFactory GeneratedItemsFactory { get; set; }
Property Value
IGeneratedItemsFactory
The current factory for generating items. |
HasDocumentHost
Gets or sets a value indicating whether the RadDocking control has DocumentHost area or not.
Declaration
public bool HasDocumentHost { get; set; }
Property Value
System.Boolean
|
IsLayoutChanging
Gets a value indicating whether this instance is layout changing.
Declaration
public bool IsLayoutChanging { get; }
Property Value
System.Boolean
|
Implements
IsLoaded
Indicates whether this control is present in the visual tree or not.
Declaration
protected bool IsLoaded { get; }
Property Value
System.Boolean
|
IsRestricted
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
System.Boolean
|
Remarks
Restricts the ToolWindows of the Docking control to its Restricted area and does not allow dragging out of it. The Restricted area is calculated using the RestrictedAreaMargin property and the application area (the Silverlight plugin area).
IsRestrictedWhenMaximized
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
System.Boolean
|
PaneActivationMode
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
ActivationMode
|
Panes
Gets the list of panes.
Declaration
public IEnumerable<RadPane> Panes { get; }
Property Value
System.Collections.Generic.IEnumerable<RadPane>
The panes. |
PanesSource
Gets or sets a collection used to generate the content of the RadDocking control.
Declaration
public IEnumerable PanesSource { get; set; }
Property Value
System.Collections.IEnumerable
The collection used to generate the content of the RadDocking control. |
RestrictedAreaMargin
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
System.Windows.Thickness
|
Remarks
The value of this property is used for calculating the Restricted area of the Docking used to restrict the ToolWindows of the Docking control when the IsRestricted property is set to true. The value of this property describes the margins of the Restricted area from the application area (the Silverlight plugin area or the containing window in OOB).
RetainPaneSizeMode
Gets or sets a value indicating whether the pane size should be retained.
Declaration
public RetainSizeMode RetainPaneSizeMode { get; set; }
Property Value
RetainSizeMode
|
RootCompassStyle
Gets or sets the style for the root Compass control.
Declaration
public Style RootCompassStyle { get; set; }
Property Value
System.Windows.Style
|
ShowResizePreview
Gets or sets a value indicating whether a preview visual is shown while resizing.
Declaration
public bool ShowResizePreview { get; set; }
Property Value
System.Boolean
|
SplitContainers
Gets the list of all split containers.
Declaration
public IEnumerable<RadSplitContainer> SplitContainers { get; }
Property Value
System.Collections.Generic.IEnumerable<RadSplitContainer>
The split containers in the docking. |
SplitItems
Gets the list of RadPaneGroup and RadSplitContainer objects.
Declaration
public IEnumerable<ISplitItem> SplitItems { get; }
Property Value
System.Collections.Generic.IEnumerable<ISplitItem>
The panes. |
VisualCueStyle
Gets or sets the style of the element that will be used as snapping visual cue.
Declaration
public Style VisualCueStyle { get; set; }
Property Value
System.Windows.Style
|
Methods
AttachDefaultSaveLoadLayoutHelper()
Attaches the default SaveLoadLayoutHelper.
Declaration
public void AttachDefaultSaveLoadLayoutHelper()
DetachCurrentSaveLoadLayoutHelper()
Detaches the current save load layout helper.
Declaration
public void DetachCurrentSaveLoadLayoutHelper()
GetDockState(DependencyObject)
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
System.Windows.DependencyObject
obj
|
Returns
DockState
|
GetExcludedFromLayoutSave(DependencyObject)
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
System.Windows.DependencyObject
obj
The object. |
Returns
System.Boolean
|
GetFloatingLocation(DependencyObject)
Gets the value of FloatingLocation attached property.
Declaration
public static Point GetFloatingLocation(DependencyObject obj)
Parameters
System.Windows.DependencyObject
obj
|
Returns
System.Windows.Point
|
GetFloatingSize(DependencyObject)
Gets the value of FloatingSize attached property.
Declaration
public static Size GetFloatingSize(DependencyObject obj)
Parameters
System.Windows.DependencyObject
obj
|
Returns
System.Windows.Size
|
GetFloatingWindowState(DependencyObject)
Gets the value of FloatingWindowState attached property.
Declaration
public static WindowState GetFloatingWindowState(DependencyObject obj)
Parameters
System.Windows.DependencyObject
obj
|
Returns
System.Windows.WindowState
|
GetIsAutoGenerated(DependencyObject)
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
System.Windows.DependencyObject
obj
The object. |
Returns
System.Boolean
|
GetRadPane(UIElement)
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
System.Windows.UIElement
element
The element to associate with a RadPane control. |
Returns
RadPane
The RadPane control, associated with the provided visual element. This method returns null if not able to find appropriate RadPane control. |
GetSerializationTag(DependencyObject)
Gets the serialization tag.
Declaration
public static string GetSerializationTag(DependencyObject obj)
Parameters
System.Windows.DependencyObject
obj
The object. |
Returns
System.String
|
LoadLayout(Stream)
Loads the layout.
Declaration
public void LoadLayout(Stream source)
Parameters
System.IO.Stream
source
The source. |
LoadLayout(Stream, Boolean)
Loads the layout.
Declaration
public void LoadLayout(Stream source, bool raiseEventsIfNoSerializationTag)
Parameters
System.IO.Stream
source
The source. |
System.Boolean
raiseEventsIfNoSerializationTag
If set to |
MeasureOverride(Size)
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
System.Windows.Size
availableSize
The available size that this object can give to child objects. Infinity can be specified as a value to indicate that the object will size to whatever content is available. |
Returns
System.Windows.Size
The size that this object determines it needs during layout, based on its calculations of child object allotted sizes. |
OnActivePaneChanged(ActivePangeChangedEventArgs)
Raises the ActivePaneChanged routed event. This method is called when the ActivePane property is changed.
Declaration
protected virtual void OnActivePaneChanged(ActivePangeChangedEventArgs e)
Parameters
ActivePangeChangedEventArgs
e
The ActivePangeChangedEventArgs instance containing the event data. |
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.
Declaration
public override void OnApplyTemplate()
Overrides
OnClose(StateChangeEventArgs)
Raises the Close event.
Declaration
protected virtual void OnClose(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
OnCreateAutomationPeer()
Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer
The type-specific System.Windows.Automation.Peers.AutomationPeer implementation. |
OnCustomElementLoading(LayoutSerializationCustomLoadingEventArgs)
Raises the CustomElementLoading event.
Declaration
protected virtual void OnCustomElementLoading(LayoutSerializationCustomLoadingEventArgs args)
Parameters
LayoutSerializationCustomLoadingEventArgs
args
The LayoutSerializationCustomLoadingEventArgs instance containing the event data. |
OnDockingElementDragged(Point, Object)
Called when a dock item is dragged.
Declaration
protected virtual void OnDockingElementDragged(Point globalPosition, object draggedElement)
Parameters
System.Windows.Point
globalPosition
The global position of the mouse. |
System.Object
draggedElement
The element that was dragged. |
OnDragContainer(RadSplitContainer, Point)
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
RadSplitContainer
container
The container, dragged by the user. |
System.Windows.Point
globalMousePosition
The global position of the mouse. |
OnDropContainer(RadSplitContainer, Point)
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
RadSplitContainer
container
The container, dragged by the user. |
System.Windows.Point
globalMousePosition
The global position of the mouse. |
Returns
System.Boolean
True if the drop was successful; otherwise - false. A drop is successful if the element is dropped over the compass. |
OnElementCleaned(LayoutSerializationEventArgs)
Raises the ElementCleaned event.
Declaration
protected virtual void OnElementCleaned(LayoutSerializationEventArgs args)
Parameters
LayoutSerializationEventArgs
args
The LayoutSerializationEventArgs instance containing the event data. |
OnElementCleaning(LayoutSerializationEventArgs)
Raises the ElementCleaning event.
Declaration
protected virtual void OnElementCleaning(LayoutSerializationEventArgs args)
Parameters
LayoutSerializationEventArgs
args
The LayoutSerializationEventArgs instance containing the event data. |
OnElementLayoutCleaning(LayoutSerializationCleaningEventArgs)
Raises the ElementLayoutCleaning event.
Declaration
protected virtual void OnElementLayoutCleaning(LayoutSerializationCleaningEventArgs args)
Parameters
LayoutSerializationCleaningEventArgs
args
The LayoutSerializationCleaningEventArgs instance containing the event data. |
OnElementLayoutSaving(LayoutSerializationSavingEventArgs)
Raises the ElementLayoutSaving event.
Declaration
protected virtual void OnElementLayoutSaving(LayoutSerializationSavingEventArgs args)
Parameters
LayoutSerializationSavingEventArgs
args
The LayoutSerializationSavingEventArgs instance containing the event data. |
OnElementLoaded(LayoutSerializationEventArgs)
Raises the ElementLoaded event.
Declaration
protected virtual void OnElementLoaded(LayoutSerializationEventArgs args)
Parameters
LayoutSerializationEventArgs
args
The LayoutSerializationEventArgs instance containing the event data. |
OnElementLoading(LayoutSerializationLoadingEventArgs)
Raises the ElementLoading event.
Declaration
protected virtual void OnElementLoading(LayoutSerializationLoadingEventArgs args)
Parameters
LayoutSerializationLoadingEventArgs
args
The LayoutSerializationEventArgs instance containing the event data. |
OnElementSaved(LayoutSerializationEventArgs)
Raises the ElementSaved event.
Declaration
protected virtual void OnElementSaved(LayoutSerializationEventArgs args)
Parameters
LayoutSerializationEventArgs
args
The LayoutSerializationEventArgs instance containing the event data. |
OnElementSaving(LayoutSerializationEventArgs)
Raises the ElementSaving event.
Declaration
protected virtual void OnElementSaving(LayoutSerializationEventArgs args)
Parameters
LayoutSerializationEventArgs
args
The LayoutSerializationEventArgs instance containing the event data. |
OnItemsChanged(NotifyCollectionChangedEventArgs)
Raises the ItemsChanged event.
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs
e
The System.Collections.Specialized.NotifyCollectionChangedEventArgs instance containing the event data. |
Overrides
OnLostFocus(RoutedEventArgs)
Called before the System.Windows.UIElement.LostFocus event occurs. Tries to close the AutoHideArea if possible.
Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs
e
The data for the event. |
Overrides
OnPaneGroupCreated(ElementCreatedEventArgs)
Raises the PaneGroupCreated event.
Declaration
protected virtual void OnPaneGroupCreated(ElementCreatedEventArgs args)
Parameters
ElementCreatedEventArgs
args
The ElementCreatedEventArgs instance containing the event data. |
OnPin(StateChangeEventArgs)
Raises the Pin event.
Declaration
protected virtual void OnPin(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
OnPreviewClose(StateChangeEventArgs)
Raises the PreviewClose event.
Declaration
protected virtual bool OnPreviewClose(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
Returns
System.Boolean
|
OnPreviewPin(StateChangeEventArgs)
Raises the PreviewPin event.
Declaration
protected virtual bool OnPreviewPin(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
Returns
System.Boolean
|
OnPreviewShow(StateChangeEventArgs)
Raises the PreviewShow event.
Declaration
protected virtual bool OnPreviewShow(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
Returns
System.Boolean
|
OnPreviewShowCompass(PreviewShowCompassEventArgs)
Raises the PreviewShowCompass event.
Declaration
protected virtual void OnPreviewShowCompass(PreviewShowCompassEventArgs args)
Parameters
PreviewShowCompassEventArgs
args
The PreviewShowCompassEventArgs instance containing the event data. |
OnPreviewUnpin(StateChangeEventArgs)
Raises the PreviewUnpin event.
Declaration
protected virtual bool OnPreviewUnpin(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
Returns
System.Boolean
|
OnShow(StateChangeEventArgs)
Raises the Show event.
Declaration
protected virtual void OnShow(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
OnSplitContainerCreated(ElementCreatedEventArgs)
Raises the SplitContainerCreated event.
Declaration
protected virtual void OnSplitContainerCreated(ElementCreatedEventArgs args)
Parameters
ElementCreatedEventArgs
args
The ElementCreatedEventArgs instance containing the event data. |
OnToolWindowCreated(ElementCreatedEventArgs)
Raises the ToolWindowCreated event.
Declaration
protected virtual void OnToolWindowCreated(ElementCreatedEventArgs args)
Parameters
ElementCreatedEventArgs
args
The ElementCreatedEventArgs instance containing the event data. |
OnUnpin(StateChangeEventArgs)
Raises the Pin event.
Declaration
protected virtual void OnUnpin(StateChangeEventArgs args)
Parameters
StateChangeEventArgs
args
The StateChangeEventArgs instance containing the event data. |
OpenInToolWindow(RadPane, Boolean)
Opens a ToolWindow for a RadPane and returns the window.
Declaration
protected virtual ToolWindow OpenInToolWindow(RadPane pane, bool openImmediately = true)
Parameters
RadPane
pane
The RadPane for which to open the window. |
System.Boolean
openImmediately
Indicates if the method will call the ShowWindow() method of the RadDocking. Default value is 'True'. |
Returns
ToolWindow
The newly opened window. |
OpenInToolWindow(RadPaneGroup, Boolean)
Opens a ToolWindow for a RadPaneGroup and returns the window.
Declaration
protected virtual ToolWindow OpenInToolWindow(RadPaneGroup radPaneGroup, bool openImmediately = true)
Parameters
RadPaneGroup
radPaneGroup
The RadPaneGroup for which to open the window. |
System.Boolean
openImmediately
Indicates if the method will call the ShowWindow() method of the RadDocking. Default value is 'True'. |
Returns
ToolWindow
The newly opened window. |
OpenInToolWindow(RadSplitContainer, Boolean)
Opens a ToolWindow for a RadSplitContainer and returns the window.
Declaration
protected virtual ToolWindow OpenInToolWindow(RadSplitContainer container, bool openImmediately = true)
Parameters
RadSplitContainer
container
The RadSplitContainer for which to open the window. |
System.Boolean
openImmediately
Indicates if the method will call the ShowWindow() method of the RadDocking. Default value is 'True'. |
Returns
ToolWindow
The newly opened window. |
ResetTheme()
Resets the theme.
Declaration
public void ResetTheme()
SaveLayout(Stream)
Saves the layout.
Declaration
public void SaveLayout(Stream destination)
Parameters
System.IO.Stream
destination
The destination. |
SaveLayout(Stream, Boolean)
Saves the layout.
Declaration
public void SaveLayout(Stream destination, bool raiseEventsIfNoSerializationTag)
Parameters
System.IO.Stream
destination
The destination. |
System.Boolean
raiseEventsIfNoSerializationTag
If set to |
SetDockState(DependencyObject, DockState)
Sets the value of DockState attached property.
Declaration
public static void SetDockState(DependencyObject obj, DockState value)
Parameters
System.Windows.DependencyObject
obj
|
DockState
value
|
SetExcludedFromLayoutSave(DependencyObject, Boolean)
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
System.Windows.DependencyObject
obj
The object. |
System.Boolean
value
The value. |
SetFloatingLocation(DependencyObject, Point)
Sets the value of FloatingLocation attached property.
Declaration
public static void SetFloatingLocation(DependencyObject obj, Point value)
Parameters
System.Windows.DependencyObject
obj
|
System.Windows.Point
value
|
SetFloatingSize(DependencyObject, Size)
Sets the value of FloatingSize attached property.
Declaration
public static void SetFloatingSize(DependencyObject obj, Size value)
Parameters
System.Windows.DependencyObject
obj
|
System.Windows.Size
value
|
SetFloatingWindowState(DependencyObject, WindowState)
Sets the value of FloatingWindowState attached property.
Declaration
public static void SetFloatingWindowState(DependencyObject obj, WindowState value)
Parameters
System.Windows.DependencyObject
obj
|
System.Windows.WindowState
value
|
SetIsAutoGenerated(DependencyObject, Boolean)
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
System.Windows.DependencyObject
obj
The object. |
System.Boolean
value
The value. |
SetSerializationTag(DependencyObject, String)
Sets the serialization tag.
Declaration
public static void SetSerializationTag(DependencyObject obj, string value)
Parameters
System.Windows.DependencyObject
obj
The object. |
System.String
value
The value. |
Events
ActivePaneChanged
Occurs when the active pane is changed.
Declaration
public event EventHandler<ActivePangeChangedEventArgs> ActivePaneChanged
Event Type
System.EventHandler<ActivePangeChangedEventArgs>
|
Close
Occurs when a pane or a group is closed.
Declaration
public event EventHandler<StateChangeEventArgs> Close
Event Type
System.EventHandler<StateChangeEventArgs>
|
CustomElementLoading
Occurs when an custom element starts loading.
Declaration
public event EventHandler<LayoutSerializationCustomLoadingEventArgs> CustomElementLoading
Event Type
System.EventHandler<LayoutSerializationCustomLoadingEventArgs>
|
ElementCleaned
Occurs when an element is cleaned up.
Declaration
public event EventHandler<LayoutSerializationEventArgs> ElementCleaned
Event Type
System.EventHandler<LayoutSerializationEventArgs>
|
ElementCleaning
Occurs when an element starts cleaning up.
Declaration
public event EventHandler<LayoutSerializationEventArgs> ElementCleaning
Event Type
System.EventHandler<LayoutSerializationEventArgs>
|
ElementLayoutCleaning
Occurs when an element starts cleaning up.
Declaration
public event EventHandler<LayoutSerializationCleaningEventArgs> ElementLayoutCleaning
Event Type
System.EventHandler<LayoutSerializationCleaningEventArgs>
|
ElementLayoutSaving
Occurs when an element starts saving.
Declaration
public event EventHandler<LayoutSerializationSavingEventArgs> ElementLayoutSaving
Event Type
System.EventHandler<LayoutSerializationSavingEventArgs>
|
ElementLoaded
Occurs when an element is loaded.
Declaration
public event EventHandler<LayoutSerializationEventArgs> ElementLoaded
Event Type
System.EventHandler<LayoutSerializationEventArgs>
|
ElementLoading
Occurs when an element starts loading.
Declaration
public event EventHandler<LayoutSerializationLoadingEventArgs> ElementLoading
Event Type
System.EventHandler<LayoutSerializationLoadingEventArgs>
|
ElementSaved
Occurs when an element is saved.
Declaration
public event EventHandler<LayoutSerializationEventArgs> ElementSaved
Event Type
System.EventHandler<LayoutSerializationEventArgs>
|
ElementSaving
Occurs when an element starts saving.
Declaration
public event EventHandler<LayoutSerializationEventArgs> ElementSaving
Event Type
System.EventHandler<LayoutSerializationEventArgs>
|
LayoutChangeEnded
Occurs when the layout change is ended.
Declaration
public event EventHandler LayoutChangeEnded
Event Type
System.EventHandler
|
Implements
LayoutChangeStarted
Occurs when the layout change is started.
Declaration
public event EventHandler LayoutChangeStarted
Event Type
System.EventHandler
|
Implements
PaneGroupCreated
Occurs when an RadPaneGroup instance is automatically created by the RadDocking control.
Declaration
public event EventHandler<ElementCreatedEventArgs> PaneGroupCreated
Event Type
System.EventHandler<ElementCreatedEventArgs>
|
PaneStateChange
Occurs when the state of a RadPane is changed.
Declaration
public event EventHandler<RadRoutedEventArgs> PaneStateChange
Event Type
System.EventHandler<RadRoutedEventArgs>
|
Pin
Occurs when a pane or a group is pined.
Declaration
public event EventHandler<StateChangeEventArgs> Pin
Event Type
System.EventHandler<StateChangeEventArgs>
|
PreviewClose
Occurs when a pane or a group is closed.
Declaration
public event EventHandler<StateChangeEventArgs> PreviewClose
Event Type
System.EventHandler<StateChangeEventArgs>
|
PreviewPin
Occurs when a pane or a group is pined.
Declaration
public event EventHandler<StateChangeEventArgs> PreviewPin
Event Type
System.EventHandler<StateChangeEventArgs>
|
PreviewShow
Occurs when a pane or a group is shown.
Declaration
public event EventHandler<StateChangeEventArgs> PreviewShow
Event Type
System.EventHandler<StateChangeEventArgs>
|
PreviewShowCompass
Occurs before the compass is shown.
Declaration
public event EventHandler<PreviewShowCompassEventArgs> PreviewShowCompass
Event Type
System.EventHandler<PreviewShowCompassEventArgs>
|
PreviewUnpin
Occurs when a pane or a group is unpinned.
Declaration
public event EventHandler<StateChangeEventArgs> PreviewUnpin
Event Type
System.EventHandler<StateChangeEventArgs>
|
Show
Occurs when a pane or a group is shown.
Declaration
public event EventHandler<StateChangeEventArgs> Show
Event Type
System.EventHandler<StateChangeEventArgs>
|
SplitContainerCreated
Occurs when an RadSplitContainer instance is automatically created by the RadDocking control.
Declaration
public event EventHandler<ElementCreatedEventArgs> SplitContainerCreated
Event Type
System.EventHandler<ElementCreatedEventArgs>
|
ToolWindowCreated
Occurs when an ToolWindow instance is automatically created by the RadDocking control.
Declaration
public event EventHandler<ElementCreatedEventArgs> ToolWindowCreated
Event Type
System.EventHandler<ElementCreatedEventArgs>
|
Unpin
Occurs when a pane or a group is unpinned.
Declaration
public event EventHandler<StateChangeEventArgs> Unpin
Event Type
System.EventHandler<StateChangeEventArgs>
|