Class RadDock

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. A typical scenario of utilizing a docking framework is as follows:

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
System.Object
RadControl
SplitPanel
RadSplitContainer
RadDock
Inherited Members
Namespace: Telerik.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadDock : RadSplitContainer, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, ILoadObsoleteDockingManagerXml, IMessageListener

Constructors

RadDock()

Initializes a new RadDock instance.

Declaration
public RadDock()

Fields

DockSplitContainerThemeClassName

Declaration
public const string DockSplitContainerThemeClassName = "DockSplitContainer"
Field Value
System.String

Properties

ActiveFloatingWindows

Declaration
public ReadOnlyCollection<FloatingWindow> ActiveFloatingWindows { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<FloatingWindow>

ActiveWindow

Gets or sets the DockWindow instance, which is currently active (meaning it contains the Keyboard focus).

Declaration
public DockWindow ActiveWindow { get; set; }
Property Value
DockWindow

AllowDrop

Declaration
public override bool AllowDrop { get; set; }
Property Value
System.Boolean

AutoDetectMdiChildren

Gets or sets a value indicating whether [auto detect MDI child].

Declaration
public bool AutoDetectMdiChildren { get; set; }
Property Value
System.Boolean

true if [auto detect MDI child]; otherwise, false.

AutoHideAnimation

Determines what animation will be used when displaying/hiding auto-hidden windows.

Declaration
public AutoHideAnimateMode AutoHideAnimation { get; set; }
Property Value
AutoHideAnimateMode

AutoHideAnimationDuration

Gets or sets the duration of the auto hide window animation. The default value is 200 milliseconds.

Declaration
public int AutoHideAnimationDuration { get; set; }
Property Value
System.Int32

The duration of the auto hide window animation. The default value is 200 milliseconds.

AutoHidePopup

Declaration
public AutoHidePopup AutoHidePopup { get; }
Property Value
AutoHidePopup

AutoScroll

Declaration
public override bool AutoScroll { get; set; }
Property Value
System.Boolean

AutoScrollMargin

Declaration
public Size AutoScrollMargin { get; set; }
Property Value
System.Drawing.Size

AutoScrollMinSize

Declaration
public Size AutoScrollMinSize { get; set; }
Property Value
System.Drawing.Size

AutoSize

Gets or sets whether the edit control is auto-sized

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BackColor

RadDock consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

Collapsed

Declaration
public bool Collapsed { get; set; }
Property Value
System.Boolean

CommandManager

Gets the RadDockCommandManager registered with this RadDock instance.

Declaration
public RadDockCommandManager CommandManager { get; }
Property Value
RadDockCommandManager

ContentRectangle

Overrides the content rectangle to add any visible auto-hide tabstrips to the calculations.

Declaration
public override Rectangle ContentRectangle { get; }
Property Value
System.Drawing.Rectangle

Overrides

DockingGuidesTemplate

Gets or sets the template, which defines the appearance of the guides displayed upon drag-and-drop operation.

Declaration
public IDockingGuidesTemplate DockingGuidesTemplate { get; set; }
Property Value
IDockingGuidesTemplate

DockWindows

Gets a collection with all the currently attached DockWindow instances.

Declaration
public DockWindowCollection DockWindows { get; }
Property Value
DockWindowCollection

DocumentManager

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.

Declaration
public DocumentManager DocumentManager { get; }
Property Value
DocumentManager

DocumentTabsAlignment

Gets or sets the alignment of the TabStripElement in all DocumentTabStrip instances.

Declaration
public TabStripAlignment DocumentTabsAlignment { get; set; }
Property Value
TabStripAlignment

DocumentTabsTextOrientation

Gets or sets the text orientation of the TabStripElement in all ToolTabStrip instances.

Declaration
public TabStripTextOrientation DocumentTabsTextOrientation { get; set; }
Property Value
TabStripTextOrientation

DocumentTabsVisible

Determines whether the TabStripElement in DocumentTabStrip instances is visible.

Declaration
public bool DocumentTabsVisible { get; set; }
Property Value
System.Boolean

DragDropAllowedDockStates

Gets or sets the allowed dock states for a committing drag-and-drop operation.

Declaration
public AllowedDockState DragDropAllowedDockStates { get; set; }
Property Value
AllowedDockState

DragDropMode

Gets or sets the mode used by the DragDropService when a drag-and-drop request is made.

Declaration
public DragDropMode DragDropMode { get; set; }
Property Value
DragDropMode

Enabled

Declaration
public bool Enabled { get; set; }
Property Value
System.Boolean

EnableFloatingWindowSnapping

Determines whether all floating windows' will snap to their edges.

Declaration
public bool EnableFloatingWindowSnapping { get; set; }
Property Value
System.Boolean

EnableFloatingWindowTheming

Determines whether all floating windows' frames within the framework will be themed using Telerik's TPF or will be let with their system appearance.

Declaration
public bool EnableFloatingWindowTheming { get; set; }
Property Value
System.Boolean

FloatingWindows

Gets a list of the floating windows. Can contain duplicates, empty or hidden toolwindows which are used internally as re-dock targets.

Declaration
public FloatingWindowCollection FloatingWindows { get; }
Property Value
FloatingWindowCollection

ForeColor

RadDock consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

GuidToNameMappings

Declaration
public GuidToNameMappingCollection GuidToNameMappings { get; }
Property Value
GuidToNameMappingCollection

IsDragging

Determines whether the DragDropService is currently working (a drag-and-drop operation is running).

Declaration
public bool IsDragging { get; }
Property Value
System.Boolean

IsInTransactionBlock

Determines whether the RadDock is currently in a transaction (internal operation).

Declaration
public bool IsInTransactionBlock { get; }
Property Value
System.Boolean

Item[String]

Gets DockWindow instance with the corresponding Name.

Declaration
public DockWindow this[string dockWindowName] { get; }
Parameters
System.String dockWindowName

Property Value
DockWindow

DockWindow instance with matching Name. Null (Nothing in VB.NET) otherwise.

LayoutStrategyType

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.

Declaration
public Type LayoutStrategyType { get; set; }
Property Value
System.Type

MainDocumentContainer

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.

Declaration
public DocumentContainer MainDocumentContainer { get; set; }
Property Value
DocumentContainer

MainDocumentContainerVisible

Determines whether the main document container is visible.

Declaration
public bool MainDocumentContainerVisible { get; set; }
Property Value
System.Boolean

MdiChildren

Gets an array with all the standard Forms added as TabbedDocument to this RadDock instance.

Declaration
public Form[] MdiChildren { get; }
Property Value
System.Windows.Forms.Form[]

MdiChildrenDockType

Gets or sets a value indicating dock type of MDI child host windows added to RadDock.

Declaration
public DockType MdiChildrenDockType { get; set; }
Property Value
DockType

Padding

Declaration
public Padding Padding { get; set; }
Property Value
System.Windows.Forms.Padding

QuickNavigatorSettings

Gets the object which controls the appearance of the QuickNavigator control.

Declaration
public QuickNavigatorSettings QuickNavigatorSettings { get; }
Property Value
QuickNavigatorSettings

ReleaseMemoryOnClose

Declaration
public bool ReleaseMemoryOnClose { get; set; }
Property Value
System.Boolean

RootContainer

Declaration
public RadSplitContainer RootContainer { get; }
Property Value
RadSplitContainer

SerializableAutoHideContainer

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.

Declaration
public DockAutoHideSerializationContainer SerializableAutoHideContainer { get; }
Property Value
DockAutoHideSerializationContainer

SerializableFloatingWindows

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.

Declaration
public FloatingWindowList SerializableFloatingWindows { get; }
Property Value
FloatingWindowList

ShowDocumentCloseButton

Determines whether DocumentTabStrip instances will display a Close Button next to each item.

Declaration
public bool ShowDocumentCloseButton { get; set; }
Property Value
System.Boolean

ShowDocumentPinButton

Determines whether DocumentTabStrip instances will display a Pin Button next to each item.

Declaration
public bool ShowDocumentPinButton { get; set; }
Property Value
System.Boolean

ShowToolCloseButton

Determines whether ToolTabStrip instances will display Close Button next to each item.

Declaration
public bool ShowToolCloseButton { get; set; }
Property Value
System.Boolean

SingleScreen

Gets or sets a value indicating whether the RadDock control behavior and layout apply only to primary screen.

Declaration
public bool SingleScreen { get; set; }
Property Value
System.Boolean

Site

Declaration
public override ISite Site { get; set; }
Property Value
System.ComponentModel.ISite

Overrides

SizeInfo

Declaration
public SplitPanelSizeInfo SizeInfo { get; }
Property Value
SplitPanelSizeInfo

SplitContainer

Declaration
public RadSplitContainer SplitContainer { get; }
Property Value
RadSplitContainer

SplitPanels

Declaration
public SplitPanelCollection SplitPanels { get; }
Property Value
SplitPanelCollection

SplitterWidth

Declaration
public override int SplitterWidth { get; set; }
Property Value
System.Int32

Overrides

TabStripsLayout

Declaration
public DockLayoutPanel TabStripsLayout { get; }
Property Value
DockLayoutPanel

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

ThemeClassName

Declaration
public override string ThemeClassName { get; set; }
Property Value
System.String

Overrides

ToolTabsAlignment

Gets or sets the alignment of the TabStripElement in all ToolTabStrip instances.

Declaration
public TabStripAlignment ToolTabsAlignment { get; set; }
Property Value
TabStripAlignment

ToolTabsTextOrientation

Gets or sets the text orientation of the TabStripElement in all ToolTabStrip instances.

Declaration
public TabStripTextOrientation ToolTabsTextOrientation { get; set; }
Property Value
TabStripTextOrientation

ToolTabsVisible

Determines whether the TabStripElement in ToolTabStrip instances is visible.

Declaration
public bool ToolTabsVisible { get; set; }
Property Value
System.Boolean

ToolWindowInsertOrder

Gets or sets the insert order to be used when adding dock windows to a ToolTabStrip.

Declaration
public DockWindowInsertOrder ToolWindowInsertOrder { get; set; }
Property Value
DockWindowInsertOrder

XmlSerializationInfo

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.

Declaration
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }
Property Value
ComponentXmlSerializationInfo

