StringField

FieldReferences
public class StringField : Field
String field value class

Properties

AutomaticRegisteredProperty

public bool AutomaticRegisteredProperty { get; set; }
inherited fromField

IsHiddenInAutoUI

public bool IsHiddenInAutoUI { get; set; }
When fields are used by the automatic UI, they can be hidden from it by calling this method.
inherited fromField

Key

[EditorBrowsable(EditorBrowsableState.Never)] [DebuggerBrowsable(DebuggerBrowsableState.Never)] public string Key { get; }
obsoleteThe Rhino.Render.Fields.Field.Key property is obsolete, use Name instead.
Field name value string passed to the constructor
inherited fromField

Name

public string Name { get; }
Field name value string passed to the constructor.
inherited fromField

Tag

public object Tag { get; set; }
Gets or sets an object that contains data to associate with the field.
inherited fromField
Returns: An object that contains information that is associated with the field.

TextureAmountMax

public double TextureAmountMax { get; set; }
Set Max value for Texture amount
inherited fromField

TextureAmountMin

public double TextureAmountMin { get; set; }
Set Min value for Texture amount
inherited fromField

UseTextureAmount

public bool UseTextureAmount { get; set; }
True if 'texture amount' is in use, otherwise false. The 'texture amount' is represented as a numeric stepper in the UI. If true, then the stepper is shown. If false, then the stepper is hidden.
inherited fromField

UseTextureOn

public bool UseTextureOn { get; set; }
True if 'texture on' is in use, otherwise false. In the UI 'texture on' is represented as a checkbox. If true then the checbox is shown. If false then the checkbox is not shown.
inherited fromField

Value

#Since v5.1
public string Value { get; set; }
Gets or sets the field value

Methods

CreateCppPointer

protected void CreateCppPointer(RenderContent content, string key, string prompt, object initialValue, bool isTextured, bool treatAsLinear)
inherited fromField
Parameters:
content (RenderContent)
key (string)
prompt (string)
initialValue (object)
isTextured (bool)
treatAsLinear (bool)

GetValue<T>

public T GetValue<T>()
Parametrized version of GetValue calling appropriate ValueAs* methods.
inherited fromField
Returns: Value of type T of the field

ValueAsBool

protected bool ValueAsBool()
Return field value as a bool.
inherited fromField
Returns: Returns field value as a bool.

ValueAsByteArray

protected byte[] ValueAsByteArray()
Return field as a byte array.
inherited fromField
Returns: Return field as a byte array.

ValueAsColor4f

protected Color4f ValueAsColor4f()
Return field as a Rhino.Display.Color4f color value.
inherited fromField
Returns: Return field as a Rhino.Display.Color4f color value.

ValueAsDateTime

protected DateTime ValueAsDateTime()
Return field as a DateTime value.
inherited fromField
Returns: Return field as a DateTime value.

ValueAsDouble

protected double ValueAsDouble()
Return field value as a double precision number.
inherited fromField
Returns: Return the field value as a double precision number.

ValueAsFloat

protected float ValueAsFloat()
Return field value as floating point number.
inherited fromField
Returns: Return the field value as an floating point number.

ValueAsGuid

protected Guid ValueAsGuid()
Return field value as Guid.
inherited fromField
Returns: Return the field value as an Guid.

ValueAsInt

protected int ValueAsInt()
Return field value as integer.
inherited fromField
Returns: Return the field value as an integer.

ValueAsObject

#Since v5.7
public override object ValueAsObject()
Overrides: Field.ValueAsObject

ValueAsPoint2d

protected Point2d ValueAsPoint2d()
Return field as a Rhino.Geometry.Point2d color value.
inherited fromField
Returns: Return field as a Rhino.Geometry.Point2d color value.

ValueAsPoint3d

protected Point3d ValueAsPoint3d()
Return field as a Rhino.Geometry.Point3d color value.
inherited fromField
Returns: Return field as a Rhino.Geometry.Point3d color value.

ValueAsPoint4d

protected Point4d ValueAsPoint4d()
Return field as a Rhino.Geometry.Point4d color value.
inherited fromField
Returns: Return field as a Rhino.Geometry.Point4d color value.

ValueAsString

protected string ValueAsString()
Get field value as a string.
inherited fromField
Returns: Returns the field value as a string if possible.

ValueAsTransform

protected Transform ValueAsTransform()
Return field as a Rhino.Geometry.Transform color value.
inherited fromField
Returns: Return field as a Rhino.Geometry.Transform color value.

ValueAsVector2d

protected Vector2d ValueAsVector2d()
Return field as a Rhino.Geometry.Vector2d color value.
inherited fromField
Returns: Return field as a Rhino.Geometry.Vector2d color value.

ValueAsVector3d

protected Vector3d ValueAsVector3d()
Return field as a Rhino.Geometry.Vector3d color value.
inherited fromField
Returns: Return field as a Rhino.Geometry.Vector3d color value.