Click or drag to resize
RadDock Class
Represents the major control in the Telerik.WinForms.UI.Docking assembly. Root component for the entire docking framework. Provides highly extensible and completely transparent transaction-based API for managing a set of tool and document windows registered within the docking framework. Mimics the user experience found in Microsoft Visual Studio - dockable panes, tabbed documents, document navigation plus much more.
Examples
A typical scenario of utilizing a docking framework is as follows: Create a new RadDock instance.Create the desired ToolWindow and/or DocumentWindow instances.Register the newly created dock windows with the RadDock using the DockWindow or the AddDocument methods respectively.Add the new RadDock instance to a Form.Display the Form.
Remarks
Although a rare scenario, sometimes the need of nested RadDock instances may emerge. This is fully supported by the RadDock component and unlimited levels of nesting are allowed.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          Telerik.WinControlsRadControl
            Telerik.WinControls.UISplitPanel
              Telerik.WinControls.UIRadSplitContainer
                Telerik.WinControls.UI.DockingRadDock

Namespace: Telerik.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock (in Telerik.WinControls.RadDock.dll) Version: 2018.3.911.40 (2018.3.911.40)
Syntax
[TelerikToolboxCategoryAttribute("Containers")]
public class RadDock : RadSplitContainer, ILoadObsoleteDockingManagerXml, 
	IMessageListener

The RadDock type exposes the following members.

Constructors
  NameDescription
Public methodRadDock
Initializes a new RadDock instance.
Top
Properties
  NameDescription