Methods

ActivateMdiChild(Form)

Activates the MDI child of a form.

Declaration
public void ActivateMdiChild(Form form)
Parameters
System.Windows.Forms.Form form

The child form to activate.

ActivateWindow(DockWindow)

Activates the specified DockWindow and gives it the keyboard focus.

Declaration
public bool ActivateWindow(DockWindow window)
Parameters
DockWindow window

Returns
System.Boolean

ActivateWindow(DockWindow, Boolean)

Activates the specified window and gives it the keyboard focus.

Declaration
protected virtual bool ActivateWindow(DockWindow window, bool forceNotify)
Parameters
DockWindow window

System.Boolean forceNotify

True to force ActiveWindowChanging and ActiveWindowChanged notifications, false otherwise. Sometimes a transaction may change the current active window several times and the method needs to know when to raise the notifications.
Returns
System.Boolean

AddDocument(DockWindow)

Adds the specified DockWindow instance to the main document tab strip.

Declaration
public void AddDocument(DockWindow dockWindow)
Parameters
DockWindow dockWindow

The dock window.

AddDocument(DockWindow, DockPosition)

Adds the the specified DockWindow instance at the specified dock position, aligned with the main document tabstrip.

Declaration
public void AddDocument(DockWindow dockWindow, DockPosition position)
Parameters
DockWindow dockWindow

The dock window.
DockPosition position

The desired dock position.

AddDocument(DockWindow, DockWindow, DockPosition)

Adds the the specified DockWindow instance to the specified DocumentTabStrip instance.

Declaration
public void AddDocument(DockWindow dockWindow, DockWindow target, DockPosition position)
Parameters
DockWindow dockWindow

The dock window.
DockWindow target

The target of the dock opeation.
DockPosition position

The desired dock position.

AddDocument(DockWindow, DocumentTabStrip, DockPosition)

Adds the specified DockWindow instance to a new DocumentTabStrip instance.

Declaration
public void AddDocument(DockWindow dockWindow, DocumentTabStrip tabStrip, DockPosition position)
Parameters
DockWindow dockWindow

