DockWindow
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:
public abstract class DockWindow : TabPanel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, INotifyPropertyChanged, IDockWindowInheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlTabPanelDockWindow...
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new DockWindow instance.
public DockWindow()Properties
Get or set allowed dock states for DockWindow instance
[Browsable(false)]
public AllowedDockState AllowedDockState { get; set; }[Browsable(false)]
public virtual Size AutoHideSize { get; set; }[Browsable(false)]
public TabStripItem AutoHideTab { get; }Gets or sets the action to be used when a Close request occurs for this window.
public virtual DockWindowCloseAction CloseAction { get; set; }Retrieves the default DockWindowCloseAction for this instance. Will be Hide for ToolWindow instances and CloseAndDispose for DocumentWindow instances.
protected virtual DockWindowCloseAction DefaultCloseAction { get; }Retrieves the default DockState for this instance. Will be Docked for ToolWindow instances and TabbedDocument for DocumentWindow instances.
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.
public Size DefaultFloatingSize { get; set; }Gets the current RadDock instance this window is associated with.
[Browsable(false)]
public virtual RadDock DockManager { get; }Implements:
Gets the current dock state of the window.
[Browsable(false)]
public DockState DockState { get; set; }Gets the DockTabStrip which hosts this window.
[Browsable(false)]
public DockTabStrip DockTabStrip { get; }Gets the DockType of this instance.
[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.
public DocumentStripButtons DocumentButtons { get; set; }Get the parent floating window when the window is in floating mode
[Browsable(false)]
public FloatingWindow FloatingParent { get; }Get the floating status of window
[Browsable(false)]
public bool IsInFloatingMode { get; }Gets or sets value representing unique Name of the DockWindow
[Browsable(false)]
public string Name { get; set; }Implements:
Gets or sets the visibility of the associated command buttons when the window resides in a ToolTabStrip instance.
public ToolStripCaptionButtons ToolCaptionButtons { get; set; }protected bool ValidationCancel { get; }Methods
Asks the current DockManager instance (if any) to close the window.
public void Close()Asks the current DockManager instance (if any) to dock the window to the specified target, using the desired position.
public void DockTo(DockWindow target, DockPosition position)Ensures that the window is currently visible on its hosting DockTabStrip.
public void EnsureVisible()Ensures that the window is currently visible on its hosting DockTabStrip.
public void EnsureVisible(bool suspendShowAutoHide)Indicates whether showing autohide windows should be suspended.
Hide the ToolWindow from RadDock manager
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.
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.
protected virtual void OnClosing(DockWindowCancelEventArgs e)Notifies for a change in the Image and SvgImage members of this panel.
Display the ToolWindow if was previously hidden.
public void Show()Updates all associated UI - such as TabItems, Captions, etc. upon TextChanged event.
protected virtual void UpdateOnTextChanged()Provides special handling for the WM_SETFOCUS notification.