GH_CanvasValidator

References
public abstract class GH_CanvasValidator : IGH_CanvasValidator
Abstract implementation of IGH_CanvasValidator. Inherit from this class rather than implementing IGH_CanvasValidator from scratch.

Properties

Canvas

#
protected GH_Canvas Canvas { get; }
Gets the canvas this validator is associated with.

Document

#
protected GH_Document Document { get; }
Gets the document (if it exists) that is currently loaded in the canvas.

Methods

AddedToCanvas

#
public virtual void AddedToCanvas(GH_Canvas canvas)
Override this method if you want to be informed when this validator gets assigned to a canvas. But *always* call the base class method.
Parameters:
canvas (GH_Canvas)
Implements: AddedToCanvas

AppliesToDocument

#
public virtual bool AppliesToDocument(Guid id)
Parameters:
id (Guid)
Implements: AppliesToDocument

CanAcceptObject

#
public virtual bool CanAcceptObject(Guid id)
Parameters:
id (Guid)
Implements: CanAcceptObject

CanCreateObject

#
public virtual bool CanCreateObject(Guid id, PointF pt)
Parameters:
id (Guid)
pt (PointF)
Implements: CanCreateObject

CanCreateWire

#
public virtual bool CanCreateWire(IGH_Param source, IGH_Param target)
Parameters:
source (IGH_Param)
target (IGH_Param)
Implements: CanCreateWire

CanDeleteObject

#
public virtual bool CanDeleteObject(IGH_DocumentObject object)
Parameters:
object (IGH_DocumentObject)
Implements: CanDeleteObject

CanDeleteWire

#
public virtual bool CanDeleteWire(IGH_Param source, IGH_Param target)
Parameters:
source (IGH_Param)
target (IGH_Param)
Implements: CanDeleteWire

CanDragObject

#
public virtual bool CanDragObject(IGH_DocumentObject object, PointF dragFromPoint)
Parameters:
object (IGH_DocumentObject)
dragFromPoint (PointF)
Implements: CanDragObject

CanNavigateCanvas

#
public virtual bool CanNavigateCanvas()
Implements: CanNavigateCanvas

CanShowCanvasMenu

#
public virtual bool CanShowCanvasMenu(PointF pt)
Parameters:
pt (PointF)
Implements: CanShowCanvasMenu

CanShowComponentSearchBox

#
public virtual bool CanShowComponentSearchBox(PointF pt)
Parameters:
pt (PointF)
Implements: CanShowComponentSearchBox

CanShowObjectMenu

#
public virtual bool CanShowObjectMenu(IGH_DocumentObject object)
Parameters:
object (IGH_DocumentObject)
Implements: CanShowObjectMenu

RemovedFromCanvas

#
public virtual void RemovedFromCanvas(GH_Canvas canvas)
Override this method if you want to be informed when this validator gets removed from a canvas. But *always* call the base class method.
Parameters:
canvas (GH_Canvas)
Implements: RemovedFromCanvas