Gets the index of this chunk. The index is set by the owner of this chunk. Indices smaller than zero imply no index has been set. The combination of name+index is always unique among a set of chunks in the same litter.

inherited fromGH_IChunk

ItemCount

int ItemCount { get; }

Gets the number of items contained in this chunk.

inherited fromGH_IChunk

Items

List<GH_Item> Items { get; }

Gets a pointer to the internal list of items. Do not access this list unless you know what you are doing.

inherited fromGH_IChunk

Name

string Name { get; }

Gets the name of this chunk. The name is set by the owner of this chunk. Names must be at least 1 character long. The combination of name+index is always unique among a set of chunks in a single litter.

inherited fromGH_IChunk

Methods

AddMessage

void AddMessage(string m, GH_Message_Type t)

Log a new message with the top-level archive. Messages are collected during read/write operations, and can be displayed to the user upon completion using GH_Archive.ShowMessageLog().

inherited fromGH_IChunk

Parameters:

m (string)	Message text.
t (GH_Message_Type)	Message type.

ChunkExists

bool ChunkExists(string name, int index)

Checks whether a chunk with the specified name and index exists in the litter. Only chunks with index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

name (string)	Name of chunk to test for.
index (int)	Index of chunk to test for. If less than zero, ChunkExists(string chunk_name) is called instead.

Returns: True if a chunk with the specified name and index exists, otherwise false.

ChunkExists

bool ChunkExists(string name)

Checks whether a chunk with the specified name exists in the litter. Only chunks without index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

name (string)

Name of chunk to test for.

Returns: True if a chunk with the specified name exists, otherwise false.

FindChunk

GH_IReader FindChunk(string name, int index)

Finds the first chunk in the list that matches the given name and index. Only chunks with index qualifiers are considered.

Parameters:

name (string)	Name of chunk to search for.
index (int)	Index of chunk to search for. If less than zero, FindChunk(string chunk_name) is called instead.

Returns: The child chunk that matches the given name and index, or null of no matching chunk could be found.

FindChunk

GH_IReader FindChunk(string name)

Finds the first chunk in the litter that matches the given name. Only chunks without index qualifiers are considered.

Parameters:

name (string)

Name of chunk to search for.

Returns: The child chunk that matches the given name, or null of no matching chunk could be found.

FindItem

GH_Item FindItem(string name, int index)

Finds the first item that matches the given name and index. Only items with index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

name (string)	Name of item to search for.
index (int)	Index of item to search for. If less than zero, then FindItem(string name) is called instead.

Returns: The item that matches the given name and index, or null of no matching item could be found.

FindItem

GH_Item FindItem(string name)

Finds the first item that matches the given name. Only items without index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

name (string)

Name of item to search for.

Returns: The item that matches the given name, or null of no matching item could be found.

GetBoolean