Public propertyAccessibilityRequested
Gets or sets a value indicating whether the CodedUI Tests functionality is requested from external program such a Narrator.
(Inherited from RadControl.)
Public propertyActiveFloatingWindows
Public propertyActiveWindow
Gets or sets the DockWindow instance, which is currently active (meaning it contains the Keyboard focus).
Public propertyAllowDrop
(Overrides ControlAllowDrop.)
Public propertyAllowShowFocusCues
Indicates focus cues display, when available, based on the corresponding control type and the current UI state.
(Inherited from RadControl.)
Public propertyAnalyticsName
Gets or sets the Analytics Name associated with this control. By default the Control Name property is logged. If you want to customize the information which will be logged for this control set this property to a preferred value.
(Inherited from RadControl.)
Public propertyAutoDetectMdiChildren
Gets or sets a value indicating whether [auto detect MDI child].
Public propertyAutoHideAnimation
Determines what animation will be used when displaying/hiding auto-hidden windows.
Public propertyAutoHideAnimationDuration
Gets or sets the duration of the auto hide window animation. The default value is 200 milliseconds.
Public propertyAutoHidePopup
Public propertyAutoScroll
(Overrides ScrollableControlAutoScroll.)
Public propertyAutoScrollMargin
Public propertyAutoScrollMinSize
Public propertyAutoSize
Gets or sets whether the edit control is auto-sized
(Overrides RadSplitContainerAutoSize.)
Public propertyBackColor
RadDock consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.
(Overrides RadControlBackColor.)
Public propertyBehavior
Gets the input behavior for the control.
(Inherited from RadControl.)
Public propertyBorderStyle (Inherited from SplitPanel.)
Public propertyCausesValidation
Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
(Inherited from RadControl.)
Public propertyCollapsed
Public propertyCommandBindings (Inherited from SplitPanel.)
Public propertyCommandManager
Gets the CommandManager registered with this RadDock instance.
Public propertyContentRectangle
Overrides the content rectangle to add any visible auto-hide tabstrips to the calculations.
(Overrides RadSplitContainerContentRectangle.)
Protected propertyCreateParams (Inherited from SplitPanel.)
Protected propertyDefaultMargin (Inherited from SplitPanel.)
Protected propertyDefaultSize (Inherited from SplitPanel.)
Public propertyDockingGuidesTemplate
Gets or sets the template, which defines the appearance of the guides displayed upon drag-and-drop operation.
Public propertyDockWindows
Gets a collection with all the currently attached DockWindow instances.
Public propertyDocumentManager
Gets the DocumentManager instance that manages all the DockWindow instances which are parented MainDocumentContainer. For a Document is considered either a DocumentWindow instance or a ToolWindow, which current DockState is TabbedDocument.
Public propertyDocumentTabsAlignment
Gets or sets the alignment of the TabStripElement in all DocumentTabStrip instances.
Public propertyDocumentTabsTextOrientation
Gets or sets the text orientation of the TabStripElement in all ToolTabStrip instances.
Public propertyDocumentTabsVisible
Determines whether the TabStripElement in DocumentTabStrip instances is visible.
Public propertyDragDropAllowedDockStates
Gets or sets the allowed dock states for a committing drag-and-drop operation.
Public propertyDragDropMode
Gets or sets the mode used by the DragDropService when a drag-and-drop request is made.
Public propertyElementTree (Inherited from SplitPanel.)
Public propertyEnableAnalytics
Gets or sets a value indicating whether the Analytics functionality is enabled or disabled for this control.
(Inherited from RadControl.)
Public propertyEnableCodedUITests
Gets or sets a value indicating whether the CodedUI Tests functionality is enabled.
(Inherited from RadControl.)
Public propertyEnableCollapsing
Determines whether the panels can be collapsed when clicking twice on splitter or click once on navigation button.
(Inherited from RadSplitContainer.)
Public propertyEnabled
Public propertyEnableFloatingWindowSnapping
Determines whether all floating windows' will snap to their edges.
Public propertyEnableFloatingWindowTheming
Determines whether all floating windows' frames within the framework will be themed using Telerik's TPF or will be let with their system appearance.
Public propertyEnableGestures
Gets or sets a value indicating whether the Gestures functionality is enabled.
(Inherited from RadControl.)
Public propertyEnableImmediateResize
Gets a value indicating whether the bounds of the split panels should be updated immediately on drag.
(Inherited from RadSplitContainer.)
Public propertyEnableKeyMap
Gets or sets whether Key Map (Office 2007 like accelerator keys map) is used for this speciffic control. Currently this option is implemented for the RadRibbonBar control only.
(Inherited from SplitPanel.)
Public propertyEnableRadAccessibilityObjects
Gets or sets a value indicating whether the RadControls Accessible custom object is enabled.
(Inherited from RadControl.)
Public propertyEnableTheming
Gets or sets value indicating whether the control is styled through theme
(Inherited from RadControl.)
Public propertyFloatingWindows
Gets a list of the floating windows. Can contain duplicates, empty or hidden toolwindows which are used internally as re-dock targets.
Public propertyFocusable (Inherited from RadControl.)
Public propertyFocusedElement (Inherited from RadControl.)
Public propertyFont
Gets or sets the Font of the control. This is actually the Font property of the root element.
(Inherited from RadControl.)
Public propertyForeColor
RadDock consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.
(Overrides RadSplitContainerForeColor.)
Public propertyGuidToNameMappings
Public propertyHasNonCollapsedChild (Inherited from RadSplitContainer.)
Public propertyHasVisibleSplitPanels (Inherited from RadSplitContainer.)
Public propertyImageList (Inherited from SplitPanel.)
Public propertyImageScalingSize (Inherited from SplitPanel.)
Public propertyIsCleanUpTarget
Determines whether the container is a target of automatic defragment operation. This property is internally used by the framework and is not intended to be directly used in code.
(Inherited from RadSplitContainer.)
Public propertyIsDesignMode (Inherited from SplitPanel.)
Public propertyIsDisplayed
Determines whether the control is currently displayed on the screen.
(Inherited from RadControl.)
Public propertyIsDragging
Determines whether the DragDropService is currently working (a drag-and-drop operation is running).
Public propertyIsInitializing (Inherited from RadControl.)
Public propertyIsInTransactionBlock
Determines whether the RadDock is currently in a transaction (internal operation).
Public propertyIsLoaded
Determines whether the control is properly loaded.
(Inherited from RadControl.)
Public propertyItem
Gets DockWindow instance with the corresponding Name.
Public propertyLayoutManager (Inherited from RadControl.)
Public propertyLayoutStrategy
Gets or sets the layout strategy that arranges all the visible SplitPanel children.
(Inherited from RadSplitContainer.)
Public propertyLayoutStrategyType
Gets or sets the Type to be used when a new RadSplitContainer instance is internally created and a layout strategy is initialized for it. Allows plugging of completely custom layout behavior.
Public propertyMainDocumentContainer
Gets or sets the document container for this RadDock instance. This property is used primarily for serialization purposes and is not intended to be used directly by code.
Public propertyMainDocumentContainerVisible
Determines whether the main document container is visible.
Public propertyMaximumSize (Inherited from SplitPanel.)
Public propertyMdiChildren
Gets an array with all the standard Forms added as TabbedDocument to this RadDock instance.
Public propertyMdiChildrenDockType
Gets or sets a value indicating dock type of MDI child host windows added to RadDock.
Public propertyMinimumSize (Inherited from SplitPanel.)
Public propertyOrientation
Gets or sets a value indicating the horizontal or vertical orientation of the Telerik.WinControls.UI.RadSplitContainer panels.
(Inherited from RadSplitContainer.)
Public propertyPadding
Public propertyParent (Inherited from SplitPanel.)
Public propertyQuickNavigatorSettings
Gets the object which controls the appearance of the QuickNavigator control.
Public propertyReleaseMemoryOnClose
Public propertyRootContainer
Public propertyRootElement
Gets the RootElement of the control.
(Inherited from RadControl.)
Public propertySerializableAutoHideContainer
Gets an instance of DockAutoHideSerializationContainer that contains information about auto-hidden windows which have been set up through designer or xml file. This nethod is no intended for use directly from your code.
Public propertySerializableFloatingWindows
Gets an instance of FloatingWindowList that contains information about floating windows which have been set up through designer or xml file. This nethod is no intended for use directly from your code.
Public propertyShowDocumentCloseButton
Determines whether DocumentTabStrip instances will display a Close Button next to each item.
Public propertyShowDocumentPinButton
Determines whether DocumentTabStrip instances will display a Pin Button next to each item.
Public propertyShowItemToolTips
Gets or sets a value indicating whether ToolTips are shown for the RadItem objects contained in the RadControl.
(Inherited from RadControl.)
Public propertyShowToolCloseButton
Determines whether ToolTabStrip instances will display Close Button next to each item.
Public propertySingleScreen
Gets or sets a value indicating whether the RadDock control behavior and layout apply only to primary screen.
Public propertySite
Public propertySizeInfo
Public propertySmallImageList (Inherited from SplitPanel.)
Public propertySmallImageScalingSize
Gets or sets the small image scaling size.
(Inherited from RadControl.)
Public propertySplitContainer
Public propertySplitContainerElement
Gets the split container element.
(Inherited from RadSplitContainer.)
Public propertySplitPanelElement
Gets the instance of RadPanelElement wrapped by this control. RadPanelElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadPanel.
(Inherited from SplitPanel.)
Public propertySplitPanels
Public propertySplitterDistance
Gets a value indicating the splitter distance. Never set the value of this property directly.
(Inherited from RadSplitContainer.)
Public propertySplitters (Inherited from RadSplitContainer.)
Public propertySplitterWidth (Overrides RadSplitContainerSplitterWidth.)
Public propertyTabStripsLayout
Public propertyText
This property is not relevant for this class.
(Overrides RadSplitContainerText.)
Public propertyThemeClassName
Public propertyThemeName
Gets or sets control's preferred theme name. Themes are stored and retrieved using APIs of ThemeResolutionService.
(Inherited from RadControl.)
Public propertyToolTabsAlignment
Gets or sets the alignment of the TabStripElement in all ToolTabStrip instances.
Public propertyToolTabsTextOrientation
Gets or sets the text orientation of the TabStripElement in all ToolTabStrip instances.
Public propertyToolTabsVisible
Determines whether the TabStripElement in ToolTabStrip instances is visible.
Public propertyToolWindowInsertOrder
Gets or sets the insert order to be used when adding dock windows to a ToolTabStrip.
Public propertyUseCompatibleTextRendering
Determines whether to use compatible text rendering engine (GDI+) or not (GDI).
(Inherited from RadControl.)
Public propertyUseSplitterButtons
Enable and Disable navigation buttons.
(Inherited from RadSplitContainer.)
Protected propertyValidationCancel (Inherited from RadControl.)
Public propertyXmlSerializationInfo
Gets the serialization info for RadDock used by Save/Load loyout methods to persist grid settings to/from XML. By default, or when set to null the ComponentXmlSerializationInfo provided by GetDefaultXmlSerializationInfo() will be used.
Top
Methods
  NameDescription