The dock window.
DocumentTabStrip tabStrip

The DocumentTabStrip, which is the target of the operation.
DockPosition position

The position.

AddDocuments(DockWindow[], DocumentTabStrip, DockPosition)

Adds a collection of DockWindows to a new DocumentTabStrip instance.

Declaration
public void AddDocuments(DockWindow[] dockWindows, DocumentTabStrip tabStrip, DockPosition position)
Parameters
DockWindow[] dockWindows

The dock windows.
DocumentTabStrip tabStrip

The DocumentTabStrip, which is the target of the operation.
DockPosition position

The position.

ApplySplitterWidth(Int32)

Declaration
public override void ApplySplitterWidth(int splitterWidth)
Parameters
System.Int32 splitterWidth

Overrides

AutoHideWindow(DockWindow)

Makes the specified DockWindow auto-hidden.

Declaration
public void AutoHideWindow(DockWindow window)
Parameters
DockWindow window

AutoHideWindows(IEnumerable<DockWindow>, AutoHidePosition)

Makes the specified DockWindow collection auto-hidden.

Declaration
public void AutoHideWindows(IEnumerable<DockWindow> windows, AutoHidePosition position)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

AutoHidePosition position

The edge at which the windows should be auto-hidden against.

BeginInit()

Declaration
public override void BeginInit()
Overrides

BeginTransactionBlock()

Opens a transaction (batch) operation. This is used by the framework to indicate some lengthy operations, during which no updates should be performed.

Declaration
public void BeginTransactionBlock()

BeginTransactionBlock(Boolean)

Opens a transaction (batch) operation. This is used by the framework to indicate some lengthy operations, during which no updates should be performed.

Declaration
public void BeginTransactionBlock(bool saveActiveWindow)
Parameters
System.Boolean saveActiveWindow

BeginUpdate()

Begins an update operation. Internally used by the transaction mechanism.

Declaration
public void BeginUpdate()

CallOnControlTreeChanged(ControlTreeChangedEventArgs)

Calls the OnControlTreeChanged method. This method is used internally.

Declaration
public virtual void CallOnControlTreeChanged(ControlTreeChangedEventArgs args)
Parameters
ControlTreeChangedEventArgs args

CanChangeWindowState(DockWindow, DockState)

Determines whether the provided dock state may be applied to the specified DockWindow.

Declaration
public bool CanChangeWindowState(DockWindow window, DockState state)
Parameters
DockWindow window

DockState state

Returns
System.Boolean

CanChangeWindowState(DockWindow, DockState, Boolean)

Determines whether the specified window's DockState value can be changed to the specified new one.

Declaration
protected virtual bool CanChangeWindowState(DockWindow window, DockState state, bool raiseChanging)
Parameters
DockWindow window

The window, which should be examined.
DockState state

The new target state.
System.Boolean raiseChanging

True to raise DockStateChanging notification, false otherwise.
Returns
System.Boolean

True if the state can be changed, false otherwise.

CleanUp()

Performs a clean-up pass which removes all unnecessary internally created split panels and/or collapses or disposes them.

Declaration
public void CleanUp()

CloseAllWindows()

Calls the Close method for all currently registered windows, using each window's CloseAction.

Declaration
public bool CloseAllWindows()
Returns
System.Boolean

[true] if all windows were successfully closed, [false] otherwise

CloseAutoHidePopup()

Closes the popup of the currently opened auto-hide window.

Declaration
public void CloseAutoHidePopup()

CloseWindow(DockWindow)

Removes or hides (depending on the CloseAction) the specified window.

Declaration
public void CloseWindow(DockWindow window)
Parameters
DockWindow window

CloseWindows(IEnumerable<DockWindow>)

Removes or hides (depending on the CloseAction) the specified windows.

Declaration
public void CloseWindows(IEnumerable<DockWindow> windows)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

CommitTransaction(RadDockTransaction)

Commits the specified transaction.

Declaration
protected virtual void CommitTransaction(RadDockTransaction transaction)
Parameters
RadDockTransaction transaction

Contains(String)

Determines whether a DockWindow instance with the specified name is registered with this RadDock instance.

Declaration
public bool Contains(string name)
Parameters
System.String name

Returns
System.Boolean

Contains(DockWindow)

Determines whether the specified DockWindow is registered with this RadDock instances.

Declaration
public bool Contains(DockWindow dockWindow)
Parameters
DockWindow dockWindow

Returns
System.Boolean

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateDefaultTabStrip(DockType)

Creates and returns the default DockTabStrip for a given DockType.

Declaration
public DockTabStrip CreateDefaultTabStrip(DockType type)
Parameters
DockType type

Returns
DockTabStrip

CreateLayoutStrategy()

Creates new SplitContainerLayoutStrategy instance. Allows inheritors to provide custom type.

Declaration
protected virtual SplitContainerLayoutStrategy CreateLayoutStrategy()
Returns
SplitContainerLayoutStrategy

CreateXmlWriterSettings()

Creates the core XmlWritterSettings to be used by the serialization manager.

Declaration
protected virtual XmlWriterSettings CreateXmlWriterSettings()
Returns
System.Xml.XmlWriterSettings

DisplayQuickNavigator()

Visualizes the QuickNavigator control allowing for active tool windows and documents browsing.

Declaration
public QuickNavigator DisplayQuickNavigator()
Returns
QuickNavigator

The QuickNavigator instance that is currently displayed. May return null if operation was unsuccessful.

DisplayWindow(DockWindow)

Displays the specified window if was previously hidden.

Declaration
public void DisplayWindow(DockWindow window)
Parameters
DockWindow window

DisplayWindows(IEnumerable<DockWindow>)

Displays the provided dock windows if they were previously hidden and are registered with this RadDock instance.

Declaration
public void DisplayWindows(IEnumerable<DockWindow> windows)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

DockControl(Control, DockPosition)

Registers the specified control as part of the docking framework.

Declaration
public HostWindow DockControl(Control control, DockPosition position)
Parameters
System.Windows.Forms.Control control

DockPosition position

Returns
HostWindow

DockControl(Control, DockPosition, DockType)

Registers the specified control as part of the docking framework.