bool GetBoolean(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetBoolean

bool GetBoolean(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetBoundingBox

GH_BoundingBox GetBoundingBox(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetBoundingBox

GH_BoundingBox GetBoundingBox(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetByte

byte GetByte(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetByte

byte GetByte(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetByteArray

byte[] GetByteArray(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetByteArray

byte[] GetByteArray(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDate

DateTime GetDate(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDate

DateTime GetDate(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDecimal

decimal GetDecimal(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDecimal

decimal GetDecimal(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDouble

double GetDouble(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDouble

double GetDouble(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDoubleArray

double[] GetDoubleArray(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDoubleArray

double[] GetDoubleArray(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingBitmap

Bitmap GetDrawingBitmap(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingBitmap

Bitmap GetDrawingBitmap(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingColor

Color GetDrawingColor(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingColor

Color GetDrawingColor(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingPoint

Point GetDrawingPoint(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingPoint

Point GetDrawingPoint(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingPointF

PointF GetDrawingPointF(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingPointF

PointF GetDrawingPointF(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingRectangle

Rectangle GetDrawingRectangle(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingRectangle

Rectangle GetDrawingRectangle(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingRectangleF

RectangleF GetDrawingRectangleF(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingRectangleF

RectangleF GetDrawingRectangleF(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingSize

Size GetDrawingSize(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingSize

Size GetDrawingSize(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetDrawingSizeF

SizeF GetDrawingSizeF(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetDrawingSizeF

SizeF GetDrawingSizeF(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetGuid

Guid GetGuid(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetGuid

Guid GetGuid(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetInt32

int GetInt32(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetInt32

int GetInt32(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetInt64

long GetInt64(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetInt64

long GetInt64(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetInterval1D

GH_Interval1D GetInterval1D(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetInterval1D

GH_Interval1D GetInterval1D(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetInterval2D

GH_Interval2D GetInterval2D(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetInterval2D

GH_Interval2D GetInterval2D(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetLine

GH_Line GetLine(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetLine

GH_Line GetLine(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetPath

string[] GetPath(string item_name, int item_index, string basePath)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
basePath (string)	Base path for relative path resolution.

Returns: An array of path strings. If the resolved relative path is different from the stored absolute path, two strings will be returned.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetPath

string[] GetPath(string item_name, string basePath)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
basePath (string)	Base path for relative path resolution.

Returns: An array of path strings. If the resolved relative path is different from the stored absolute path, two strings will be returned.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetPlane

GH_Plane GetPlane(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetPlane

GH_Plane GetPlane(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetPoint2D

GH_Point2D GetPoint2D(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetPoint2D

GH_Point2D GetPoint2D(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetPoint3D

GH_Point3D GetPoint3D(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetPoint3D

GH_Point3D GetPoint3D(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetPoint4D

GH_Point4D GetPoint4D(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetPoint4D

GH_Point4D GetPoint4D(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetSingle

float GetSingle(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetSingle

float GetSingle(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetString

string GetString(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetString

string GetString(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

GetVersion

GH_Version GetVersion(string item_name, int item_index)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

GetVersion

GH_Version GetVersion(string item_name)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

ItemExists

bool ItemExists(string name, int index)

Checks whether an item with the specified name and index exists. Only items with index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

name (string)	Name of item to test for.
index (int)	Index of item to test for. If index is less than zero, then ItemExists(string name) is called instead.

Returns: True if an item with the specified name and index exists, otherwise false.

ItemExists

bool ItemExists(string name)

Checks whether an item with the specified name exists. Only items without index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

name (string)

Name of item to test for.

Returns: True if an item with the specified name exists, otherwise false.

Read

void Read(BinaryReader reader)

Called when an object is required to deserialize itself.

inherited fromGH_IBinarySupport

Parameters:

reader (BinaryReader)

Reader object to be used for deserialization.

Read

void Read(XmlNode node)

Called when an object is required to deserialize itself.

inherited fromGH_IXmlSupport

Parameters:

node (XmlNode)

Node object to be used for deserialization.

TryGetBoolean

bool TryGetBoolean(string item_name, int item_index, ref bool value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref bool)	Target of assignment.

Returns: True if the value was set.

TryGetBoolean

bool TryGetBoolean(string item_name, ref bool value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref bool)	Target of assignment.

Returns: True if the value was set.

TryGetBoundingBox

bool TryGetBoundingBox(string item_name, int item_index, ref GH_BoundingBox value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_BoundingBox)	Target of assignment.

Returns: True if the value was set.

TryGetBoundingBox

bool TryGetBoundingBox(string item_name, ref GH_BoundingBox value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_BoundingBox)	Target of assignment.

Returns: True if the value was set.

TryGetByte

bool TryGetByte(string item_name, int item_index, ref byte value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref byte)	Target of assignment.

Returns: True if the value was set.

TryGetByte

bool TryGetByte(string item_name, ref byte value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref byte)	Target of assignment.

Returns: True if the value was set.

TryGetDate

bool TryGetDate(string item_name, int item_index, ref DateTime value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref DateTime)	Target of assignment.

Returns: True if the value was set.

TryGetDate

bool TryGetDate(string item_name, ref DateTime value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref DateTime)	Target of assignment.

Returns: True if the value was set.

TryGetDecimal

bool TryGetDecimal(string item_name, int item_index, ref decimal value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref decimal)	Target of assignment.

Returns: True if the value was set.

TryGetDecimal

bool TryGetDecimal(string item_name, ref decimal value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref decimal)	Target of assignment.

Returns: True if the value was set.

TryGetDouble

bool TryGetDouble(string item_name, int item_index, ref double value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref double)	Target of assignment.

Returns: True if the value was set.

TryGetDouble

bool TryGetDouble(string item_name, ref double value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref double)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingColor

bool TryGetDrawingColor(string item_name, int item_index, ref Color value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Color)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingColor

bool TryGetDrawingColor(string item_name, ref Color value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Color)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingPoint

bool TryGetDrawingPoint(string item_name, int item_index, ref Point value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Point)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingPoint

bool TryGetDrawingPoint(string item_name, ref Point value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Point)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingPointF

bool TryGetDrawingPointF(string item_name, int item_index, ref PointF value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref PointF)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingPointF

bool TryGetDrawingPointF(string item_name, ref PointF value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref PointF)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingRectangle

bool TryGetDrawingRectangle(string item_name, int item_index, ref Rectangle value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Rectangle)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingRectangle

bool TryGetDrawingRectangle(string item_name, ref Rectangle value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Rectangle)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingRectangleF

bool TryGetDrawingRectangleF(string item_name, int item_index, ref RectangleF value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref RectangleF)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingRectangleF

bool TryGetDrawingRectangleF(string item_name, ref RectangleF value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref RectangleF)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingSize

bool TryGetDrawingSize(string item_name, int item_index, ref Size value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Size)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingSize

bool TryGetDrawingSize(string item_name, ref Size value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Size)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingSizeF

bool TryGetDrawingSizeF(string item_name, int item_index, ref SizeF value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref SizeF)	Target of assignment.

Returns: True if the value was set.

TryGetDrawingSizeF

bool TryGetDrawingSizeF(string item_name, ref SizeF value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref SizeF)	Target of assignment.

Returns: True if the value was set.

TryGetGuid

bool TryGetGuid(string item_name, int item_index, ref Guid value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Guid)	Target of assignment.

Returns: True if the value was set.

TryGetGuid

bool TryGetGuid(string item_name, ref Guid value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Guid)	Target of assignment.

Returns: True if the value was set.

TryGetInt32

bool TryGetInt32(string item_name, int item_index, ref int value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref int)	Target of assignment.

Returns: True if the value was set.

TryGetInt32

bool TryGetInt32(string item_name, ref int value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref int)	Target of assignment.

Returns: True if the value was set.

TryGetInt64

bool TryGetInt64(string item_name, int item_index, ref long value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref long)	Target of assignment.

Returns: True if the value was set.

TryGetInt64

bool TryGetInt64(string item_name, ref long value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref long)	Target of assignment.

Returns: True if the value was set.

TryGetInterval1D

bool TryGetInterval1D(string item_name, int item_index, ref GH_Interval1D value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Interval1D)	Target of assignment.

Returns: True if the value was set.

TryGetInterval1D

bool TryGetInterval1D(string item_name, ref GH_Interval1D value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Interval1D)	Target of assignment.

Returns: True if the value was set.

TryGetInterval2D

bool TryGetInterval2D(string item_name, int item_index, ref GH_Interval2D value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Interval2D)	Target of assignment.

Returns: True if the value was set.

TryGetInterval2D

bool TryGetInterval2D(string item_name, ref GH_Interval2D value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Interval2D)	Target of assignment.

Returns: True if the value was set.

TryGetLine

bool TryGetLine(string item_name, int item_index, ref GH_Line value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Line)	Target of assignment.

Returns: True if the value was set.

TryGetLine

bool TryGetLine(string item_name, ref GH_Line value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Line)	Target of assignment.

Returns: True if the value was set.

TryGetPlane

bool TryGetPlane(string item_name, int item_index, ref GH_Plane value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Plane)	Target of assignment.

Returns: True if the value was set.

TryGetPlane

bool TryGetPlane(string item_name, ref GH_Plane value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Plane)	Target of assignment.

Returns: True if the value was set.

TryGetPoint2D

bool TryGetPoint2D(string item_name, int item_index, ref GH_Point2D value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Point2D)	Target of assignment.

Returns: True if the value was set.

TryGetPoint2D

bool TryGetPoint2D(string item_name, ref GH_Point2D value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Point2D)	Target of assignment.

Returns: True if the value was set.

TryGetPoint3D

bool TryGetPoint3D(string item_name, int item_index, ref GH_Point3D value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Point3D)	Target of assignment.

Returns: True if the value was set.

TryGetPoint3D

bool TryGetPoint3D(string item_name, ref GH_Point3D value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Point3D)	Target of assignment.

Returns: True if the value was set.

TryGetPoint4D

bool TryGetPoint4D(string item_name, int item_index, ref GH_Point4D value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Point4D)	Target of assignment.

Returns: True if the value was set.

TryGetPoint4D

bool TryGetPoint4D(string item_name, ref GH_Point4D value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Point4D)	Target of assignment.

Returns: True if the value was set.

TryGetSingle

bool TryGetSingle(string item_name, int item_index, ref float value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref float)	Target of assignment.

Returns: True if the value was set.

TryGetSingle

bool TryGetSingle(string item_name, ref float value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref float)	Target of assignment.

Returns: True if the value was set.

TryGetString

bool TryGetString(string item_name, int item_index, ref string value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref string)	Target of assignment.

Returns: True if the value was set.

TryGetString

bool TryGetString(string item_name, ref string value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref string)	Target of assignment.

Returns: True if the value was set.

TryGetVersion

bool TryGetVersion(string item_name, int item_index, ref GH_Version value)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Version)	Target of assignment.

Returns: True if the value was set.

TryGetVersion

bool TryGetVersion(string item_name, ref GH_Version value)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Version)	Target of assignment.

Returns: True if the value was set.

Write

void Write(BinaryWriter writer)

Called when an object is required to serialize itself.

inherited fromGH_IBinarySupport

Parameters:

writer (BinaryWriter)

Writer object to be used for serialization.

Write

void Write(XmlWriter writer)

Called when an object is required to serialize itself.

inherited fromGH_IXmlSupport

Parameters:

writer (XmlWriter)

Writer object to be used for serialization.