GH_DocumentEditor Class |
The Grasshopper main window.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsScrollableControl
System.Windows.FormsContainerControl
System.Windows.FormsForm
Grasshopper.GUIGH_DocumentEditor
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsScrollableControl
System.Windows.FormsContainerControl
System.Windows.FormsForm
Grasshopper.GUIGH_DocumentEditor
Namespace: Grasshopper.GUI
Assembly: Grasshopper (in Grasshopper.dll)
SyntaxThe GH_DocumentEditor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GH_DocumentEditor | Initializes a new instance of the GH_DocumentEditor class |
Properties| Name | Description | |
|---|---|---|
 | Collapsed |
Gets a value indicating whether or not the form is currently collapsed.
|
 | CreateParams | (Overrides FormCreateParams.) |
| FormShepard |
Gets the form shepard for this window.
Register your modeless dialogs with this shepard if you want to be popular.
|
Methods| Name | Description | |
|---|---|---|
| ClearStatusBar |
Clear the Grasshopper status-bar.
|
| CloseForReal |
Really, really close the window.
|
| CollapseForm |
Collapses the form into the title bar area.
|
| DisableUI |
Disable all modifier UI.
|
 | Dispose | Releases the unmanaged resources used by the GH_DocumentEditor and optionally releases the managed resources (Overrides FormDispose(Boolean).) |
| EnableUI |
Enable all modifier UI.
|
| ExpandForm |
Expands the form if it is currenly collapsed.
|
| FadeIn |
Call this method if the prompt switches back to Grasshopper.
|
| FadeOut |
Call this method if the prompt switches to Rhino.
|
| FixCanvasToolbarState |
Enabled/Disables the appropriate buttons depending on whether there
is a document loaded on the canvas.
|
| ScriptAccess_CloseAllDocuments |
Closes all documents in the Document Queue.
|
| ScriptAccess_CloseDocument |
Closes the currently active document and loads the next available document into the canvas.
Changes will not be saved.
|
| ScriptAccess_IsDocument |
Returns true if there is an active document.
|
| ScriptAccess_IsDocumentModified |
Gets the modified flag of the currently loaded document.
|
| ScriptAccess_NewDocument |
Creates a new document and loads it into the Canvas.
|
| ScriptAccess_OpenDocument |
Displays a command line interface for File Open... then loads that file into the Canvas.
|
| ScriptAccess_OpenDocument(String) |
Loads a specific file off the hard disk into the Canvas.
|
| 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.
|
| ScriptAccess_SaveDocumentAs |
Saves the currently active document to disk.
|
| ScriptAccess_SaveDocumentAs(String) |
Saves the currently active document to disk.
|
| SetStatusBarEvent |
Set a new message on the Grasshopper status bar.
|
| ToggleForm |
Collapses the form if it's currently expanded or expands the form if it's currently collapsed.
|
| WndProc |
WndProc is overridden in order to allow for title-bar double-click (un)folding.
(Overrides FormWndProc(Message).) |
Events| Name | Description | |
|---|---|---|
  | 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 |
This event is raised whenever the main windows folds or unfolds.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ToEto | Overloaded. (Defined by EtoExtensions.) |
| ToEto | Overloaded. (Defined by EtoExtensions.) |
See Also