Click or drag to resize
RadDock Methods

The RadDock type exposes the following members.

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
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
See Also