Declaration
public HostWindow DockControl(Control control, DockPosition position, DockType dockType)
Parameters
System.Windows.Forms.Control control

DockPosition position

DockType dockType

Returns
HostWindow

DockControl(Control, DockTabStrip, DockPosition)

Registers the specified control as part of the docking framework.

Declaration
public HostWindow DockControl(Control control, DockTabStrip dockAnchor, DockPosition position)
Parameters
System.Windows.Forms.Control control

DockTabStrip dockAnchor

DockPosition position

Returns
HostWindow

DockControl(Control, DockTabStrip, DockPosition, DockType)

Registers the specified control as part of the docking framework.

Declaration
public HostWindow DockControl(Control control, DockTabStrip dockAnchor, DockPosition position, DockType dockType)
Parameters
System.Windows.Forms.Control control

DockTabStrip dockAnchor

DockPosition position

DockType dockType

Returns
HostWindow

DockControl(Control, DockWindow, DockPosition)

Registers the specified control as part of the docking framework.

Declaration
public HostWindow DockControl(Control control, DockWindow target, DockPosition position)
Parameters
System.Windows.Forms.Control control

DockWindow target

DockPosition position

Returns
HostWindow

DockControl(Control, DockWindow, DockPosition, DockType)

Registers the specified control as part of the docking framework.

Declaration
public HostWindow DockControl(Control control, DockWindow target, DockPosition position, DockType dockType)
Parameters
System.Windows.Forms.Control control

DockWindow target

DockPosition position

DockType dockType

Returns
HostWindow

DockWindow(DockWindow, DockPosition)

Registers the specified DockWindow instance and docks it at the desired psotion.

Declaration
public void DockWindow(DockWindow dockWindow, DockPosition position)
Parameters
DockWindow dockWindow

DockPosition position

DockWindow(DockWindow, DockWindow, DockPosition)

Registers the specified DockWindow instance and docks it at the desired psotion, using the provided target window as an anchor.

Declaration
public void DockWindow(DockWindow dockWindow, DockWindow target, DockPosition position)
Parameters
DockWindow dockWindow

DockWindow target

DockPosition position

DockWindow(DockWindow, SplitPanel, DockPosition)

Registers the specified DockWindow instance and docks it at the desired position, using the provided SplitPanel as an anchor.

Declaration
public void DockWindow(DockWindow window, SplitPanel dockAnchor, DockPosition position)
Parameters
DockWindow window

SplitPanel dockAnchor

Any split panel instance that resides

DockPosition position

EndInit()

Declaration
public override void EndInit()
Overrides

EndTransactionBlock()

Ends previously opened transaction. Optionally preforms update.

Declaration
public void EndTransactionBlock()

EndUpdate()

Ends a BeginUpdate block.

Declaration
public void EndUpdate()

EndUpdate(Boolean)

Ends a BeginUpdate block and optionally performs update.

Declaration
public void EndUpdate(bool update)
Parameters
System.Boolean update

EnqueueTransaction(RadDockTransaction)

Adds the

Declaration
public void EnqueueTransaction(RadDockTransaction transaction)
Parameters
RadDockTransaction transaction

EnsureInitialized()

This method is used internally.

Declaration
public void EnsureInitialized()

EnumFrameworkControls<T>()

Enumerates all currently alive T instances available within the framework.

Declaration
public IEnumerable<T> EnumFrameworkControls<T>()
    where T : Control
Returns
System.Collections.Generic.IEnumerable<T>

Type Parameters
T

FloatToolTabStrip(ToolTabStrip, Rectangle)

Makes the specified tool tab strip floating.

Declaration
public void FloatToolTabStrip(ToolTabStrip strip, Rectangle bounds)
Parameters
ToolTabStrip strip

System.Drawing.Rectangle bounds

The desired floating bounds. Pass Rectangle.Empty to set the default bounds.

FloatWindow(DockWindow)

Makes the specified window floating.

Declaration
public void FloatWindow(DockWindow window)
Parameters
DockWindow window

FloatWindow(DockWindow, Rectangle)

Makes the specified window floating, using the provided bounds.

Declaration
public void FloatWindow(DockWindow window, Rectangle bounds)
Parameters
DockWindow window

System.Drawing.Rectangle bounds

The desired floating bounds. Pass Rectangle.Empty to set the default bounds.

FloatWindows(IEnumerable<DockWindow>, Rectangle)

Makes the specified windows floating, using the provided bounds.

Declaration
public void FloatWindows(IEnumerable<DockWindow> windows, Rectangle bounds)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

System.Drawing.Rectangle bounds

The desired floating bounds. Pass Rectangle.Empty to set the default bounds.

FloatWindows(IEnumerable<DockWindow>, Rectangle, DockType)

Makes the specified windows floating, using the provided bounds.

Declaration
public void FloatWindows(IEnumerable<DockWindow> windows, Rectangle bounds, DockType containerType)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

System.Drawing.Rectangle bounds

The desired floating bounds. Pass Rectangle.Empty to set the default bounds.
DockType containerType

The type of the container inside the floating form - ToolWindow or DocumentWindow.

FlushTransactions()

Commits all pending transactions without exitting the transaction block.

Declaration
public void FlushTransactions()

GetAutoHideTab(DockWindow)

Gets the auto hide tab item.

Declaration
public TabStripItem GetAutoHideTab(DockWindow dockWindow)
Parameters
DockWindow dockWindow

The dock window.
Returns
TabStripItem

GetAutoHideTabStrip(AutoHidePosition)

Gets the auto hide tab strip.

Declaration
public RadPageViewStripElement GetAutoHideTabStrip(AutoHidePosition position)
Parameters
AutoHidePosition position

The position.
Returns
RadPageViewStripElement

GetDefaultDocumentTabStrip(Boolean)

Gets the default DocumentTabStrip instance, used to add documents without explicitly specified dock target.

Declaration
public DocumentTabStrip GetDefaultDocumentTabStrip(bool createNew)
Parameters
System.Boolean createNew

True to create a new DocumentTabStrip instance and add it to the document container.
Returns
DocumentTabStrip

GetDefaultXmlSerializationInfo()

Gets the default serialization info for RadDock used by Save/Load loyout methods to persist grid settings to/from XML.

