Grasshopper API
GH_IO.Serialization
GH_Chunk Class
GH_Chunk Methods
AddComment Method
AddMessage Method
ChunkExists Method
CopyValuesFromChunk Method
CopyValuesToChunk Method
CreateChunk Method
FindChunk Method
FindItem Method
GetBoolean Method
GetBoundingBox Method
GetByte Method
GetByteArray Method
GetDate Method
GetDecimal Method
GetDouble Method
GetDoubleArray Method
GetDrawingBitmap Method
GetDrawingColor Method
GetDrawingPoint Method
GetDrawingPointF Method
GetDrawingRectangle Method
GetDrawingRectangleF Method
GetDrawingSize Method
GetDrawingSizeF Method
GetGuid Method
GetInt32 Method
GetInt64 Method
GetInterval1D Method
GetInterval2D Method
GetLine Method
GetPath Method
GetPlane Method
GetPoint2D Method
GetPoint3D Method
GetPoint4D Method
GetSingle Method
GetString Method
GetVersion Method
InstantiateRoot Method
ItemExists Method
Read Method
RemoveChunk Method
RemoveItem Method
SetBoolean Method
SetBoundingBox Method
SetByte Method
SetByteArray Method
SetDate Method
SetDecimal Method
SetDouble Method
SetDoubleArray Method
SetDrawingBitmap Method
SetDrawingColor Method
SetDrawingPoint Method
SetDrawingPointF Method
SetDrawingRectangle Method
SetDrawingRectangleF Method
SetDrawingSize Method
SetDrawingSizeF Method
SetGuid Method
SetInt32 Method
SetInt64 Method
SetInterval1D Method
SetInterval2D Method
SetLine Method
SetPath Method
SetPlane Method
SetPoint2D Method
SetPoint3D Method
SetPoint4D Method
SetSingle Method
SetString Method
SetVersion Method
TryGetBoolean Method
TryGetBoundingBox Method
TryGetByte Method
TryGetDate Method
TryGetDecimal Method
TryGetDouble Method
TryGetDrawingColor Method
TryGetDrawingPoint Method
TryGetDrawingPointF Method
TryGetDrawingRectangle Method
TryGetDrawingRectangleF Method
TryGetDrawingSize Method
TryGetDrawingSizeF Method
TryGetGuid Method
TryGetInt32 Method
TryGetInt64 Method
TryGetInterval1D Method
TryGetInterval2D Method
TryGetLine Method
TryGetPlane Method
TryGetPoint2D Method
TryGetPoint3D Method
TryGetPoint4D Method
TryGetSingle Method
TryGetString Method
TryGetVersion Method
Write Method
Click or drag to resize

GH_ChunkAddComment Method

Adds a text comment to this chunk. Comments are serialized only if the output flavour is a human readable format. Comments are never deserialized, they are purely for the benefit of the humans reading the file data.

Namespace:  GH_IO.Serialization
Assembly:  GH_IO (in GH_IO.dll)
Syntax
Copy
public void AddComment(
	string comment_text
)

Parameters

comment_text
Type: SystemString
The content of the comment, text might be altered if it contains invalid characters for a chosen format flavour.

Implements

GH_IWriterAddComment(String)
Exceptions
ExceptionCondition
ArgumentNullExceptionThrown if the content text is either null or empty.
See Also