Documentation

Class DockWindow

Base class for all tool and document windows available per RadDock instance. Implements the IDockWindow interface.

Inheritance
System.Object
TabPanel
DockWindow
DockWindowPlaceholder
DocumentWindow
HostWindow
ToolWindow
Inherited Members
Namespace: Telerik.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock.dll

Syntax

public abstract class DockWindow : TabPanel, INotifyPropertyChanged, IDockWindow

Constructors

DockWindow()

Initializes a new DockWindow instance.

Declaration
public DockWindow()

DockWindow(DockState, DockState)

Declaration
protected DockWindow(DockState dockState, DockState previousDockState)
Parameters
DockState dockState

DockState previousDockState

Fields

forceDesiredDockStateSerialization

This field is used internally.

Declaration
public bool forceDesiredDockStateSerialization
Field Value
System.Boolean

Properties

AllowedDockState

Get or set allowed dock states for DockWindow instance

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

AutoHideSize

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

AutoHideTab

Declaration
public TabStripItem AutoHideTab { get; }
Property Value
TabStripItem

BackColor

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

CloseAction

Gets or sets the action to be used when a Close request occurs for this window.

Declaration
public virtual DockWindowCloseAction CloseAction { get; set; }
Property Value
DockWindowCloseAction

DefaultCloseAction

Retrieves the default DockWindowCloseAction for this instance. Will be Hide for ToolWindow instances and CloseAndDispose for DocumentWindow instances.

Declaration
protected virtual DockWindowCloseAction DefaultCloseAction { get; }
Property Value
DockWindowCloseAction

DefaultDockState

Retrieves the default DockState for this instance. Will be Docked for ToolWindow instances and TabbedDocument for DocumentWindow instances.

Declaration
protected virtual DockState DefaultDockState { get; }
Property Value
DockState

DefaultFloatingSize

Gets or sets the size to be used when the window is floated for the first time and does not have previous floating state saved.

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

DesiredDockState

Gets or sets the DockState which is desired for the window and will be applied when the RadDock instance this window is attached to is completely initialized. This property is used internally by the framework and is not intended to be used directly by code.

Declaration
public DockState DesiredDockState { get; set; }
Property Value
DockState

DockManager

Gets the current RadDock instance this window is associated with.

Declaration
public virtual RadDock DockManager { get; }
Property Value
RadDock

Implements

DockState

Gets the current dock state of the window.

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

DockTabStrip

Gets the DockTabStrip which hosts this window.

Declaration
public DockTabStrip DockTabStrip { get; }
Property Value
DockTabStrip

DockType

Gets the DockType of this instance.

Declaration
public virtual DockType DockType { get; }
Property Value
DockType

DocumentButtons

Gets or sets the visibility of the associated command buttons when the window resides in a DocumentTabStrip instance.

Declaration
public DocumentStripButtons DocumentButtons { get; set; }
Property Value
DocumentStripButtons

FloatingParent

Get the parent floating window when the window is in floating mode

Declaration
public FloatingWindow FloatingParent { get; }
Property Value
FloatingWindow

IsInFloatingMode

Get the floating status of window

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

Name

Gets or sets value representing unique Name of the DockWindow

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

Implements

Padding

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

PreviousDockState

Declaration
public DockState PreviousDockState { get; set; }
Property Value
DockState

Site

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

ToolCaptionButtons

Gets or sets the visibility of the associated command buttons when the window resides in a ToolTabStrip instance.

Declaration
public ToolStripCaptionButtons ToolCaptionButtons { get; set; }
Property Value
ToolStripCaptionButtons

ValidationCancel

Declaration
protected bool ValidationCancel { get; }
Property Value
System.Boolean

Methods

Close()

Asks the current DockManager instance (if any) to close the window.

Declaration
public void Close()

Dispose(Boolean)

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

DockTo(DockWindow, DockPosition)

Asks the current DockManager instance (if any) to dock the window to the specified target, using the desired position.

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

DockPosition position

EnsureVisible()

Ensures that the window is currently visible on its hosting DockTabStrip.

Declaration
public void EnsureVisible()

EnsureVisible(Boolean)

Ensures that the window is currently visible on its hosting DockTabStrip.

Declaration
public void EnsureVisible(bool suspendShowAutoHide)
Parameters
System.Boolean suspendShowAutoHide

Indicates whether showing autohide windows should be suspended.

Hide()

Hide the ToolWindow from RadDock manager

Declaration
public void Hide()

OnClosed(DockWindowEventArgs)

Called by the owning RadDock instance when the window has been successfully closed. Depending on the current CloseAction, the window will be either hidden, removed or both plus disposed when entering this method.

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

OnClosing(DockWindowCancelEventArgs)

Called by the owning RadDock instance when this window is about to close. Allows specific DockWindow implementations to optionally cancel the operation and/or perform additional actions.

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

OnEnter(EventArgs)

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

OnGotFocus(EventArgs)

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

OnImageChanged(EventArgs)

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

Overrides

OnMouseDown(MouseEventArgs)

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

OnNameChanged(String)

Notifies the owning RadDock instance for a change in the Name value.

Declaration
protected virtual void OnNameChanged(string oldName)
Parameters
System.String oldName

OnTextChanged(EventArgs)

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

OnToolTipTextChanged(EventArgs)

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

Overrides

Show()

Display the ToolWindow if was previously hidden.

Declaration
public void Show()

ToString()

Declaration
public override string ToString()
Returns
System.String

UpdateOnTextChanged()

Updates all associated UI - such as TabItems, Captions, etc. upon TextChanged event.

Declaration
protected virtual void UpdateOnTextChanged()

WndProc(ref Message)

Provides special handling for the WM_SETFOCUS notification.

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

Extension Methods