Public methodActivateMdiChild
Activates the MDI child of a form.
Public methodActivateWindow(DockWindow)
Activates the specified DockWindow and gives it the keyboard focus.
Protected methodActivateWindow(DockWindow, Boolean)
Activates the specified window and gives it the keyboard focus.
Public methodAddDocument(DockWindow)
Adds the specified DockWindow instance to the main document tab strip.
Public methodAddDocument(DockWindow, DockPosition)
Adds the the specified DockWindow instance at the specified dock position, aligned with the main document tabstrip.
Public methodAddDocument(DockWindow, DockWindow, DockPosition)
Adds the the specified DockWindow instance to the specified DocumentTabStrip instance.
Public methodAddDocument(DockWindow, DocumentTabStrip, DockPosition)
Adds the specified DockWindow instance to a new DocumentTabStrip instance.
Public methodAddDocuments
Adds a collection of DockWindows to a new DocumentTabStrip instance.
Public methodApplySplitterWidth (Overrides RadSplitContainerApplySplitterWidth(Int32).)
Protected methodApplyThemeToSplitterElements
Applies theme to all SplitterElements.
(Inherited from RadSplitContainer.)
Public methodAutoHideWindow
Makes the specified DockWindow auto-hidden.
Public methodAutoHideWindows
Makes the specified DockWindow collection auto-hidden.
Public methodBeginInit
Public methodBeginTransactionBlock
Opens a transaction (batch) operation. This is used by the framework to indicate some lengthy operations, during which no updates should be performed.
Public methodBeginTransactionBlock(Boolean)
Opens a transaction (batch) operation. This is used by the framework to indicate some lengthy operations, during which no updates should be performed.
Public methodBeginUpdate
Begins an update operation. Internally used by the transaction mechanism.
Protected methodCalculateSplitterDistance (Inherited from RadSplitContainer.)
Public methodCallAccessibilityNotifyClients
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnGotFocus
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnKeyDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnKeyPress
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnKeyUp
This method is used internally!
(Inherited from RadControl.)
Public methodCallBaseOnLostFocus
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnClick
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnControlTreeChanged
Calls the OnControlTreeChanged method. This method is used internally.
Public methodCallOnDoubleClick
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnKeyDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnKeyPress
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnKeyUp
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseCaptureChanged
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseEnter
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseHover
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseLeave
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseMove
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseUp
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnMouseWheel
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnPreviewKeyDown
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnScreenTipNeeded
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnThemeNameChanged
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnToolTipTextNeeded
This method is used internally!
(Inherited from RadControl.)
Public methodCallOnVisibleChanged
This method is used internally!
(Inherited from RadControl.)
Public methodCanChangeWindowState(DockWindow, DockState)
Determines whether the provided dock state may be applied to the specified DockWindow.
Protected methodCanChangeWindowState(DockWindow, DockState, Boolean)
Determines whether the specified window's DockState value can be changed to the specified new one.
Protected methodCanEditElementAtDesignTime
Determines whether an element may be edited via the EditUIElements dialog at design-time.
(Inherited from RadControl.)
Public methodCanEditUIElement
Determines whether an element from this element tree may be displayed in the EditUIElements dialog.
(Inherited from RadControl.)
Public methodCanSelectAtDesignTime
Determines whether the container can be selected at design-time. This method is used internally.
(Inherited from RadSplitContainer.)
Public methodCleanUp
Performs a clean-up pass which removes all unnecessary internally created split panels and/or collapses or disposes them.
Public methodCloseAllWindows
Calls the Close method for all currently registered windows, using each window's CloseAction.
Public methodCloseAutoHidePopup
Closes the popup of the currently opened auto-hide window.
Public methodCloseWindow
Removes or hides (depending on the CloseAction) the specified window.
Public methodCloseWindows
Removes or hides (depending on the CloseAction) the specified windows.
Protected methodCommitTransaction
Commits the specified transaction.
Protected methodConstruct (Inherited from RadSplitContainer.)
Public methodContains(String)
Determines whether a DockWindow instance with the specified name is registered with this RadDock instance.
Public methodContains(DockWindow)
Determines whether the specified DockWindow is registered with this RadDock instances.
Public methodControlDefinesThemeForElement
Checks whether the element's theme is defined by the control.
(Inherited from RadControl.)
Protected methodCreateBehavior
Creates the input behavior instance. Allows inheritors to provide custom input implementations.
(Inherited from RadControl.)
Protected methodCreateChildItems
Protected methodCreateControlsInstance (Inherited from RadSplitContainer.)
Public methodCreateDefaultTabStrip
Creates and returns the default DockTabStrip for a given DockType.
Protected methodCreateLayoutStrategy
Creates new SplitContainerLayoutStrategy instance. Allows inheritors to provide custom type.
Protected methodCreateRootElement (Inherited from RadControl.)
Protected methodCreateXmlWriterSettings
Creates the core XmlWritterSettings to be used by the serialization manager.
Public methodDisableGesture
Disable firing gesture events of the specified type.
(Inherited from RadControl.)
Public methodDisplayQuickNavigator
Visualizes the QuickNavigator control allowing for active tool windows and documents browsing.
Public methodDisplayWindow
Displays the specified window if was previously hidden.
Public methodDisplayWindows
Displays the provided dock windows if they were previously hidden and are registered with this RadDock instance.
Protected methodDispose
Releases the unmanaged resources used by the RadDock and optionally releases the managed resources
(Overrides RadControlDispose(Boolean).)
Public methodDockControl(Control, DockPosition)
Registers the specified control as part of the docking framework.
Public methodDockControl(Control, DockPosition, DockType)
Registers the specified control as part of the docking framework.
Public methodDockControl(Control, DockTabStrip, DockPosition)
Registers the specified control as part of the docking framework.
Public methodDockControl(Control, DockWindow, DockPosition)
Registers the specified control as part of the docking framework.
Public methodDockControl(Control, DockTabStrip, DockPosition, DockType)
Registers the specified control as part of the docking framework.
Public methodDockControl(Control, DockWindow, DockPosition, DockType)
Registers the specified control as part of the docking framework.
Public methodDockWindow(DockWindow, DockPosition)
Registers the specified DockWindow instance and docks it at the desired psotion.
Public methodDockWindow(DockWindow, DockWindow, DockPosition)
Registers the specified DockWindow instance and docks it at the desired psotion, using the provided target window as an anchor.
Public methodDockWindow(DockWindow, SplitPanel, DockPosition)
Registers the specified DockWindow instance and docks it at the desired position, using the provided SplitPanel as an anchor.
Public methodEnableGesture
Enable firing gesture events of the specified type.
(Inherited from RadControl.)
Public methodEndInit
Public methodEndTransactionBlock
Ends previously opened transaction. Optionally preforms update.
Public methodEndUpdate
Ends a BeginUpdate block.
Public methodEndUpdate(Boolean)
Ends a BeginUpdate block and optionally performs update.
Public methodEnqueueTransaction
Adds the
Public methodEnsureInitialized
This method is used internally.
Public methodEnumFrameworkControlsT
Enumerates all currently alive T instances available within the framework.
Protected methodFindPropertyInChildren (Inherited from RadControl.)
Public methodFloatToolTabStrip
Makes the specified tool tab strip floating.
Public methodFloatWindow(DockWindow)
Makes the specified window floating.
Public methodFloatWindow(DockWindow, Rectangle)
Makes the specified window floating, using the provided bounds.
Public methodFloatWindows(IEnumerableDockWindow, Rectangle)
Makes the specified windows floating, using the provided bounds.
Public methodFloatWindows(IEnumerableDockWindow, Rectangle, DockType)
Makes the specified windows floating, using the provided bounds.
Public methodFlushTransactions
Commits all pending transactions without exitting the transaction block.
Public methodGetAutoHideTab
Gets the auto hide tab item.
Public methodGetAutoHideTabStrip
Gets the auto hide tab strip.
Public methodGetChildAt
Method used by control Code Dom serializer to access element in the collection of RootElement.
(Inherited from RadControl.)
Public methodGetControlDefaultSize
This method is used internally!
(Inherited from RadControl.)
Public methodGetDefaultDocumentTabStrip
Gets the default DocumentTabStrip instance, used to add documents without explicitly specified dock target.
Public methodGetDefaultXmlSerializationInfo
Gets the default serialization info for RadDock used by Save/Load loyout methods to persist grid settings to/from XML.
Public methodGetHostWindow
Get the host window for Control instance docked with DockControl method or for MDI children Form object
Protected methodGetInputElement (Inherited from RadControl.)
Public methodGetNextDocumentStrip
Gets the next document tab strip, regarding the specified DockWindow. The window should be in TabbedDocument state for the method to work.
Public methodGetPlainText
Strips all html tags of the text set to the control and returns only the plain text.
(Inherited from RadControl.)
Public methodGetPreferredSize (Inherited from RadControl.)
Public methodGetPreviousDocumentStrip
Gets the previous document tab strip, regarding the specified DockWindow. The window should be in TabbedDocument state for the method to work.
Protected methodGetRootElementDesiredSize (Inherited from RadControl.)
Public methodGetServiceT
Retrieves currently registered Service by the specified type.
Protected methodGetServiceT(Int32)
Retrieves currently registered Service by the provided key. All predefined service keys may be found in ServiceConstants class.
Public methodGetSplitterElementAtPoint
Public methodGetWindowT
Gets DockWindow instance with the corresponding Name by the specified type.
Public methodGetWindows(Type)
Gets the windows by the specified types.
Public methodGetWindowsT
Gets the windows by the specified type.
Protected methodInitializeRootElement (Inherited from RadControl.)
Public methodInvokeLayoutCallback (Inherited from RadControl.)
Protected methodIsInputKey (Inherited from RadControl.)
Protected methodIsNameAvailable
Protected methodLayoutInternal (Inherited from RadSplitContainer.)
Public methodLoadElementTree
Loads the element tree. While not loaded, no layout operations are allowed upon the tree. By default, the tree will be loaded when the control is displayed for the first time.
(Inherited from RadControl.)
Public methodLoadElementTree(Size)
Loads the element tree using the specified desired size.
(Inherited from RadControl.)
Public methodLoadFromXml(Stream)
Loads the docking layout configuration from a stream. This method will try to guess if the xml in the stream was written with the DockingManager or with the new RadDock in order to determine how to read it successfully.
Public methodLoadFromXml(TextReader)
Loads the docking layout configuration from a TextReader. Note that this is a new method and does not support loading xml that was written using DockingManager.
Public methodLoadFromXml(String)
Loads the docking layout configuration from a file. This method will try to guess if the xml in the file was written with the DockingManager or with the new RadDock in order to determine how to read it successfully.
Protected methodLoadFromXmlCore
Overrwrite this method to change the loading of docking layout configuration.
Public methodMergeWithParentContainer
Provides a routine which merges a container with its parent (if appropriate). The purpose of this logic is to remove internally created containers when they are not needed. This method is used internally.
(Inherited from RadSplitContainer.)
Public methodMoveSplitter (Inherited from RadSplitContainer.)
Public methodMoveToNextDocumentTabStrip
Move DockWindow to next document tab strip if exist when DockWindow is in document mode
Public methodMoveToPreviousDocumentTabStrip
Move DockWindow to previuos document tab strip if exist when DockWindow is in document mode
Protected methodOnActiveWindowChanged
Raises the ActiveWindowChanged event.
Protected methodOnActiveWindowChanging
Raises the ActiveWindowChanging event.
Protected methodOnAutoHideButtonClicked
An Auto-hide button click notification, received from a registered ToolTabStrip.
Protected methodOnAutoHideWindowDisplayed
Raises the AutoHideWindowDisplayed event.
Protected methodOnAutoHideWindowDisplaying
Raises the AutoHideWindowDisplaying event.
Protected methodOnAutoHideWindowHidden
Raises the AutoHideWindowHidden event.
Protected methodOnAutoHideWindowHiding
Raises the AutoHideWindowHiding event.
Protected methodOnAutoSizeChanged (Inherited from RadControl.)
Protected methodOnBackColorChanged (Inherited from RadControl.)
Protected methodOnBackgroundImageChanged (Overrides ControlOnBackgroundImageChanged(EventArgs).)
Protected methodOnBindingContextChanged (Inherited from RadControl.)
Protected methodOnCaptureLosing (Inherited from RadControl.)
Protected methodOnChildPanelCollapsedChanged (Inherited from RadSplitContainer.)
Protected methodOnClick (Inherited from RadControl.)
Protected methodOnControlAdded (Inherited from SplitPanel.)
Protected methodOnControlRemoved (Inherited from RadSplitContainer.)
Protected methodOnControlTreeChanged
Protected methodOnCreateControl (Inherited from RadControl.)
Protected methodOnDockStateChanged
Raises the DockStateChanged event.
Protected methodOnDockStateChanging
Raises the DockStateChanging event.
Protected methodOnDockStateContextMenuClicked
Recieves a notification for a change state request, made from the window's associated context menu.
Protected methodOnDockWindowAdded
Raises the DockWindowAdded event.
Protected methodOnDockWindowClosed
Raises the DockWindowClosed event.
Protected methodOnDockWindowClosing
Raises the DockWindowClosing event.
Protected methodOnDockWindowNameChanged
The manager gets notified for a change in the specified DockWindow instance Name property.
Protected methodOnDockWindowRemoved
Raises the DockWindowRemoved event.
Protected methodOnDockWindowSerializing
Raises the DockWindowSerializing event.
Protected methodOnDoubleClick (Inherited from RadControl.)
Protected methodOnEnabledChanged
Protected methodOnFloatingWindowCreated
Raises the FloatingWindowCreated event.
Protected methodOnFontChanged (Inherited from RadControl.)
Protected methodOnForeColorChanged (Inherited from RadControl.)
Protected methodOnGesture (Inherited from RadControl.)
Protected methodOnGotFocus (Inherited from RadControl.)
Protected methodOnHandleCreated
(Overrides ControlOnHandleCreated(EventArgs).)
Protected methodOnHandleDestroyed
Protected methodOnInvalidated (Inherited from RadControl.)
Protected methodOnKeyDown (Inherited from RadControl.)
Protected methodOnKeyPress (Inherited from RadControl.)
Protected methodOnKeyUp (Inherited from RadControl.)
Protected methodOnLayout (Inherited from RadSplitContainer.)
Protected methodOnLoad
Called when control's creation is complete.
(Overrides RadSplitContainerOnLoad(Size).)
Protected methodOnLoadedFromXml
Raises the LoadedFromXml event.
Protected methodOnLocationChanged (Inherited from RadControl.)
Protected methodOnLostFocus (Inherited from RadControl.)
Protected methodOnMouseCaptureChanged (Inherited from RadControl.)
Protected methodOnMouseDoubleClick (Inherited from RadSplitContainer.)
Protected methodOnMouseDown (Overrides RadSplitContainerOnMouseDown(MouseEventArgs).)
Protected methodOnMouseEnter (Inherited from RadControl.)
Protected methodOnMouseHover (Inherited from RadControl.)
Protected methodOnMouseLeave (Inherited from RadSplitContainer.)
Protected methodOnMouseMove (Overrides RadSplitContainerOnMouseMove(MouseEventArgs).)
Protected methodOnMouseUp (Inherited from RadSplitContainer.)
Protected methodOnMouseWheel (Inherited from RadControl.)
Protected methodOnNavigationButtonClick (Inherited from RadSplitContainer.)
Protected methodOnNotifyPropertyChanged(PropertyChangedEventArgs) (Inherited from RadControl.)
Protected methodOnNotifyPropertyChanged(String)
Raises the PropertyChanged event
(Inherited from RadControl.)
Protected methodOnOrientationChanged (Inherited from RadSplitContainer.)
Protected methodOnPaddingChanged (Overrides RadControlOnPaddingChanged(EventArgs).)
Protected methodOnPaint (Inherited from RadControl.)
Public methodOnPanelCollapsed (Inherited from RadSplitContainer.)
Public methodOnPanelCollapsing (Inherited from RadSplitContainer.)
Protected methodOnPanGesture
Fires the PanGesture event.
(Inherited from RadControl.)
Protected methodOnParentChanged
Protected methodOnParentVisibleChanged (Overrides ControlOnParentVisibleChanged(EventArgs).)
Protected methodOnPressAndTapGesture
Fires the PressAndTapGesture event.
(Inherited from RadControl.)
Protected methodOnPreviewKeyDown (Inherited from RadControl.)
Protected methodOnQuickNavigatorSnapshotNeeded
Raises the QuickNavigatorSnapshotNeeded event.
Protected methodOnRightToLeftChanged (Inherited from RadControl.)
Protected methodOnRotateGesture
Fires the RotateGesture event.
(Inherited from RadControl.)
Protected methodOnSavedToXml
Raises the SavedToXml event.
Protected methodOnScreenTipNeeded (Inherited from RadControl.)
Protected methodOnSelectedTabChanged
Protected methodOnSelectedTabChanging
Protected methodOnSplitterMoved (Inherited from RadSplitContainer.)
Protected methodOnSplitterMoving (Inherited from RadSplitContainer.)
Protected methodOnTabStripItemDoubleClick
Protected methodOnThemeChanged
Delegates the ThemeChanged event to all owned controls and elements.
(Overrides RadSplitContainerOnThemeChanged.)
Protected methodOnThemeNameChanged (Inherited from RadControl.)
Protected methodOnToolTabStripDoubleClick
Receives a notification from a tooltabstrip that the mouse was clicked inside its area. The default implementation will try to restore the state of the associated windows.
Protected methodOnToolTipTextNeeded (Inherited from RadControl.)
Protected methodOnTransactionBlockEnded
Raises the TransactionBlockEnded event.
Protected methodOnTransactionBlockStarted
Raises the TransactionBlockStarted event.
Protected methodOnTransactionCommitted
Raises the TransactionCommitted event.
Protected methodOnTransactionCommitting
Raises the TransactionCommitting event.
Protected methodOnTwoFingerTapGesture
Fires the TwoFingerTapGesture event.
(Inherited from RadControl.)
Protected methodOnVisibleChanged (Overrides ScrollableControlOnVisibleChanged(EventArgs).)
Protected methodOnZoomGesture
Fires the ZoomGesture event.
(Inherited from RadControl.)
Protected methodPerformUpdate
Performs the core update logic after an EndUpdate call.
Protected methodPostCommitTransaction
Allows inheritors to provide additional post-commit processing of a transaction.
Protected methodPreCommitTransaction
Allows inheritors to provide additional pre-commit processing of a transaction.
Protected methodProcessAutoSizeChanged (Inherited from RadControl.)
Protected methodProcessCaptureChangeRequested
Processes a capture request from the specified element.
(Inherited from RadControl.)
Protected methodProcessCodedUIMessage (Inherited from RadControl.)
Protected methodProcessFocusRequested (Overrides RadControlProcessFocusRequested(RadElement).)
Protected methodProcessGesture (Inherited from RadControl.)
Protected methodProcessMnemonic (Inherited from RadControl.)
Public methodRefresh (Inherited from RadControl.)
Public methodRegisterHostedControl (Inherited from RadControl.)
Public methodRegisterService
Registers the specified service with ourselves.
Public methodRemoveAllDocumentWindows
Removes all DocumentWindows, without disposing it.
Public methodRemoveAllDocumentWindows(DockWindowCloseAction)
Removes all DocumentWindows, using the specified close action.
Public methodRemoveAllWindows
Removes all DockWindows, without disposing them.
Public methodRemoveAllWindows(DockWindowCloseAction)
Removes all DockWindows, using the specified close action.
Public methodRemoveWindow(DockWindow)
Removes the specified window, without disposing it, from the dock manager.
Public methodRemoveWindow(DockWindow, DockWindowCloseAction)
Removes the specified window, using the specified DockWindowCloseAction.
Protected methodResetBackColorThemeOverrides (Inherited from RadSplitContainer.)
Protected methodResetForeColorThemeOverrides (Inherited from RadControl.)
Public methodResolveStyleGroupForElement
Replaces the default style group for specific element.
(Inherited from RadControl.)
Public methodRestoreSplitterPosition (Inherited from RadSplitContainer.)
Public methodRestoreWindowsStatesAfterLoad
This method is used internally.
Public methodRestoreWindowsStatesAfterLoad(Boolean)
This method is used internally.
Public methodResumeUpdate (Inherited from RadControl.)
Public methodResumeUpdate(Boolean) (Inherited from RadControl.)
Public methodSaveToXml(Stream)
Saves the docking layout configuration in an XML format in the specified stream.
Public methodSaveToXml(TextWriter)
Saves the docking layout configuration in an XML format in the specified TextWriter.
Public methodSaveToXml(String)
Saves the docking layout configuration in an XML format in the specified file.
Protected methodSaveToXmlCore
Performs the core save logic.
Protected methodScaleControl (Inherited from SplitPanel.)
Protected methodSetBackColorThemeOverrides (Inherited from RadSplitContainer.)
Protected methodSetBoundsCore
Protected methodSetForeColorThemeOverrides (Inherited from RadControl.)
Public methodSetIsInitializing
This method is used internally!
(Inherited from RadControl.)
Public methodSetWindowState
Applies the desired DockState to the specified DockWindow. If a previously RedockState is saved for the desired DockState, this state is restored, else the default action is performed.
Public methodShouldProcessNotification
This method is used internally.
Public methodShouldSerializeBackColor
Determines whether the BackColor property should be serialized.
(Inherited from RadControl.)
Public methodShouldSerializeFont
Determines whether the ForeColor property should be serialized.
(Inherited from RadControl.)
Public methodShouldSerializeForeColor
Determines whether the ForeColor property should be serialized.
(Inherited from RadControl.)
Protected methodShouldSerializeProperty
Determines whether the specified RadProperty should be serialized.
(Inherited from RadControl.)
Public methodShowAutoHidePopup(HostWindow)
Public methodShowAutoHidePopup(ToolWindow)
Public methodSuspendUpdate (Inherited from RadControl.)
Public methodUnregisterHostedControl (Inherited from RadControl.)
Protected methodUpdateBackgroundSettings
Public methodUpdateCollapsed (Overrides RadSplitContainerUpdateCollapsed.)
Protected methodUpdateSplitter
Updates the splitter, associated with the specified index of a child SplitPanel.
(Inherited from RadSplitContainer.)
Protected methodWndProc (Inherited from SplitPanel.)
Top
Events
  NameDescription
