Constructors
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (GH_BoundingBox) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (GH_Interval1D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (GH_Interval2D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (GH_Point2D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (GH_Point3D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (GH_Point4D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (GH_Version) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (Bitmap) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (bool) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (byte) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (byte[]) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (Color) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (DateTime) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (decimal) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (double) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (double[]) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (float) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_BoundingBox) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Interval1D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Interval2D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Line) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Plane) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Point2D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Point3D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Point4D) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (GH_Version) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (Guid) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (int) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (long) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (Point) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (PointF) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (Rectangle) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (RectangleF) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (Size) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (SizeF) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name, index and value.
Parameters:
| item_name (string) | Name of new item. |
| item_index (int) | Index of new item. Any index less than zero will be clamped to -1. |
| item_data (string) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Parameters:
| item_name (string) | Name of new item. |
| item_data (RectangleF) | Value of new item. |
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
GH_Item
#Construct a new instance of GH_Item with the specified name and value.
Exceptions:
| ArgumentNullException | Thrown if the specified name string is null or empty. |
Properties
_bool
#Returns the internal data of this item cast to a Boolean. If the data is not stored as a Boolean, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_boundingbox
#Returns the internal data of this item cast to a BoundingBox. If the data is not stored as a BoundingBox, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_byte
#Returns the internal data of this item cast to a Byte. If the data is not stored as a Byte, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_bytearray
#Returns the internal data of this item cast to a Byte array. If the data is not stored as a Byte array, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_date
#Returns the internal data of this item cast to a DateTime. If the data is not stored as a DateTime, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_decimal
#Returns the internal data of this item cast to a Decimal. If the data is not stored as a Decimal, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_double
#Returns the internal data of this item cast to a Double. If the data is not stored as a Double, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_doublearray
#Returns the internal data of this item cast to a Byte array. If the data is not stored as a Byte array, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_bitmap
#public Bitmap _drawing_bitmap { get; }
Returns the internal data of this item cast to a Bitmap. If the data is not stored as a Bitmap, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_color
#public Color _drawing_color { get; }
Returns the internal data of this item cast to a Color. If the data is not stored as a Color, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_point
#public Point _drawing_point { get; }
Returns the internal data of this item cast to a Point. If the data is not stored as a Point, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_pointf
#public PointF _drawing_pointf { get; }
Returns the internal data of this item cast to a PointF. If the data is not stored as a PointF, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_rectangle
#public Rectangle _drawing_rectangle { get; }
Returns the internal data of this item cast to a Rectangle. If the data is not stored as a Rectangle, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_rectanglef
#Returns the internal data of this item cast to a RectangleF. If the data is not stored as a RectangleF, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_size
#public Size _drawing_size { get; }
Returns the internal data of this item cast to a Size. If the data is not stored as a Size, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_drawing_sizef
#public SizeF _drawing_sizef { get; }
Returns the internal data of this item cast to a SizeF. If the data is not stored as a SizeF, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_guid
#Returns the internal data of this item cast to a Guid. If the data is not stored as a Guid, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_int32
#Returns the internal data of this item cast to an Int32. If the data is not stored as an Int32, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_int64
#Returns the internal data of this item cast to an Int64. If the data is not stored as an Int64, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_interval1d
#Returns the internal data of this item cast to an Interval1D. If the data is not stored as an Interval1D, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_interval2d
#Returns the internal data of this item cast to an Interval2D. If the data is not stored as an Interval2D, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_line
#Returns the internal data of this item cast to a Line. If the data is not stored as a Line, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_plane
#Returns the internal data of this item cast to a Plane. If the data is not stored as a Plane, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_point2d
#Returns the internal data of this item cast to a Point2D. If the data is not stored as a Point2D, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_point3d
#Returns the internal data of this item cast to a Point3D. If the data is not stored as a Point3D, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_point4d
#Returns the internal data of this item cast to a Point4D. If the data is not stored as a Point4D, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_single
#Returns the internal data of this item cast to a Single. If the data is not stored as a Single, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_string
#Returns the internal data of this item cast to a String. If the data is not stored as a String, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
_version
#Returns the internal data of this item cast to a Version. If the data is not stored as a Version, a conversion exception might be thrown.
Exceptions:
| OverflowException | Thrown if the type conversion fails. |
| InvalidCastException | Thrown if the type conversion is invalid. |
DebuggerDisplay
#[EditorBrowsable(EditorBrowsableState.Never)]
[Browsable(false)]
public string DebuggerDisplay { get; }
Readonly property used during Debugging.
HasIndex
#Gets the index existence implication. The item is considered to have an index qualifier if the index value is larger than or equal to zero.
HasName
#Gets the name validity of this item. The item is considered to have an invalid name if string.IsNullOrEmpty(name)
HasType
#Gets the type set validity of this item. The item is considered to have a type if type != GH_Types.unset
Index
#Gets or sets the index of an item. Typically, indices are set at construction and do not change. If you change indices after construction, you could corrupt an archive.
Value: Negative indices are clamped to -1.
Name
#Gets or sets the name of this item. Typically, names are set at construction and do not change. If you change names after construction, you could corrupt an archive.
Exceptions:
| ArgumentNullException | Thrown if the new name is null or empty. |
Methods
CreateFrom
#Creates a new instance of GH_Item and sets the fields from a reader object.
Parameters:
| reader (BinaryReader) | Reader object that defines the field data. |
Returns: The constructed and read item.
CreateFrom
#Creates a new instance of GH_Item and sets the fields from an Xml node object.
Parameters:
| node (XmlNode) | Xml node object that defines the field data. |
Returns: The constructed and read item.
Read
#Deserialize this item from a binary stream.
Parameters:
| reader (BinaryReader) | Reader to deserialize with. |
Implements: Read
Write
#Serialize this item into a binary stream.
Parameters:
| writer (BinaryWriter) | Writer to serialize with. |
Exceptions:
| MemberAccessException | Thrown if !HasName. |
| MemberAccessException | Thrown if !HasType. |
| IOException | Thrown if the internal data could not be serialized. |
Implements: Write
Write
#Serialize this item into an Xml stream.
Parameters:
| writer (XmlWriter) | Writer to serialize with. |
Exceptions:
| MemberAccessException | Thrown if !HasName. |
| MemberAccessException | Thrown if !HasType. |
| IOException | Thrown if the internal data could not be serialized. |
Implements: Write