Declaration
public virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
Returns
ComponentXmlSerializationInfo

Remarks

You can use the serialization info to include/exclude properties of RadDock and related objects from XML serialization.

GetHostWindow(Control)

Get the host window for Control instance docked with DockControl method or for MDI children Form object

Declaration
public HostWindow GetHostWindow(Control control)
Parameters
System.Windows.Forms.Control control

Returns
HostWindow

found HostWindow instance or null

GetNextDocumentStrip(DockWindow)

Gets the next document tab strip, regarding the specified DockWindow. The window should be in TabbedDocument state for the method to work.

Declaration
public DocumentTabStrip GetNextDocumentStrip(DockWindow window)
Parameters
DockWindow window

Returns
DocumentTabStrip

GetPreviousDocumentStrip(DockWindow)

Gets the previous document tab strip, regarding the specified DockWindow. The window should be in TabbedDocument state for the method to work.

Declaration
public DocumentTabStrip GetPreviousDocumentStrip(DockWindow window)
Parameters
DockWindow window

Returns
DocumentTabStrip

GetService<T>()

Retrieves currently registered RadDockService by the specified type.

Declaration
public T GetService<T>()
    where T : RadDockService
Returns
T

Type Parameters
T

GetService<T>(Int32)

Retrieves currently registered Service by the provided key. All predefined service keys may be found in ServiceConstants class.

Declaration
protected T GetService<T>(int key)
    where T : RadDockService
Parameters
System.Int32 key

Returns
T

Type Parameters
T

GetSplitterElementAtPoint(Point)

Declaration
public override SplitterElement GetSplitterElementAtPoint(Point clientPoint)
Parameters
System.Drawing.Point clientPoint

Returns
SplitterElement

Overrides

GetWindow<T>(String)

Gets DockWindow instance with the corresponding Name by the specified type.

Declaration
public T GetWindow<T>(string dockWindowName)
    where T : DockWindow
Parameters
System.String dockWindowName

Returns
T

DockWindow instance with matching Name. Null (Nothing in VB.NET) otherwise.
Type Parameters
T

GetWindows(Type[])

Gets the windows by the specified types.

Declaration
public IEnumerable<DockWindow> GetWindows(params Type[] types)
Parameters
System.Type[] types

The types of the windows to get.
Returns
System.Collections.Generic.IEnumerable<DockWindow>

GetWindows<T>()

Gets the windows by the specified type.

Declaration
public IEnumerable<T> GetWindows<T>()
    where T : DockWindow
Returns
System.Collections.Generic.IEnumerable<T>

Type Parameters
T

IsNameAvailable(String)

Declaration
protected virtual bool IsNameAvailable(string name)
Parameters
System.String name

Returns
System.Boolean

LoadFromXml(Stream, Boolean)

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.

Declaration
public void LoadFromXml(Stream stream, bool clearDocking = false)
Parameters
System.IO.Stream stream

The stream.
System.Boolean clearDocking

if set to true removes the existing dock windows using the CloseAndDispose action.

LoadFromXml(TextReader, Boolean)

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.

Declaration
public void LoadFromXml(TextReader textReader, bool clearDocking = false)
Parameters
System.IO.TextReader textReader

The text reader.
System.Boolean clearDocking

if set to true removes the existing dock windows using the CloseAndDispose action.

LoadFromXml(String, Boolean)

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.

Declaration
public void LoadFromXml(string fileName, bool clearDocking = false)
Parameters
System.String fileName

Name of the file.
System.Boolean clearDocking

if set to true removes the existing dock windows using the CloseAndDispose action.

LoadFromXmlCore(XmlReader, Boolean, Boolean)

Overrwrite this method to change the loading of docking layout configuration.

Declaration
protected virtual void LoadFromXmlCore(XmlReader reader, bool oldXmlFormat, bool clearDocking = false)
Parameters
System.Xml.XmlReader reader

The XmlReader instance that will be used to load the layoiut configuration.
System.Boolean oldXmlFormat

if set to true the layout configuration is in the old DockingManager format.
System.Boolean clearDocking

if set to true removes the existing dock windows using the CloseAndDispose action.

MoveToNextDocumentTabStrip(DockWindow)

Move DockWindow to next document tab strip if exist when DockWindow is in document mode

Declaration
public bool MoveToNextDocumentTabStrip(DockWindow dockWindow)
Parameters
DockWindow dockWindow

Returns
System.Boolean

MoveToPreviousDocumentTabStrip(DockWindow)

Move DockWindow to previuos document tab strip if exist when DockWindow is in document mode

Declaration
public bool MoveToPreviousDocumentTabStrip(DockWindow dockWindow)
Parameters
DockWindow dockWindow

Returns
System.Boolean

OnActiveWindowChanged(DockWindowEventArgs)

Raises the ActiveWindowChanged event.

Declaration
protected virtual void OnActiveWindowChanged(DockWindowEventArgs e)
Parameters
DockWindowEventArgs e

OnActiveWindowChanging(DockWindowCancelEventArgs)

Raises the ActiveWindowChanging event.

Declaration
protected virtual void OnActiveWindowChanging(DockWindowCancelEventArgs e)
Parameters
DockWindowCancelEventArgs e

OnAutoHideButtonClicked(ToolTabStrip)

An Auto-hide button click notification, received from a registered ToolTabStrip.

Declaration
protected virtual void OnAutoHideButtonClicked(ToolTabStrip strip)
Parameters
ToolTabStrip strip

OnAutoHideWindowDisplayed(DockWindowEventArgs)

Raises the AutoHideWindowDisplayed event.

Declaration
protected virtual void OnAutoHideWindowDisplayed(DockWindowEventArgs e)
Parameters
DockWindowEventArgs e

OnAutoHideWindowDisplaying(AutoHideWindowDisplayingEventArgs)

Raises the AutoHideWindowDisplaying event.

Declaration
protected virtual void OnAutoHideWindowDisplaying(AutoHideWindowDisplayingEventArgs e)
Parameters
AutoHideWindowDisplayingEventArgs e

OnAutoHideWindowHidden(DockWindowEventArgs)

Raises the AutoHideWindowHidden event.

