FieldDictionary

References
[DebuggerDisplay("{DebuggerDisplay, nq}")] public sealed class FieldDictionary : IEnumerable
Dictionary containing RenderContent data fields. Add fields to this dictionary in your derived RenderContent classes constructor. Get field values using the TryGet[data type]() methods and set them using the Set() method.
[System.Runtime.InteropServices.Guid("ABE4059B-9BD7-451C-91B2-67C2F188860A")] public class CustomMaterial : RenderMaterial { public override string TypeName { get { return "CSharp Custom Material"; } } public override string TypeDescription { get { return "My first custom .NET material"; } } public CustomMaterial() { Fields.AddField("bool", false, "Yes/No"); Fields.AddField("color", Rhino.Display.Color4f.White, "Color"); } }

Methods

Add

#Since v7.3
public BoolField Add(string key, bool value, string prompt, int sectionId)
Add a new BoolField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (bool)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public BoolField Add(string key, bool value, string prompt)
Add a new BoolField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (bool)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public BoolField Add(string key, bool value)
Add a new BoolField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (bool)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public ByteArrayField Add(string key, byte[] value)
AddField a new ByteArrayField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (byte[])Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Color4fField Add(string key, Color value, string prompt)
Add a new Color4fField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Color)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Color4fField Add(string key, Color value)
Add a new Color4fField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Color)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public Color4fField Add(string key, Color4f value, string prompt, int sectionId)
Add a new Color4fField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Color4f)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Color4fField Add(string key, Color4f value, string prompt)
Add a new Color4fField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Color4f)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Color4fField Add(string key, Color4f value)
Add a new Color4fField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Color4f)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public DateTimeField Add(string key, DateTime value, string prompt, int sectionId)
Add a new DateTimeField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (DateTime)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public DateTimeField Add(string key, DateTime value, string prompt)
Add a new DateTimeField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (DateTime)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public DateTimeField Add(string key, DateTime value)
Add a new DateTimeField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (DateTime)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public DoubleField Add(string key, double value, string prompt, int sectionId)
Add a new DoubleField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (double)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public DoubleField Add(string key, double value, string prompt)
Add a new DoubleField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (double)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public DoubleField Add(string key, double value)
AddField a new DoubleField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (double)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public FloatField Add(string key, float value, string prompt, int sectionId)
AddField a new FloatField to the dictionary.
key (string)Key name for the field value to add. See important note above
value (float)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public FloatField Add(string key, float value, string prompt)
AddField a new FloatField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (float)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public FloatField Add(string key, float value)
Add a new FloatField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (float)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public GuidField Add(string key, Guid value, string prompt, int sectionId)
Add a new GuidField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Guid)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public GuidField Add(string key, Guid value, string prompt)
Add a new GuidField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Guid)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public GuidField Add(string key, Guid value)
Add a new GuidField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Guid)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public IntField Add(string key, int value, string prompt, int sectionId)
Add a new IntField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (int)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public IntField Add(string key, int value, string prompt)
Add a new IntField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (int)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public IntField Add(string key, int value)
Add a new IntField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (int)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.14
public NullField Add(string key, string prompt, int sectionId)
Add a new NullField to the dictionary.
key (string)Key name for the field value to add. See important note above.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)Id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public Point2dField Add(string key, Point2d value, string prompt, int sectionId)
Add a new Point2dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Point2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Point2dField Add(string key, Point2d value, string prompt)
Add a new Point2dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Point2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Point2dField Add(string key, Point2d value)
Add a new Point2dField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Point2d)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public Point3dField Add(string key, Point3d value, string prompt, int sectionId)
Add a new Point3dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Point3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Point3dField Add(string key, Point3d value, string prompt)
Add a new Point3dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Point3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Point3dField Add(string key, Point3d value)
Add a new Point3dField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Point3d)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public Point4dField Add(string key, Point4d value, string prompt, int sectionId)
Add a new Point4dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Point4d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Point4dField Add(string key, Point4d value, string prompt)
Add a new Point4dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Point4d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Point4dField Add(string key, Point4d value)
Add a new Point4dField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Point4d)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public StringField Add(string key, string value, string prompt, int sectionId)
Add a new StringField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (string)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public StringField Add(string key, string value, string prompt)
Add a new StringField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (string)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public StringField Add(string key, string value)
Add a new StringField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (string)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public TransformField Add(string key, Transform value, string prompt, int sectionId)
Add a new TransformField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Transform)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public TransformField Add(string key, Transform value, string prompt)
Add a new TransformField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Transform)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public TransformField Add(string key, Transform value)
Add a new TransformField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Transform)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public Vector2dField Add(string key, Vector2d value, string prompt, int sectionId)
Add a new Vector2dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Vector2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Vector2dField Add(string key, Vector2d value, string prompt)
Add a new Vector2dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Vector2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Vector2dField Add(string key, Vector2d value)
Add a new Vector2dField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Vector2d)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v7.3
public Vector3dField Add(string key, Vector3d value, string prompt, int sectionId)
Add a new Vector3dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Vector3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Vector3dField Add(string key, Vector3d value, string prompt)
Add a new Vector3dField to the dictionary.
key (string)Key name for the field value to add. See important note above.
value (Vector3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

Add

#Since v5.1
public Vector3dField Add(string key, Vector3d value)
Add a new Vector3dField to the dictionary. This will be a data only field and not show up in the content browsers.
key (string)Key name for the field value to add. See important note above.
value (Vector3d)Initial value for this field.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddFilename

#Since v7.4
public StringField AddFilename(string key, string value, string prompt, int sectionId)
Add a new StringField to the dictionary which will reference a filename. A file watcher will automatically be attached to the referenced file, and the content will be considered changed when the file is changed on disk.
key (string)Key name for the field value to add. See important note above.
value (string)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public BoolField AddTextured(string key, bool value, string prompt, bool treatAsLinear, int sectionId)
Add a new BoolField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (bool)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public BoolField AddTextured(string key, bool value, string prompt, bool treatAsLinear)
Add a new BoolField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (bool)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public BoolField AddTextured(string key, bool value, string prompt)
Add a new BoolField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (bool)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Color4fField AddTextured(string key, Color value, string prompt, bool treatAsLinear)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Color)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public Color4fField AddTextured(string key, Color value, string prompt)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Color)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public Color4fField AddTextured(string key, Color4f value, string prompt, bool treatAsLinear, int sectionId)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Color4f)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Color4fField AddTextured(string key, Color4f value, string prompt, bool treatAsLinear)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Color4f)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7 Obsolete v7.0
public Color4fField AddTextured(string key, Color4f value, string prompt)
key (string)
value (Color4f)
prompt (string)