Public eventActiveWindowChanged
Notifies for an actual change of the ActiveWindow property.
Public eventActiveWindowChanging
Notifies for an upcomming change of the ActiveWindow property. Cancelable.
Public eventAutoHideWindowDisplayed
Notifies that an auto-hidden window is about to be displayed. Cancelable.
Public eventAutoHideWindowDisplaying
Notifies that an auto-hidden window is about to be displayed. Cancelable.
Public eventAutoHideWindowHidden
Notifies that a window which DockState is AutoHide has been hidden.
Public eventAutoHideWindowHiding
Notifies that a window with AutoHide DockState is hiding.
Public eventControlTreeChanged (Inherited from SplitPanel.)
Public eventDockStateChanged
Notifies for a change in the DockState of the associated window.
Public eventDockStateChanging
Notifies for an upcomming change in the DockState of the associated window. Cancelable.
Public eventDockTabStripNeeded
Raised whenever a new DockTabStrip instance is needed internally by the framework. Allows for providing custom ToolTabStrip and DocumentTabStrip implementations.
Public eventDockWindowAdded
Notifies for a new DockWindow registered with this RadDock instance.
Public eventDockWindowClosed
Raised after a DockWindow has been closed.
Public eventDockWindowClosing
Raised before a DockWindow.Close method is called.
Public eventDockWindowRemoved
Notifies for a DockWindow removed from this RadDock instance. This event will not be raised for hidden windows.
Public eventDockWindowSerializing
Fired when a dock window is being serialized. Allows excluding some windows from serialization.
Public eventElementInvalidated (Inherited from RadControl.)
Public eventFloatingWindowCreated
Notifies that a FloatingWindow instance is internally created by the framework. Allows listeners to examine and optionally change the window itself.
Public eventInitialized
Fires when the control is initialized.
(Inherited from RadControl.)
Public eventLoadedFromXml
Notifies that manager's state has been loaded from an external XML source.
Public eventPageViewInstanceCreated
Fires after RadPageViewElement is created.
Public eventPanelCollapsed
Occurs when some panel collapsed.
(Inherited from RadSplitContainer.)
Public eventPanelCollapsedChanged (Inherited from RadSplitContainer.)
Public eventPanelCollapsing
Occurs when some panel is collapsing.
(Inherited from RadSplitContainer.)
Public eventPanGesture
Occurs when a pan gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventPressAndTapGesture
Occurs when a press-and-tap gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventPropertyChanged
Occurs when a property of an object changes change. Calling the event is developer's responsibility.
(Inherited from RadControl.)
Public eventQuickNavigatorSnapshotNeeded
Raised when the QuickNavigator is displayed and a preview snapshot for the currently selected window is needed.
Public eventRotateGesture
Occurs when a rotate gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventSavedToXml
Notifies that manager's state has been saved to an external XML source.
Public eventScreenTipNeeded
Occurs prior the ScreenTip of a RadItem instance inside the RadControl is displayed.
(Inherited from RadControl.)
Public eventSelectedTabChanged
Occurs when selected tab changed in currently manipulated DockTabStrip.
Public eventSelectedTabChanging
Occurs when selected tab changing in currently manipulated DockTabStrip.
Public eventSplitContainerNeeded
Raised whenever a new RadSplitContainer instance is needed internally by the framework. Allows for providing custom RadSplitContainer implementation.
Public eventSplitterMoved
Occurs when any of the splitters is moved.
(Inherited from RadSplitContainer.)
Public eventSplitterMoving
Occurs when any of the splitters is moving.
(Inherited from RadSplitContainer.)
Public eventThemeNameChanged
Fires when the theme name is changed.
(Inherited from RadControl.)
Public eventToolTipTextNeeded
Occurs when a RadItem instance inside the RadControl requires ToolTip text.
(Inherited from RadControl.)
Public eventTransactionBlockEnded
Notifies for a successful EndTransactionBlock operation, when all transactions are committed, the DockTree is cleaned, and updates are resumed.
Public eventTransactionBlockStarted
Notifies for a successful BeginTransactionBlock operation.
Public eventTransactionCommitted
Raised when a RadDockTransaction is successfully committed. Allows listeners to perform some additional operations.
Public eventTransactionCommitting
Raised when a RadDockTransaction is about to be committed. Allows listeners to investigate the transaction, perform some additional actions and/or cancel it.
Public eventTwoFingerTapGesture
Occurs when a two-finger-tap gesture was sent by a touch input device.
(Inherited from RadControl.)
Public eventZoomGesture
Occurs when a zoom gesture was sent by a touch input device.
(Inherited from RadControl.)
Top
Fields
  NameDescription
Public fieldStatic memberDockSplitContainerThemeClassName
Protected fieldinvalidResizeRect (Inherited from RadControl.)
Protected fieldisAccessibilityRequested (Inherited from RadControl.)
Protected fieldisDisposing2 (Inherited from RadControl.)
Protected fieldisResizing2 (Inherited from RadControl.)
Top
See Also