Declaration
protected virtual void OnAutoHideWindowHidden(DockWindowEventArgs e)
Parameters
DockWindowEventArgs e

OnAutoHideWindowHiding(DockWindowCancelEventArgs)

Raises the AutoHideWindowHiding event.

Declaration
protected virtual void OnAutoHideWindowHiding(DockWindowCancelEventArgs e)
Parameters
DockWindowCancelEventArgs e

OnBackgroundImageChanged(EventArgs)

Declaration
protected override void OnBackgroundImageChanged(EventArgs e)
Parameters
System.EventArgs e

OnControlTreeChanged(ControlTreeChangedEventArgs)

Declaration
protected override void OnControlTreeChanged(ControlTreeChangedEventArgs args)
Parameters
ControlTreeChangedEventArgs args

Overrides

OnDockStateChanged(DockWindowEventArgs)

Raises the DockStateChanged event.

Declaration
protected virtual void OnDockStateChanged(DockWindowEventArgs e)
Parameters
DockWindowEventArgs e

OnDockStateChanging(DockStateChangingEventArgs)

Raises the DockStateChanging event.

Declaration
protected virtual void OnDockStateChanging(DockStateChangingEventArgs e)
Parameters
DockStateChangingEventArgs e

OnDockStateContextMenuClicked(DockWindow, DockState)

Recieves a notification for a change state request, made from the window's associated context menu.

Declaration
protected virtual void OnDockStateContextMenuClicked(DockWindow window, DockState newState)
Parameters
DockWindow window

DockState newState

OnDockWindowAdded(DockWindowEventArgs)

Raises the DockWindowAdded event.

Declaration
protected virtual void OnDockWindowAdded(DockWindowEventArgs e)
Parameters
DockWindowEventArgs e

OnDockWindowClosed(DockWindowEventArgs)

Raises the DockWindowClosed event.

Declaration
protected virtual void OnDockWindowClosed(DockWindowEventArgs e)
Parameters
DockWindowEventArgs e

OnDockWindowClosing(DockWindowCancelEventArgs)

Raises the DockWindowClosing event.

Declaration
protected virtual void OnDockWindowClosing(DockWindowCancelEventArgs e)
Parameters
DockWindowCancelEventArgs e

OnDockWindowNameChanged(DockWindow, String)

The manager gets notified for a change in the specified DockWindow instance Name property.

Declaration
protected virtual void OnDockWindowNameChanged(DockWindow dockWindow, string oldName)
Parameters
DockWindow dockWindow

The DockWindow which name has changed.
System.String oldName

The window's previous name.

OnDockWindowRemoved(DockWindowEventArgs)

Raises the DockWindowRemoved event.

Declaration
protected virtual void OnDockWindowRemoved(DockWindowEventArgs e)
Parameters
DockWindowEventArgs e

OnDockWindowSerializing(DockWindow)

Raises the DockWindowSerializing event.

Declaration
protected virtual bool OnDockWindowSerializing(DockWindow dockWindow)
Parameters
DockWindow dockWindow

Returns
System.Boolean

[true] if canceled, [false] otherwise.

OnEnabledChanged(EventArgs)

Declaration
protected override void OnEnabledChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnFloatingWindowCreated(FloatingWindowEventArgs)

Raises the FloatingWindowCreated event.

Declaration
protected virtual void OnFloatingWindowCreated(FloatingWindowEventArgs e)
Parameters
FloatingWindowEventArgs e

OnHandleCreated(EventArgs)

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
System.EventArgs e

OnHandleDestroyed(EventArgs)