AddTextured

#Since v7.3
public DateTimeField AddTextured(string key, DateTime value, string prompt, bool treatAsLinear, int sectionId)
Add a new DateTimeField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (DateTime)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public DateTimeField AddTextured(string key, DateTime value, string prompt, bool treatAsLinear)
Add a new DateTimeField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (DateTime)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public DateTimeField AddTextured(string key, DateTime value, string prompt)
Add a new DateTimeField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (DateTime)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public DoubleField AddTextured(string key, double value, string prompt, bool treatAsLinear, int sectionId)
Add a new DoubleField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (double)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public DoubleField AddTextured(string key, double value, string prompt, bool treatAsLinear)
Add a new DoubleField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (double)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public DoubleField AddTextured(string key, double value, string prompt)
Add a new DoubleField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (double)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public FloatField AddTextured(string key, float value, string prompt, bool treatAsLinear, int sectionId)
Add a new FloatField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above
value (float)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public FloatField AddTextured(string key, float value, string prompt, bool treatAsLinear)
Add a new FloatField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (float)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public FloatField AddTextured(string key, float value, string prompt)
Add a new FloatField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (float)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public GuidField AddTextured(string key, Guid value, string prompt, bool treatAsLinear, int sectionId)
Add a new GuidField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Guid)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public GuidField AddTextured(string key, Guid value, string prompt, bool treatAsLinear)
Add a new GuidField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Guid)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public GuidField AddTextured(string key, Guid value, string prompt)
Add a new GuidField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Guid)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public IntField AddTextured(string key, int value, string prompt, bool treatAsLinear, int sectionId)
Add a new IntField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (int)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public IntField AddTextured(string key, int value, string prompt, bool treatAsLinear)
Add a new IntField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (int)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public IntField AddTextured(string key, int value, string prompt)
Add a new IntField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (int)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.14
public NullField AddTextured(string key, string prompt, bool treatAsLinear, int sectionId)
Add a new NullField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.14
public NullField AddTextured(string key, string prompt, bool treatAsLinear)
Add a new NullField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.14
public NullField AddTextured(string key, string prompt)
Add a new NullField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Point2dField AddTextured(string key, Point2d value, string prompt, bool treatAsLinear, int sectionId)
Add a new Point2dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Point2dField AddTextured(string key, Point2d value, string prompt, bool treatAsLinear)
Add a new Point2dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public Point2dField AddTextured(string key, Point2d value, string prompt)
Add a new Point2dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Point3dField AddTextured(string key, Point3d value, string prompt, bool treatAsLinear, int sectionId)
Add a new Point3dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Point3dField AddTextured(string key, Point3d value, string prompt, bool treatAsLinear)
Add a new Point3dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public Point3dField AddTextured(string key, Point3d value, string prompt)
Add a new Point3dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public Point4dField AddTextured(string key, Point4d value, string prompt, bool treatAsLinear, int sectionId)
Add a new Point4dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point4d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Point4dField AddTextured(string key, Point4d value, string prompt, bool treatAsLinear)
Add a new Point4dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point4d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public Point4dField AddTextured(string key, Point4d value, string prompt)
Add a new Point4dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Point4d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public StringField AddTextured(string key, string value, string prompt, bool treatAsLinear, int sectionId)
Add a new StringField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (string)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public StringField AddTextured(string key, string value, string prompt, bool treatAsLinear)
Add a new StringField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (string)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public StringField AddTextured(string key, string value, string prompt)
Add a new StringField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (string)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public TransformField AddTextured(string key, Transform value, string prompt, bool treatAsLinear, int sectionId)
Add a new TransformField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Transform)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public TransformField AddTextured(string key, Transform value, string prompt, bool treatAsLinear)
Add a new TransformField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Transform)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public TransformField AddTextured(string key, Transform value, string prompt)
Add a new TransformField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Transform)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.3
public Vector2dField AddTextured(string key, Vector2d value, string prompt, bool treatAsLinear, int sectionId)
Add a new Vector2dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Vector2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Vector2dField AddTextured(string key, Vector2d value, string prompt, bool treatAsLinear)
Add a new Vector2dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Vector2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public Vector2dField AddTextured(string key, Vector2d value, string prompt)
Add a new Vector2dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Vector2d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Vector3dField AddTextured(string key, Vector3d value, string prompt, bool treatAsLinear, int sectionId)
Add a new Vector3dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Vector3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId (int)The id of the section containing the field
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v7.0
public Vector3dField AddTextured(string key, Vector3d value, string prompt, bool treatAsLinear)
Add a new Vector3dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Vector3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
treatAsLinear (bool)Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
ArgumentExceptionAn element with the same key already exists in the dictionary

