Class

DockWindow

Initializes a new DockWindow instance.

Declaration

public DockWindow()

Declaration

protected DockWindow(DockState dockState, DockState previousDockState)

Parameters

Get or set allowed dock states for DockWindow instance

Declaration

[Browsable(false)]
public AllowedDockState AllowedDockState { get; set; }

Property Value

Declaration

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

Property Value

Declaration

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

Property Value

Declaration

public override Color BackColor { get; set; }

Property Value

Overrides Control.BackColor

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

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

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

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

Gets the current RadDock instance this window is associated with.

Declaration

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

Property Value

Implements IDockWindow.DockManager

Gets the current dock state of the window.

Declaration

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

Property Value

Gets the DockTabStrip which hosts this window.

Declaration

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

Property Value

Gets the DockType of this instance.

Declaration

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

Property Value

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

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

Declaration

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

Property Value

Get the floating status of window

Declaration

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

Property Value

Gets or sets value representing unique Name of the DockWindow

Declaration

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

Property Value

Implements IDockWindow.Name

Declaration

public override ISite Site { get; set; }

Property Value

Overrides Control.Site

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

Declaration

protected bool ValidationCancel { get; }

Property Value

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

Declaration

public void Close()

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides ContainerControl.Dispose(bool)

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

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

Declaration

public void EnsureVisible()

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

Declaration

public void EnsureVisible(bool suspendShowAutoHide)

Parameters

Hide the ToolWindow from RadDock manager

Declaration

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.

Declaration

protected virtual void OnClosed(DockWindowEventArgs e)

Parameters

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

Declaration

protected override void OnEnter(EventArgs e)

Parameters

Overrides Control.OnEnter(EventArgs)

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides Control.OnGotFocus(EventArgs)

Notifies for a change in the Image and SvgImage members of this panel.

Declaration

protected override void OnImageChanged(EventArgs e)

Parameters

Overrides TabPanel.OnImageChanged(EventArgs)

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides Control.OnMouseDown(MouseEventArgs)

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

Declaration

protected virtual void OnNameChanged(string oldName)

Parameters

Declaration

protected override void OnTextChanged(EventArgs e)

Parameters

Overrides Control.OnTextChanged(EventArgs)

Declaration

protected override void OnToolTipTextChanged(EventArgs e)

Parameters

Overrides TabPanel.OnToolTipTextChanged(EventArgs)

Display the ToolWindow if was previously hidden.

Declaration

public void Show()

Declaration

public override string ToString()

Returns

Overrides Component.ToString()

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

Declaration

protected virtual void UpdateOnTextChanged()

Provides special handling for the WM_SETFOCUS notification.

Declaration

protected override void WndProc(ref Message m)

Parameters

Overrides ContainerControl.WndProc(ref Message)