The GH_Canvas type exposes the following members.
Gets or sets the currently active interaction object.
Gets or sets the currently active object.
Gets or sets the currently active widget.
Gets the location of the cursor in Canvas coordinates.
Gets the location of the cursor in Control coordinates.
Gets or sets whether the Voronoi Over-dose warning message is displayed. This property is set once at Grasshopper startup to True.
Gets or sets the document currently loaded in this canvas.
Gets the current drawing mode for this canvas.
Gets whether or not this canvas has a child control on it with focus.
Gets a value indicating whether or not there is an interaction object loaded in this canvas.
Gets a value indicating whether or not an object is currently activated.
Gets a value indicating whether or not a widget is currently activated.
Gets a value indicating whether or not a document is currently loaded in this canvas.
Gets or sets the modifiers enabled flag. When modifiers are disabled, only zooming and panning is still allowed.
Gets or sets the special key for panning down.
Gets or sets the special key for panning left.
Gets or sets the number of pixels for each pan operation.
Gets or sets the special key for panning right.
Gets or sets the special key for panning up.
Gets or sets the zoom factor for navigation zoom operations.
Gets or sets the special key for zooming in.
Gets or sets the special key for zooming in.
Gets the painter object that handles most of the drawing logic for this canvas.
Gets whether this canvas is currently busy painting itself.
Gets all the TagArtist IDs in this Canvas.
Gets the thumbnail size for documents.
Gets the delay (in milliseconds) required for a tooltip popup. This delay is a user setting stored under the Canvas:TooltipDelay field of the core settings.
Provides access to all the validators associated with this canvas.
Gets the viewport that determines the panning and zooming for this canvas.
Gets a list of all the widgets on this canvas.
Gets the ZUI fade alpha value for the high zoom level threshold. This static field gets set on every Canvas paint start. The high threshold is typically used for ZUI elements that only appear when zoomed in.
Gets the ZUI fade alpha value for the low zoom level threshold. This static field gets set on every Canvas paint start. The low threshold is typically used for fading of icons and object names.
Gets the ZUI fade alpha value for the medium zoom level threshold. This static field gets set on every Canvas paint start. The medium threshold is typically used for non-informative UI elements such as highlights.
Add a Tag Artist instance to this canvas.
Add a new drop validator to the canvas.
Create new MRU panels. This function only does something if there is no document loaded in the canvas.
Render this canvas to a thumbnail preview.
Destroy any MRU panels that might be in existence.
Releases the unmanaged resources used by the GH_Canvas and optionally releases the managed resources(Overrides ControlDispose(Boolean).)
Generate a collection of hi-res images of the document.
Generate a single tile in a Hi-Res image export.
Get a bitmap that resembles the current state of the canvas.
Gets a graphics object for this control. You are not allowed to draw with this object, use it only for visibility testing and such. If you're inside a canvas update, use the Graphics() property instead. You must dispose of the Graphics object returned by this method or resources will be leaked.
Hide all existing MRU panels by sliding them out of view.
|InstantiateNewObject(Guid, PointF, Boolean)|
|InstantiateNewObject(Guid, String, PointF, Boolean)|
Perform a single navigation step.
Ensure the canvas and document viewport data are synchronised and raises the ViewportChanged event.
Remove all IGH_TagArtists from this canvas. Do not use this method unless you want to screw over everyone else.
Remove all IGH_TagArtists from this canvas that match a certain ID.
Remove a specific tag artist from this canvas. If the instance occurs multiple times in the TagArtist list, all instances will be removed.
Remove a drop validator from the canvas.
Schedule a regen to occur after the specified number of milliseconds have elapsed. If a Regen is called in this time frame, the schedule will be cleared. Only a single schedule can be active at any time, so any call to ScheduleRegen will clear existing schedules.
When this method is called during a redraw, the TextRenderingHint of the associated graphics object will be set to either GH_CrispText or GH_SmoothText depending on zoom level.
Display the component Search dialog at the current mouse location. The dialog cannot be shown if ModifiersEnabled=False.
Display the component Search dialog at the given coordinate. The dialog cannot be shown if ModifiersEnabled=False.
Show any hidden MRU panels by sliding them back into view.
Displays the quick-navigation popup pane at the cursor.
Display the Find dialog. If a Find dialog is already active for this canvas, nothing will happen.
Start the auto-panning timer.
Stop the auto-panning timer.
Call this method to update the preview thumbnail for the currently loaded document. If no document is currently loaded, nothing will happen.
Raised after the background has been drawn.
Raised before a new paint operation starts. This event is always raised, even if the Canvas isn't visible.
Raised after a paint operation completes. This event is always raised, even if the Canvas isn't visible.
Raised after group drawing completes.
Raised after object drawing completes.
Raised after object overlay drawing completes.
Raised after widgets are drawn. This is the final event in the Drawing pipeline.
Raised after wire drawing completes.
Raised before group drawing starts.
Raised before object drawing starts.
Raised before object overlay drawing starts.
Raised before Widgets are drawn.
Raised before wire drawing starts.
This event is raised whenever a different document is loaded into this canvas.
This event is raised whenever the left mouse button is pressed while over a Document object.
This event is raised whenever the ModifiersEnabled property changes.
Raised whenever any of the shared navigation properties changed.
This event is raised whenever the viewport properties are modified, for example when the pan or zoom values are affected.
This event is raised once for every GH_Canvas object that is created anew. The event is Shared (static) because it is raised inside the constructor of a GH_Canvas object and therefor cannot be registered on an instance.
Defines the delay used to indicate the absence of a schedule.
|ToEto||(Defined by EtoExtensions.)|