AddTextured

#Since v5.7
public Vector3dField AddTextured(string key, Vector3d value, string prompt)
Add a new Vector3dField to the dictionary. This overload will cause the field to be tagged as "textured" so that the texturing UI will appear in automatic UIs.
key (string)Key name for the field value to add. See important note above.
value (Vector3d)Initial value for this field.
prompt (string)Prompt to display in the user interface (Content Browsers) if this is null or an empty string the this field is a data only field and will not appear in the user interface.
ArgumentExceptionAn element with the same key already exists in the dictionary

ContainsField

#Since v5.1
public bool ContainsField(string fieldName)
Call this method to determine if a this FieldsList contains a field with the specified field name.
fieldName (string)Field to search for
Returns true if a field with that matches fieldName is found or false if it is not found.

GetEnumerator

#Since v6.0
public IEnumerator<Field> GetEnumerator()

GetField

#Since v5.3
public Field GetField(string fieldName)
Call this method to get the field with the specified name.
fieldName (string)Field name to search for.
If the field exists in the Fields dictionary then the field is returned otherwise; null is returned.

RemoveField

#Since v6.0
public void RemoveField(string fieldName)
fieldName (string)

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, bool value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (bool)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, bool value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (bool)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, byte[] value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (byte[])New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, byte[] value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (byte[])New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Color value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Color)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Color value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Color)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Color4f value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Color4f)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Color4f value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Color4f)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, DateTime value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (DateTime)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, DateTime value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (DateTime)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, double value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (double)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, double value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (double)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, float value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (float)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, float value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (float)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Guid value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Guid)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Guid value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Guid)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, int value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (int)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, int value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (int)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Point2d value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Point2d)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Point2d value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Point2d)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Point3d value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Point3d)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Point3d value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Point3d)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Point4d value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Point4d)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Point4d value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Point4d)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, string value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (string)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, string value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (string)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Transform value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Transform)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Transform value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Transform)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Vector2d value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Vector2d)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Vector2d value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Vector2d)New value for this field.