Declaration
protected override void OnHandleDestroyed(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnLoad(Size)

Called when control's creation is complete.

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnLoadedFromXml()

Raises the LoadedFromXml event.

Declaration
protected virtual void OnLoadedFromXml()

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnPaddingChanged(EventArgs)

Declaration
protected override void OnPaddingChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnParentChanged(EventArgs)

Declaration
protected override void OnParentChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnParentVisibleChanged(EventArgs)

Declaration
protected override void OnParentVisibleChanged(EventArgs e)
Parameters
System.EventArgs e

OnQuickNavigatorSnapshotNeeded(DockWindowSnapshotEventArgs)

Raises the QuickNavigatorSnapshotNeeded event.

Declaration
protected virtual void OnQuickNavigatorSnapshotNeeded(DockWindowSnapshotEventArgs e)
Parameters
DockWindowSnapshotEventArgs e

OnSavedToXml()

Raises the SavedToXml event.

Declaration
protected virtual void OnSavedToXml()

OnSelectedTabChanged(SelectedTabChangedEventArgs)

Declaration
protected virtual void OnSelectedTabChanged(SelectedTabChangedEventArgs e)
Parameters
SelectedTabChangedEventArgs e

OnSelectedTabChanging(SelectedTabChangingEventArgs)

Declaration
protected virtual void OnSelectedTabChanging(SelectedTabChangingEventArgs e)
Parameters
SelectedTabChangingEventArgs e

OnTabStripItemDoubleClick(TabStripItem, DockTabStrip)

Declaration
protected virtual void OnTabStripItemDoubleClick(TabStripItem item, DockTabStrip strip)
Parameters
TabStripItem item

DockTabStrip strip

OnThemeChanged()

Delegates the ThemeChanged event to all owned controls and elements.

Declaration
protected override void OnThemeChanged()
Overrides

OnToolTabStripDoubleClick(ToolTabStrip, Point)

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.

Declaration
protected virtual void OnToolTabStripDoubleClick(ToolTabStrip strip, Point click)
Parameters
ToolTabStrip strip

System.Drawing.Point click

OnTransactionBlockEnded(EventArgs)

Raises the TransactionBlockEnded event.

Declaration
protected virtual void OnTransactionBlockEnded(EventArgs e)
Parameters
System.EventArgs e

OnTransactionBlockStarted(EventArgs)

Raises the TransactionBlockStarted event.

Declaration
protected virtual void OnTransactionBlockStarted(EventArgs e)
Parameters
System.EventArgs e

OnTransactionCommitted(RadDockTransactionEventArgs)

Raises the TransactionCommitted event.

Declaration
protected virtual void OnTransactionCommitted(RadDockTransactionEventArgs e)
Parameters
RadDockTransactionEventArgs e

OnTransactionCommitting(RadDockTransactionCancelEventArgs)

Raises the TransactionCommitting event.

Declaration
protected virtual void OnTransactionCommitting(RadDockTransactionCancelEventArgs e)
Parameters
RadDockTransactionCancelEventArgs e

OnVisibleChanged(EventArgs)

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

PerformUpdate()

Performs the core update logic after an EndUpdate call.

Declaration
protected virtual void PerformUpdate()

PostCommitTransaction(RadDockTransaction)

Allows inheritors to provide additional post-commit processing of a transaction.

Declaration
protected virtual void PostCommitTransaction(RadDockTransaction transaction)
Parameters
RadDockTransaction transaction

PreCommitTransaction(RadDockTransaction)

Allows inheritors to provide additional pre-commit processing of a transaction.

Declaration
protected virtual void PreCommitTransaction(RadDockTransaction transaction)
Parameters
RadDockTransaction transaction

ProcessFocusRequested(RadElement)

Declaration
protected override bool ProcessFocusRequested(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

RegisterService(Int32, RadDockService)

Registers the specified service with ourselves.

Declaration
public void RegisterService(int key, RadDockService service)
Parameters
System.Int32 key

RadDockService service

RemoveAllDocumentWindows()

Removes all DocumentWindows, without disposing it.

Declaration
public void RemoveAllDocumentWindows()

RemoveAllDocumentWindows(DockWindowCloseAction)

Removes all DocumentWindows, using the specified close action.

Declaration
public void RemoveAllDocumentWindows(DockWindowCloseAction closeAction)
Parameters
DockWindowCloseAction closeAction

The action to be taken when closing a window.

RemoveAllToolWindows(DockWindowCloseAction, AllowedDockState)

Removes all ToolWindows with the specified DockState, using the specified close action.

Declaration
public void RemoveAllToolWindows(DockWindowCloseAction closeAction = DockWindowCloseAction.Close, AllowedDockState allowedDockState = AllowedDockState.Docked | AllowedDockState.AutoHide)
Parameters
DockWindowCloseAction closeAction

The action to be taken when closing a window.
AllowedDockState allowedDockState

Specifies the DockState of the ToolWindows that will be removed. The enumeration flags can be combined.

RemoveAllWindows()

Removes all DockWindows, without disposing them.

Declaration
public void RemoveAllWindows()

RemoveAllWindows(DockWindowCloseAction)

Removes all DockWindows, using the specified close action.

Declaration
public void RemoveAllWindows(DockWindowCloseAction closeAction)
Parameters
DockWindowCloseAction closeAction

The action to be taken when closing a window.

RemoveWindow(DockWindow)

Removes the specified window, without disposing it, from the dock manager.

Declaration
public void RemoveWindow(DockWindow window)
Parameters
DockWindow window

RemoveWindow(DockWindow, DockWindowCloseAction)

Removes the specified window, using the specified DockWindowCloseAction.

Declaration
public void RemoveWindow(DockWindow window, DockWindowCloseAction closeAction)
Parameters
DockWindow window

DockWindowCloseAction closeAction

The desired action to be taken.

RestoreWindowsStatesAfterLoad()

This method is used internally.

Declaration
public void RestoreWindowsStatesAfterLoad()

RestoreWindowsStatesAfterLoad(Boolean)

This method is used internally.

Declaration
public void RestoreWindowsStatesAfterLoad(bool beginInitWindows)
Parameters
System.Boolean beginInitWindows

SaveToXml(Stream)

Saves the docking layout configuration in an XML format in the specified stream.

Declaration
public void SaveToXml(Stream stream)
Parameters
System.IO.Stream stream

The stream.

SaveToXml(TextWriter)

Saves the docking layout configuration in an XML format in the specified TextWriter.

Declaration
public void SaveToXml(TextWriter textWriter)
Parameters
System.IO.TextWriter textWriter

The text writer.

SaveToXml(String)

Saves the docking layout configuration in an XML format in the specified file.

Declaration
public void SaveToXml(string fileName)
Parameters
System.String fileName

Name of the file.

SaveToXmlCore(XmlWriter)

Performs the core save logic.

Declaration
protected virtual void SaveToXmlCore(XmlWriter writer)
Parameters
System.Xml.XmlWriter writer

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
System.Int32 x

System.Int32 y

System.Int32 width

System.Int32 height

System.Windows.Forms.BoundsSpecified specified

Overrides

SetWindowState(DockWindow, DockState)

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.

Declaration
public void SetWindowState(DockWindow window, DockState state)
Parameters
DockWindow window

DockState state

ShouldProcessNotification()

This method is used internally.

Declaration
public bool ShouldProcessNotification()
Returns
System.Boolean

ShowAutoHidePopup(HostWindow)

Declaration
public void ShowAutoHidePopup(HostWindow window)
Parameters
HostWindow window

ShowAutoHidePopup(ToolWindow)

Declaration
public void ShowAutoHidePopup(ToolWindow window)
Parameters
ToolWindow window

UpdateBackgroundSettings()

Declaration
protected void UpdateBackgroundSettings()

UpdateCollapsed()

Declaration
public override void UpdateCollapsed()
Overrides

Events

ActiveWindowChanged

Notifies for an actual change of the ActiveWindow property.

Declaration
public event DockWindowEventHandler ActiveWindowChanged
Event Type
DockWindowEventHandler

ActiveWindowChanging

Notifies for an upcomming change of the ActiveWindow property. Cancelable.

Declaration
public event DockWindowCancelEventHandler ActiveWindowChanging
Event Type
DockWindowCancelEventHandler

AutoHideWindowDisplayed

Notifies that an auto-hidden window is about to be displayed. Cancelable.

Declaration
public event DockWindowEventHandler AutoHideWindowDisplayed
Event Type
DockWindowEventHandler

AutoHideWindowDisplaying

Notifies that an auto-hidden window is about to be displayed. Cancelable.

Declaration
public event AutoHideWindowDisplayingEventHandler AutoHideWindowDisplaying
Event Type
AutoHideWindowDisplayingEventHandler

AutoHideWindowHidden

Notifies that a window which DockState is AutoHide has been hidden.

Declaration
public event DockWindowEventHandler AutoHideWindowHidden
Event Type
DockWindowEventHandler

AutoHideWindowHiding

Notifies that a window with AutoHide DockState is hiding.

Declaration
public event DockWindowCancelEventHandler AutoHideWindowHiding
Event Type
DockWindowCancelEventHandler

DockStateChanged

Notifies for a change in the DockState of the associated window.

Declaration
public event DockWindowEventHandler DockStateChanged
Event Type
DockWindowEventHandler

DockStateChanging

Notifies for an upcomming change in the DockState of the associated window. Cancelable.

Declaration
public event DockStateChangingEventHandler DockStateChanging
Event Type
DockStateChangingEventHandler

DockTabStripNeeded

Raised whenever a new DockTabStrip instance is needed internally by the framework. Allows for providing custom ToolTabStrip and DocumentTabStrip implementations.

Declaration
public event DockTabStripNeededEventHandler DockTabStripNeeded
Event Type
DockTabStripNeededEventHandler

DockWindowAdded

Notifies for a new DockWindow registered with this RadDock instance.

Declaration
public event DockWindowEventHandler DockWindowAdded
Event Type
DockWindowEventHandler

DockWindowClosed

Raised after a DockWindow has been closed.

Declaration
public event DockWindowEventHandler DockWindowClosed
Event Type
DockWindowEventHandler

DockWindowClosing

Raised before a DockWindow.Close method is called.

Declaration
public event DockWindowCancelEventHandler DockWindowClosing
Event Type
DockWindowCancelEventHandler

DockWindowRemoved

Notifies for a DockWindow removed from this RadDock instance. This event will not be raised for hidden windows.

Declaration
public event DockWindowEventHandler DockWindowRemoved
Event Type
DockWindowEventHandler

DockWindowSerializing

Fired when a dock window is being serialized. Allows excluding some windows from serialization.

Declaration
public event EventHandler<DockWindowCancelEventArgs> DockWindowSerializing
Event Type
System.EventHandler<DockWindowCancelEventArgs>

FloatingWindowCreated

Notifies that a FloatingWindow instance is internally created by the framework. Allows listeners to examine and optionally change the window itself.

Declaration
public event FloatingWindowEventHandler FloatingWindowCreated
Event Type
FloatingWindowEventHandler

LoadedFromXml

Notifies that manager's state has been loaded from an external XML source.

Declaration
public event EventHandler LoadedFromXml
Event Type
System.EventHandler

PageViewInstanceCreated

Fires after RadPageViewElement is created.

Declaration
public event PageViewInstanceCreatedEventHandler PageViewInstanceCreated
Event Type
PageViewInstanceCreatedEventHandler

QuickNavigatorSnapshotNeeded

Raised when the QuickNavigator is displayed and a preview snapshot for the currently selected window is needed.

Declaration
public event DockWindowSnapshotEventHandler QuickNavigatorSnapshotNeeded
Event Type
DockWindowSnapshotEventHandler

SavedToXml

Notifies that manager's state has been saved to an external XML source.

Declaration
public event EventHandler SavedToXml
Event Type
System.EventHandler

SelectedTabChanged

Occurs when selected tab changed in currently manipulated DockTabStrip.

Declaration
public event SelectedTabChangedEventHandler SelectedTabChanged
Event Type
SelectedTabChangedEventHandler

SelectedTabChanging

Occurs when selected tab changing in currently manipulated DockTabStrip.

Declaration
public event SelectedTabChangingEventHandler SelectedTabChanging
Event Type
SelectedTabChangingEventHandler

SplitContainerNeeded

Raised whenever a new RadSplitContainer instance is needed internally by the framework. Allows for providing custom RadSplitContainer implementation.

Declaration
public event SplitContainerNeededEventHandler SplitContainerNeeded
Event Type
SplitContainerNeededEventHandler

TransactionBlockEnded

Notifies for a successful EndTransactionBlock operation, when all transactions are committed, the DockTree is cleaned, and updates are resumed.

Declaration
public event EventHandler TransactionBlockEnded
Event Type
System.EventHandler

TransactionBlockStarted

Notifies for a successful BeginTransactionBlock operation.

Declaration
public event EventHandler TransactionBlockStarted
Event Type
System.EventHandler

TransactionCommitted

Raised when a RadDockTransaction is successfully committed. Allows listeners to perform some additional operations.

Declaration
public event RadDockTransactionEventHandler TransactionCommitted
Event Type
RadDockTransactionEventHandler

TransactionCommitting

Raised when a RadDockTransaction is about to be committed. Allows listeners to investigate the transaction, perform some additional actions and/or cancel it.

Declaration
public event RadDockTransactionCancelEventHandler TransactionCommitting
Event Type
RadDockTransactionCancelEventHandler

Explicit Interface Implementations

IMessageListener.DesiredHook

Declaration
InstalledHook IMessageListener.DesiredHook { get; }
Returns
InstalledHook

Implements

IMessageListener.PreviewMessage(ref Message)

Declaration
MessagePreviewResult IMessageListener.PreviewMessage(ref Message msg)
Parameters
System.Windows.Forms.Message msg

Returns
MessagePreviewResult

Implements

IMessageListener.PreviewSystemMessage(SystemMessage, Message)

Declaration
void IMessageListener.PreviewSystemMessage(SystemMessage message, Message msg)
Parameters
SystemMessage message

System.Windows.Forms.Message msg

Implements

IMessageListener.PreviewWndProc(Message)

Declaration
void IMessageListener.PreviewWndProc(Message msg)
Parameters
System.Windows.Forms.Message msg

Implements

ILoadObsoleteDockingManagerXml.DockableDeserialized

Declaration
event EventHandler<DockableDeserializedEventArgs> ILoadObsoleteDockingManagerXml.DockableDeserialized
Returns
System.EventHandler<DockableDeserializedEventArgs>

Implements

ILoadObsoleteDockingManagerXml.LoadDockingManagerXml(TextReader)

Declaration
void ILoadObsoleteDockingManagerXml.LoadDockingManagerXml(TextReader input)
Parameters
System.IO.TextReader input

Implements

Extension Methods