GH_LayoutTab

References

public class GH_LayoutTab : GH_ISerializable, IComparable<GH_LayoutTab>

Represents a tab on a ribbon layout.

Constructors

GH_LayoutTab

public GH_LayoutTab()

Create a new blank Tab

GH_LayoutTab

public GH_LayoutTab(GH_LayoutTab other)

Duplicate another Tab.

Parameters:

other (GH_LayoutTab)

Tab to duplicate

GH_LayoutTab

public GH_LayoutTab(string name)

Create a new empty tab.

Parameters:

name (string)

Name of tab.

Properties

Name

public string Name { get; set; }

Gets or sets the name of this tab. Tabs must have a non-zero name or they will be "unnamed".

Panels

public List<GH_LayoutPanel> Panels { get; }

Gets the list of Panels for this tab.

Selected

public bool Selected { get; set; }

Gets or sets whether this tab is selected. This property is used exclusively inside Layout Editors, not Ribbon controls.

Methods

AddPanel

public GH_LayoutPanel AddPanel()

Add a new panel to this tab. The panel will receive a default name.

AddPanel

public GH_LayoutPanel AddPanel(string name)

Add a new panel to this layout. If a panel with a similar name already exists, nothing is done.

Parameters:

name (string)

Name of panel.

CompareTo

public int CompareTo(GH_LayoutTab other)

Parameters:

other (GH_LayoutTab)

Deselect

public void Deselect()

Deselect this tab and all objects it contains.

Read

public bool Read(GH_IReader reader)

Parameters:

reader (GH_IReader)

Implements: Read

SortPanels

public void SortPanels(params string[] order)

Attempt to sort the panels in this tab to match a given order.

Parameters:

order (params string[])

A collection of strings that identify the order of panels.

Write

public bool Write(GH_IWriter writer)

Parameters:

writer (GH_IWriter)

Implements: Write