GH_Dimension.GH_DimensionProxy

GH_AnnotationBase.GH_AnnotationBaseProxy<1>GH_GooProxy<1>
public class GH_Dimension.GH_DimensionProxy : GH_AnnotationBase.GH_AnnotationBaseProxy<GH_Dimension>

Constructors

GH_DimensionProxy

#
public GH_DimensionProxy(GH_Dimension Value)
Parameters:
Value (GH_Dimension)

Properties

AnnotationStyle

[DisplayName("Annotation Style")] [Description("Annotation Style")] [Category("Style")] public string AnnotationStyle { get; }
inherited fromGH_AnnotationBase.GH_AnnotationBaseProxy<T>

AnnotationType

[DisplayName("Annotation Type")] [Description("Annotation Type")] [Category("Style")] public AnnotationType AnnotationType { get; }
inherited fromGH_AnnotationBase.GH_AnnotationBaseProxy<T>

IsParsable

[Browsable(false)] public virtual bool IsParsable { get; }
Gets a value indicating whether or not the type can be instantiated from a String.
inherited fromGH_GooProxy<T>
Implements: IsParsable

Measure

#
[Description("Annotation Text")] [Category("Geometry")] public string Measure { get; }

ObjectID

[Description("Object ID of referenced annotation")] [Category("Reference")] [DisplayName("Object ID")] [RefreshProperties(RefreshProperties.All)] public string ObjectID { get; set; }
inherited fromGH_AnnotationBase.GH_AnnotationBaseProxy<T>

Owner

[Browsable(false)] protected T Owner { get; }
inherited fromGH_GooProxy<T>

PlainText

[Description("Annotation Text")] [Category("Geometry")] public string PlainText { get; }
inherited fromGH_AnnotationBase.GH_AnnotationBaseProxy<T>

ProxyOwner

[Browsable(false)] public IGH_Goo ProxyOwner { get; }
Gets the piece of Grasshopper data that spawned this proxy.
inherited fromGH_GooProxy<T>
Implements: ProxyOwner

TypeDescription

[Description("Description of target data type")] [Category("Misc")] public string TypeDescription { get; }
inherited fromGH_GooProxy<T>

TypeName

[Description("Name of target data type")] [Category("Misc")] public string TypeName { get; }
inherited fromGH_GooProxy<T>

UserString

[Browsable(false)] public string UserString { get; set; }
Gets or sets the user-defined string that describes this proxy. This only really makes sense if the Proxy is Parsable.
inherited fromGH_GooProxy<T>
Returns: The UserString value or the value of FormatInstance() if UserString has not been assigned.
Implements: UserString

Valid

[Description("Validity of target data")] [Category("Misc")] public virtual bool Valid { get; }
Gets a value indicating whether this proxy represents valid data.
inherited fromGH_GooProxy<T>
Implements: Valid

Methods

Construct

#
public override void Construct()
Overrides: GH_GooProxy<T>.Construct

FormatInstance

public virtual string FormatInstance()
Returns a String description of the current value.
inherited fromGH_GooProxy<T>
Remarks: If the implementation IsParsable(), then this representation must be in parsable format.
Implements: FormatInstance

FromString

public virtual bool FromString(string in)
If IsParsable(), then attempts to convert the string to a generic type value
inherited fromGH_GooProxy<T>
Parameters:
in (string)The String to parse.
Returns: True on success, false on failure. This method should not throw exceptions.
Implements: FromString

MutateString

public virtual string MutateString(string in)
Munge a string to remove obvious errors on account of the user.
inherited fromGH_GooProxy<T>
Parameters:
in (string)
Implements: MutateString

NumberToString

protected string NumberToString(double number)
inherited fromGH_GooProxy<T>
Parameters:
number (double)

StringToNumber

protected double StringToNumber(string text)
inherited fromGH_GooProxy<T>
Parameters:
text (string)

ToString

public override string ToString()
inherited fromGH_GooProxy<T>
Overrides: Object.ToString