Editor

RhinoSlavedFormFormWindowPanelContainerControlBindableWidgetWidgetReferences

public class Editor : RhinoSlavedForm

The standard editor window for Grasshopper. There's only ever at most one of these.

Constructors

Editor

public Editor()

Create a new form.

Properties

Canvas

public Canvas Canvas { get; }

Gets the canvas on this form.

Collapsed

public bool Collapsed { get; set; }

Gets or sets whether the editor is Collapsed into its own title bar.

CurrentDocument

protected RhinoDoc CurrentDocument { get; }

Gets the Rhino document associated with the Rhino main window which is currently the owner of this form.

inherited fromRhinoSlavedForm

CurrentRhinoWindow

protected Window CurrentRhinoWindow { get; }

Gets the Rhino window this form is looking to.

inherited fromRhinoSlavedForm

DefinedLayouts

public static IEnumerable<string> DefinedLayouts { get; }

Enumerate over all available layouts for TabbedPanels.

Documents

public DocumentBag Documents { get; }

Gets the collection of documents which are loaded into this editor.

EditorSettings

public SettingsFile EditorSettings { get; }

Gets the settings associated with this window.

InitialLayout

public static string InitialLayout { get; }

Gets the name of the layout rules currently set as active.

Instance

public static Editor Instance { get; }

Gets the one and only instance of the editor window. This property may return null if the editor hasn't been instantiated yet.

MostRecentActiveDocument

public string MostRecentActiveDocument { get; }

Gets the path to the most recently loaded active documents. This property only really makes sense at the very start of the Grasshopper life-cycle.

MostRecentCount

public int MostRecentCount { get; }

Count how many recently loaded documents can be potentially loaded.

MostRecentLoadedDocuments

public string[] MostRecentLoadedDocuments { get; }

Gets the paths to the most recently loaded documents. Note that this list excludes the most recently loaded active document. This property only really makes sense at the very start of the Grasshopper life-cycle.

ShowNotes

public bool ShowNotes { get; set; }

Gets or sets whether to show the notes window.

StatusBar

public StatusBar StatusBar { get; }

Gets the status bar on this form.

Tabs

public TabControl Tabs { get; }

Gets the tab control on this form.

ThisOrRhino

public static Window ThisOrRhino { get; }

Gets the editor window, or the main Rhino window if the editor is either undefined or not visible.

Methods

BeginRhinoGetter

public static bool BeginRhinoGetter(RhinoDoc doc = null)

Call this method if you are about to start a Rhino viewport getter. It will hide the Grasshopper editor for the duration.

Parameters:

doc (RhinoDoc = null)

Returns: False if there is no target document, or if there is already an active getter.

HandleShutDown

protected override void HandleShutDown()

Overrides: RhinoSlavedForm.HandleShutDown

OnOwnerAssigned

protected virtual void OnOwnerAssigned()

Override this method to get informed when the Owner of this form is assigned.

inherited fromRhinoSlavedForm

OnOwnerRemoved

protected virtual void OnOwnerRemoved()

Override this method to get informed when the Owner of this form is removed.

inherited fromRhinoSlavedForm

ShowEditor

public static Editor ShowEditor(bool createVisible = true, string layoutRules = null)

Create a new editor form or return the currently existing editor form. Note, if the form exists and is hidden or off-screen, this method will not change that. Call the EnsureVisible() method for that.

Parameters:

createVisible (bool = true)
layoutRules (string = null)

UpdateWindowTitle

public void UpdateWindowTitle()