IGH_SketchElement

References
Base interface for all Sketch elements

Properties

BoundingBox

#
RectangleF BoundingBox { get; }

Category

string Category { get; set; }
Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.
inherited fromIGH_InstanceDescription

Description

string Description { get; set; }
Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.
inherited fromIGH_InstanceDescription

GraphicsPath

#
GraphicsPath GraphicsPath { get; }

HasCategory

bool HasCategory { get; }
Gets whether or not the Category field has been set.
inherited fromIGH_InstanceDescription

HasSubCategory

bool HasSubCategory { get; }
Gets whether or not the SubCategory field has been set.
inherited fromIGH_InstanceDescription

Icon_24x24

#
Image Icon_24x24 { get; }

InstanceDescription

string InstanceDescription { get; }
Gets a description of the current state of the object. This field is usually the same as the Description() field, but it might be variable when overridden.
inherited fromIGH_InstanceDescription

InstanceGuid

Guid InstanceGuid { get; }
Gets the ID of this runtime instance.
inherited fromIGH_InstanceDescription

Keywords

IEnumerable<string> Keywords { get; }
Gets a list of additional keywords that describe the object. Typically this list is empty but you can override this property to aid in object searches.
inherited fromIGH_InstanceDescription

Name

string Name { get; set; }
Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.
inherited fromIGH_InstanceDescription

NickName

string NickName { get; set; }
Gets or sets the nickname of the object. This field can be changed by the user.
inherited fromIGH_InstanceDescription

SubCategory

string SubCategory { get; set; }
Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.
inherited fromIGH_InstanceDescription

Methods

IsPickPoint

#
bool IsPickPoint(PointF pt)
pt (PointF)

IsPickPoint

#
bool IsPickPoint(RectangleF box, GH_PickBox bCrossingBox)
box (RectangleF)
bCrossingBox (GH_PickBox)

NewInstanceGuid

void NewInstanceGuid()
Generate a new random instance GUID
inherited fromIGH_InstanceDescription

NewInstanceGuid

void NewInstanceGuid(Guid UUID)
Set the instance ID to be a specific GUID. This is very dangerous, only use this function if you're 6"4' and called David.
inherited fromIGH_InstanceDescription
UUID (Guid)

Read

bool Read(GH_IReader reader)
This method is called whenever the instance is required to deserialize itself.
inherited fromGH_ISerializable
reader (GH_IReader)Reader object to deserialize from.
True on success, false on failure.

Write

bool Write(GH_IWriter writer)
This method is called whenever the instance is required to serialize itself.
inherited fromGH_ISerializable
writer (GH_IWriter)Writer object to serialize with.
True on success, false on failure.