PanelDockWindowsclass

Drags dock panels between desktop windows with panel-drawn chrome.

object→PanelDockWindows
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public sealed class Editor.PanelDockWindows

Constructors1

Showing 1 constructors

public PanelDockWindows(Sandbox.UI.DockHost main)PUBLICCONSTRUCTOR

Enables desktop tab dragging for this host and its floating windows.

ParameterTypeDescription
mainDockHost—

Methods4

Showing 4 methods

public virtual sealed void Dispose()PUBLICVIRTUAL

Unhooks dragging and returns floating content if the main host survives.

Returns:void—

public void DockAll()PUBLIC

Returns all floating registrations, including closed panels, to the main host.

Returns:void—

public bool Float(string id)PUBLIC

Explicitly opens a registered panel in its own floating window. Returns false when unavailable or during a drag. The same content instance is retained; a lone floating panel is simply focused.

ParameterTypeDescription
idstring—
Returns:bool—

public bool RestoreState(string json)PUBLIC

Restores a workspace using the existing content instances. Invalid data leaves the workspace untouched. Returns false during a drag/layout operation or if windows cannot be created. Desktop windows require the main host to belong to an editor PanelWindow. This saves layout, not the contents of each panel.

ParameterTypeDescription
jsonstring—
Returns:bool—

Properties2

Showing 2 properties

public System.Action`1<Sandbox.UI.RootPanel> Editor.PanelDockWindows.ConfigureWindow { get; set; }PUBLICGETSET

Styles each floating root before content is transferred.

Returns:Action<RootPanel>—

public string Editor.PanelDockWindows.State { get; set; }PUBLICGETSET

Saves the main layout and every floating window, including closed registrations, tab selection, splits, desktop position and UI size. Does not move panels. Call between drag/layout operations.

Returns:string—

On this page