New to Telerik UI for WinForms? Start a free 30-day trial

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

Definition

Namespace:Telerik.WinControls.UI.Docking

Assembly:Telerik.WinControls.RadDock.dll

Syntax:

C#
public abstract class DockWindow : TabPanel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, INotifyPropertyChanged, IDockWindow

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlTabPanelDockWindow...

Derived Classes: DockWindowPlaceholderDocumentWindowHostWindowToolWindow

Implements: IBindableComponentIComponentIContainerControlIDisposableIDockWindowIDropTargetINotifyPropertyChangedISynchronizeInvokeIWin32Window...

Inherited Members TabPanel.GetTabStrip<T>()TabPanel.OnPropertyChanged(string)TabPanel.BorderStyleTabPanel.DefaultSizeTabPanel.ImageTabPanel.SvgImageTabPanel.TabStripItemTabPanel.ToolTipTextTabPanel.TabStripTabPanel.TextChangedTabPanel.PropertyChanged...

Constructors

Initializes a new DockWindow instance.

C#
public DockWindow()

Initializes a dock window with its current state and the state retained for restoration.

C#
protected DockWindow(DockState dockState, DockState previousDockState)
Parameters:dockStateDockState

The window's current docking state.

previousDockStateDockState

The docking state to retain as the previous state.

Properties

Get or set allowed dock states for DockWindow instance

C#
[Browsable(false)]
public AllowedDockState AllowedDockState { get; set; }
C#
[Browsable(false)]
public virtual Size AutoHideSize { get; set; }

Gets the tab-strip item representing this window in the auto-hide strip.

C#
[Browsable(false)]
public TabStripItem AutoHideTab { get; }

Gets the explicit background color, or the owning tab strip's default window color when no explicit color is set.

C#
public override Color BackColor { get; set; }

Overrides: Control.BackColor

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

C#
public virtual DockWindowCloseAction CloseAction { get; set; }

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

C#
protected virtual DockWindowCloseAction DefaultCloseAction { get; }

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

C#
protected virtual DockState DefaultDockState { get; }

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.

C#
public Size DefaultFloatingSize { get; set; }

Gets the current RadDock instance this window is associated with.

C#
[Browsable(false)]
public virtual RadDock DockManager { get; }

Implements: IDockWindow.DockManager

Gets the current dock state of the window.

C#
[Browsable(false)]
public DockState DockState { get; set; }

Gets the DockTabStrip which hosts this window.

C#
[Browsable(false)]
public DockTabStrip DockTabStrip { get; }

Gets the DockType of this instance.

C#
[Browsable(false)]
public virtual DockType DockType { get; }

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

C#
public DocumentStripButtons DocumentButtons { get; set; }

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

C#
[Browsable(false)]
public FloatingWindow FloatingParent { get; }

Get the floating status of window

C#
[Browsable(false)]
public bool IsInFloatingMode { get; }

Gets or sets value representing unique Name of the DockWindow

C#
[Browsable(false)]
public string Name { get; set; }

Implements: IDockWindow.Name

C#
public override ISite Site { get; set; }

Overrides: Control.Site

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

C#
public ToolStripCaptionButtons ToolCaptionButtons { get; set; }

Gets whether control validation was canceled, which prevents mouse activation of this window.

C#
protected bool ValidationCancel { get; }

Methods

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

C#
public void Close()

Clears the dock-manager reference before base disposal and clears the tab-strip item when managed resources are disposed.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

True to dispose managed resources and clear the tab-strip item.

Overrides: ContainerControl.Dispose(bool)

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

C#
public void DockTo(DockWindow target, DockPosition position)
Parameters:targetDockWindowpositionDockPosition

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

C#
public void EnsureVisible()

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

C#
public void EnsureVisible(bool suspendShowAutoHide)
Parameters:suspendShowAutoHidebool

Indicates whether showing autohide windows should be suspended.

Hide the ToolWindow from RadDock manager

C#
public void Hide()

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.

C#
protected virtual void OnClosed(DockWindowEventArgs e)
Parameters:eDockWindowEventArgs

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.

C#
protected virtual void OnClosing(DockWindowCancelEventArgs e)
Parameters:eDockWindowCancelEventArgs

Updates the dock manager's active-window state when this window is entered.

C#
protected override void OnEnter(EventArgs e)
Parameters:eEventArgs

Overrides: Control.OnEnter(EventArgs)

Updates the dock manager's active-window state when this window receives focus.

C#
protected override void OnGotFocus(EventArgs e)
Parameters:eEventArgs

Overrides: Control.OnGotFocus(EventArgs)

Updates the auto-hide tab's images when this window's image changes.

C#
protected override void OnImageChanged(EventArgs e)
Parameters:eEventArgs

Overrides: TabPanel.OnImageChanged(EventArgs)

Makes this the active window unless validation was canceled; if activation is blocked, saves the current active window's control.

C#
protected override void OnMouseDown(MouseEventArgs e)
Parameters:eMouseEventArgs

Overrides: Control.OnMouseDown(MouseEventArgs)

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

C#
protected virtual void OnNameChanged(string oldName)
Parameters:oldNamestring

Propagates text changes to the window's tab items and, for the active tool window, its strip caption.

C#
protected override void OnTextChanged(EventArgs e)
Parameters:eEventArgs

Overrides: Control.OnTextChanged(EventArgs)

Updates the auto-hide tab's tooltip when this window's tooltip text changes.

C#
protected override void OnToolTipTextChanged(EventArgs e)
Parameters:eEventArgs

Overrides: TabPanel.OnToolTipTextChanged(EventArgs)

Display the ToolWindow if was previously hidden.

C#
public void Show()

Returns the full runtime type name followed by this window's text.

C#
public override string ToString()
Returns:

string

Overrides: Component.ToString()

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

C#
protected virtual void UpdateOnTextChanged()

Provides special handling for the WM_SETFOCUS notification.

C#
protected override void WndProc(ref Message m)
Parameters:mMessage

Overrides: ContainerControl.WndProc(ref Message)