Set

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public void Set(string key, Vector3d value, ChangeContexts changeContext)
obsoleteUse version without ChangeContexts
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Vector3d)New value for this field.
changeContext (RenderContent.ChangeContexts)The reason why the value is changing.

Set

#Since v5.1
public void Set(string key, Vector3d value)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
key (string)Key name for the field value to change. See important note above.
value (Vector3d)New value for this field.

SetTag

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public bool SetTag(string key, object tag)
Sets an object that contains data to associate with the field. THIS IS NOW OBSOLETE - if you were using this, please email andy@mcneel.com and let me know why.
key (string)Key name for the field to tag.
tag (object)Data to associate with the field.
True if the field is found and the tag was set otherwise false is returned.
Explicit

IEnumerable.GetEnumerator

#Since v6.0
IEnumerator IEnumerable.GetEnumerator()

TryGetTag

#Since v5.1 Obsolete v6.0
[EditorBrowsable(EditorBrowsableState.Never)] public bool TryGetTag(string key, out object tag)
Gets object that contains data associate with a field. THIS IS NOW OBSOLETE - if you were using this, please email andy@mcneel.com and let me know why.
key (string)Key name of the field to get.
tag (out object)Data associated with the field.
Returns true if the field is found and its tag was retrieved otherwise; returns false.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out bool value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out bool)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out byte[] value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out byte[])Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Color value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Color)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Color4f value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Color4f)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out DateTime value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out DateTime)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out double value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out double)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out float value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out float)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Guid value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Guid)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out int value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out int)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Point2d value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Point2d)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Point3d value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Point3d)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Point4d value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Point4d)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out string value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out string)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Transform value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Transform)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Vector2d value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Vector2d)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue

#Since v5.1
public bool TryGetValue(string key, out Vector3d value)
Find a field with the specified key and get its value if found.
key (string)Key name of the field to get a value for.
value (out Vector3d)Output parameter which will receive the field value.
Returns true if the key is found and the value parameter is set to the field value. Returns false if the field was not found.

TryGetValue<T>

#Since v6.12
public bool TryGetValue<T>(string key, out T value)
Parametrized version of TryGetValue.
key (string)Name of field to find.
value (out T)out parameter to be set.
true if field was found. If false out parameter value will be set to default(T).