s&box docs
API ReferenceEditor

DockWidgetclass

Container for docked widgets

object→Frame→DockWidget
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.DockWidget : Editor.Frame

Methods3

Showing 3 methods

public void Float()PUBLIC

Detach this dock into its own floating top-level window.

Returns:void—

public void SetAsCurrentTab()PUBLIC

Raise this dock to the front of any tab group it belongs to.

Returns:void—

public void ToggleView(bool open)PUBLIC

Toggle the dock open or closed.

ParameterTypeDescription
openbool—
Returns:void—

Properties6

Showing 6 properties

public bool Editor.DockWidget.IsClosed { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.DockWidget.IsFloating { get; set; }PUBLICGETSET

Whether this dock is floating in its own top-level window.

Returns:bool—

public bool Editor.DockWidget.Locked { get; set; }PUBLICGETSET

Prevents the user from closing, moving, floating or pinning this dock.

Returns:bool—

public bool Editor.DockWidget.MinimumSizeFromContent { get; set; }PUBLICGETSET

When true, the dock's minimum size follows its content widget's minimum size. By default docks can shrink to a tiny fixed size regardless of content.

Returns:bool—

public string Editor.DockWidget.TabTooltip { get; set; }PUBLICGETSET

Text tooltip for the title bar widget.

Returns:string—

UnregisterDockType()

Previous Page

IsClosed

Next Page

On this page

Methodspublic System.Void Float()public System.Void SetAsCurrentTab()public System.Void ToggleView(System.Boolean open)Propertiespublic System.Boolean Editor.DockWidget.IsClosed { get; set; }public System.Boolean Editor.DockWidget.IsFloating { get; set; }public System.Boolean Editor.DockWidget.Locked { get; set; }public System.Boolean Editor.DockWidget.MinimumSizeFromContent { get; set; }public System.String Editor.DockWidget.TabTooltip { get; set; }public Editor.Widget Editor.DockWidget.Widget { get; set; }Metadata