s&box docs
API ReferenceEditor

DockWindowclass

A window that is built from docking windows.

object→Window→DockWindow
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.DockWindow : Editor.Window

Constructors1

Showing 1 constructors

Methods7

Showing 7 methods

protected virtual void BuildDefaultLayout()PROTECTEDVIRTUAL

Open and arrange this window's default docks. Override this to define your default layout.

Returns:void—

public void CreateDynamicViewMenu(Editor.Menu menu)PUBLIC

Populate a view menu with dock toggle options and a reset layout action.

ParameterTypeDescription
menuMenu—
Returns:void—

protected virtual void OnClosed()PROTECTEDVIRTUAL

Returns:void—

public void ResetLayout()PUBLIC

Reset the window back to its default dock layout.

Returns:void—

public virtual void RestoreFromStateCookie()PUBLICVIRTUAL

Restores window geometry and, on top of the base window, the saved dock layout.

Returns:void—

public void RestoreLayout()PUBLIC

Restore the saved dock layout, or the default layout if there's nothing to restore.

Returns:void—

public void SaveLayout()PUBLIC

Persist the current dock layout. Happens automatically when the window closes or the app exits.

Returns:void—

Properties1

Showing 1 properties

Related Guides

→Editor Widgets

ToggleView()

Previous Page

DockManager

Next Page

On this page

Constructorspublic DockWindow()Methodsprotected virtual System.Void BuildDefaultLayout()public System.Void CreateDynamicViewMenu(Editor.Menu menu)protected virtual System.Void OnClosed()public System.Void ResetLayout()public virtual System.Void RestoreFromStateCookie()public System.Void RestoreLayout()public System.Void SaveLayout()Propertiespublic Editor.DockManager Editor.DockWindow.DockManager { get; set; }Metadata