Class DebugUI.Foldout

Unity-like foldout that can be collapsed.

Inheritance
object
DebugUI.Widget
DebugUI.Container
DebugUI.Foldout
DebugUI.Table.Row
Implements
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public class DebugUI.Foldout : DebugUI.Container, DebugUI.IContainer, DebugUI.IValueField

Constructors

Foldout()

Constructor.

Declaration
public Foldout()

Foldout(string, ObservableList<Widget>, string[], string[])

Constructor.

Declaration
public Foldout(string displayName, ObservableList<DebugUI.Widget> children, string[] columnLabels = null, string[] columnTooltips = null)
Parameters
Type Name Description
string displayName

Display name of the foldout.
ObservableList<DebugUI.Widget> children

List of attached children.
string[] columnLabels

Optional list of column names.
string[] columnTooltips

Optional list of tooltips for column name labels.

Fields

contextMenuItems

Optional list of context menu items. If the list is not provided, no context menu button will be displayed.

Declaration
public List<DebugUI.Foldout.ContextMenuItem> contextMenuItems
Field Value
Type Description
List<DebugUI.Foldout.ContextMenuItem>

isHeader

Draw the foldout in full width using a header style.

Declaration
public bool isHeader
Field Value
Type Description
bool

opened

Opened state of the foldout.

Declaration
public bool opened
Field Value
Type Description
bool

Properties

columnLabels

List of columns labels.

Declaration
public string[] columnLabels { get; set; }
Property Value
Type Description
string[]

columnTooltips

List of columns label tooltips.

Declaration
public string[] columnTooltips { get; set; }
Property Value
Type Description
string[]

isReadOnly

Always false.

Declaration
public bool isReadOnly { get; }
Property Value
Type Description
bool

Methods

GetValue()

Get the opened state of the foldout.

Declaration
public bool GetValue()
Returns
Type Description
bool

True if the foldout is opened.

SetValue(bool)

Set the value of the widget.

Declaration
public void SetValue(bool value)
Parameters
Type Name Description
bool value

Input value.

SetValue(object)

Set the opened state of the foldout.

Declaration
public void SetValue(object value)
Parameters
Type Name Description
object value

True to open the foldout, false to close it.

ValidateValue(object)

Validates the value of the widget before setting it.

Declaration
public object ValidateValue(object value)
Parameters
Type Name Description
object value

Input value.
Returns
Type Description
object

The validated value.

Implements

Extension Methods