Properties
Icon_24x24
#Bitmap Icon_24x24 { get; }
TooltipEnabled
Gets the tooltip enabled value. If False, no further tooltip functions will be called.
Methods
Contains
#IsTooltipRegion
Determine whether the specified pixel should result in a tooltip when the cursor hovers over it.
Parameters:
| canvasPoint (PointF) | Point in Canvas coordinates. |
RespondToKeyDown
Parameters:
| sender (GH_Canvas) | |
| e (KeyEventArgs) |
RespondToKeyUp
Parameters:
| sender (GH_Canvas) | |
| e (KeyEventArgs) |
RespondToMouseDoubleClick
This function will be called whenever the left button is double-clicked over the canvas. If you are active, you will be the only object who gets called.
Parameters:
| sender (GH_Canvas) | Base canvas. |
| e (GH_CanvasMouseEvent) | Mouse event arguments. |
Returns: All Response flags are valid.
RespondToMouseDown
This function will be called whenever a mouse button is pressed over the canvas. If you are active, you will be the only object who gets called. If you are inactive, you might get called if nobody on top of you decides to become active.
Parameters:
| sender (GH_Canvas) | Base canvas. |
| e (GH_CanvasMouseEvent) | Mouse event arguments. |
Returns: All Response flags are valid.
RespondToMouseMove
This function will be called when the mouse moves across the canvas. If you are active, you will be the only object who gets called. If you are inactive, you might get called if nobody on top of you decides to become active.
Parameters:
| sender (GH_Canvas) | Base canvas. |
| e (GH_CanvasMouseEvent) | Mouse event arguments. |
Returns: All Response flags are valid.
RespondToMouseUp
This function will be called whenever a mouse button is released over the canvas. If you are active, you will be the only object who gets called. If you are inactive, you will not be called at all for MouseUp events.
Parameters:
| sender (GH_Canvas) | Base canvas. |
| e (GH_CanvasMouseEvent) | Mouse event arguments. |
Returns: All Response flags are valid.
SetupTooltip
This function is called when a tooltip it about to be displayed.
Parameters:
| canvasPoint (PointF) | The pixel coordinate on the canvas of the cursor. |
| e (GH_TooltipDisplayEventArgs) | Tooltip display arguments. |