GH_DocumentEditor

FormContainerControlScrollableControlControlComponentMarshalByRefObjectReferences
[DesignerGenerated] public class GH_DocumentEditor : Form
The Grasshopper main window.

Constructors

GH_DocumentEditor

#
public GH_DocumentEditor()

Properties

Collapsed

#
public bool Collapsed { get; }
Gets a value indicating whether or not the form is currently collapsed.

FormShepard

#
public GH_FormShepard FormShepard { get; }
Gets the form shepard for this window. Register your modeless dialogs with this shepard if you want to be popular.

Methods

ClearStatusBar

#
public void ClearStatusBar()
Clear the Grasshopper status-bar.

CloseForReal

#
public void CloseForReal()
Really, really close the window.

CollapseForm

#
public void CollapseForm()
Collapses the form into the title bar area.

DisableUI

#
public void DisableUI()
Disable all modifier UI.

Dispose

#
protected override void Dispose(bool disposing)
Parameters:
disposing (bool)
Overrides: Form.Dispose

EnableUI

#
public void EnableUI()
Enable all modifier UI.

ExpandForm

#
public void ExpandForm()
Expands the form if it is currenly collapsed.

FadeIn

#
public void FadeIn()
Call this method if the prompt switches back to Grasshopper.

FadeOut

#
public void FadeOut()
Call this method if the prompt switches to Rhino.

FixCanvasToolbarState

#
public void FixCanvasToolbarState()
Enabled/Disables the appropriate buttons depending on whether there is a document loaded on the canvas.

ScriptAccess_CloseAllDocuments

#
public bool ScriptAccess_CloseAllDocuments()
Closes all documents in the Document Queue.
Returns: True on success, false on failure.

ScriptAccess_CloseDocument

#
public bool ScriptAccess_CloseDocument()
Closes the currently active document and loads the next available document into the canvas. Changes will not be saved.
Returns: True on success, false on failure.

ScriptAccess_IsDocument

#
public bool ScriptAccess_IsDocument()
Returns true if there is an active document.

ScriptAccess_IsDocumentModified

#
public bool ScriptAccess_IsDocumentModified()
Gets the modified flag of the currently loaded document.
Returns: True if the document has been modified, false if not or if there is no document.

ScriptAccess_NewDocument

#
public bool ScriptAccess_NewDocument()
Creates a new document and loads it into the Canvas.

ScriptAccess_OpenDocument

#
public bool ScriptAccess_OpenDocument()
Displays a command line interface for File Open... then loads that file into the Canvas.
Returns: True on success, false on failure.

ScriptAccess_OpenDocument

#
public bool ScriptAccess_OpenDocument(string filename)
Loads a specific file off the hard disk into the Canvas.
Parameters:
filename (string)File to load.
Returns: True on success, false on failure.

ScriptAccess_SaveDocument

#
public bool ScriptAccess_SaveDocument()
Saves the document currently loaded in the Canvas. If the document hasn't been saved before then a Save... dialog box will be shown.
Returns: True on success, false on failure.

ScriptAccess_SaveDocumentAs

#
public bool ScriptAccess_SaveDocumentAs()
Saves the currently active document to disk.
Returns: True on success, false on failure.

ScriptAccess_SaveDocumentAs

#
public bool ScriptAccess_SaveDocumentAs(string path)
Saves the currently active document to disk.
Parameters:
path (string)Path of save destination.
Returns: True on success, false on failure.

SetStatusBarEvent

#
public void SetStatusBarEvent(GH_RuntimeMessage event)
Set a new message on the Grasshopper status bar.
Parameters:
event (GH_RuntimeMessage)Message to set

ToggleForm

#
public void ToggleForm()
Collapses the form if it's currently expanded or expands the form if it's currently collapsed.

Events

AggregateShortcutMenuItems

#
public static event GH_DocumentEditor.AggregateShortcutMenuItemsEventHandler AggregateShortcutMenuItems
This event is raised whenever a GH_DocumentEditor collects all shortcuttable menu items. If you added items to the menu and you want to be able to have custom shortcuts on these items, you must handle this event and insert your own items.

EditorFoldStateChanged

#
public event GH_DocumentEditor.EditorFoldStateChangedEventHandler EditorFoldStateChanged
This event is raised whenever the main windows folds or unfolds.