FieldDictionary
ReferencesDictionary 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.
Example:[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 a new BoolField to the dictionary.
public BoolField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new BoolField to the dictionary.
public BoolField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new BoolField to the dictionary. This will be a data only field and not show up in the content browsers.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
AddField a new ByteArrayField to the dictionary. This will be a data only field and not show up in the content browsers.
public ByteArrayField Add()
key,
Key name for the field value to add. See important note above.
byte[]
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Color4fField to the dictionary.
public Color4fField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Color4fField to the dictionary. This will be a data only field and not show up in the content browsers.
public Color4fField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Color4fField to the dictionary.
public Color4fField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Color4fField to the dictionary.
public Color4fField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Color4fField to the dictionary. This will be a data only field and not show up in the content browsers.
public Color4fField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new DateTimeField to the dictionary.
public DateTimeField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new DateTimeField to the dictionary.
public DateTimeField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new DateTimeField to the dictionary. This will be a data only field and not show up in the content browsers.
public DateTimeField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new DoubleField to the dictionary.
public DoubleField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new DoubleField to the dictionary.
public DoubleField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
AddField a new DoubleField to the dictionary. This will be a data only field and not show up in the content browsers.
public DoubleField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
AddField a new FloatField to the dictionary.
public FloatField Add()
key,
Key name for the field value to add. See important note above
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
AddField a new FloatField to the dictionary.
public FloatField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new FloatField to the dictionary. This will be a data only field and not show up in the content browsers.
public FloatField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new GuidField to the dictionary.
public GuidField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new GuidField to the dictionary.
public GuidField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new GuidField to the dictionary. This will be a data only field and not show up in the content browsers.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new IntField to the dictionary.
public IntField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new IntField to the dictionary.
public IntField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new IntField to the dictionary. This will be a data only field and not show up in the content browsers.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new NullField to the dictionary.
public NullField Add()
key,
Key name for the field value to add. See important note above.
prompt,
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
Id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point2dField to the dictionary.
public Point2dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point2dField to the dictionary.
public Point2dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point2dField to the dictionary. This will be a data only field and not show up in the content browsers.
public Point2dField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point3dField to the dictionary.
public Point3dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point3dField to the dictionary.
public Point3dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point3dField to the dictionary. This will be a data only field and not show up in the content browsers.
public Point3dField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point4dField to the dictionary.
public Point4dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point4dField to the dictionary.
public Point4dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Point4dField to the dictionary. This will be a data only field and not show up in the content browsers.
public Point4dField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new StringField to the dictionary.
public StringField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new StringField to the dictionary.
public StringField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new StringField to the dictionary. This will be a data only field and not show up in the content browsers.
public StringField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new TransformField to the dictionary.
public TransformField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new TransformField to the dictionary.
public TransformField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new TransformField to the dictionary. This will be a data only field and not show up in the content browsers.
public TransformField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Vector2dField to the dictionary.
public Vector2dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Vector2dField to the dictionary.
public Vector2dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Vector2dField to the dictionary. This will be a data only field and not show up in the content browsers.
public Vector2dField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Vector3dField to the dictionary.
public Vector3dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Vector3dField to the dictionary.
public Vector3dField Add()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Add a new Vector3dField to the dictionary. This will be a data only field and not show up in the content browsers.
public Vector3dField Add()
key,
Key name for the field value to add. See important note above.
value
Initial value for this field.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public StringField AddFilename()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public BoolField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public BoolField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public BoolField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Color4fField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Color4fField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Color4fField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Color4fField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public DateTimeField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public DateTimeField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public DateTimeField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public DoubleField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public DoubleField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public DoubleField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public FloatField AddTextured()
key,
Key name for the field value to add. See important note above
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public FloatField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public FloatField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public GuidField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public GuidField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public GuidField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public IntField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public IntField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public IntField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public NullField AddTextured()
key,
Key name for the field value to add. See important note above.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public NullField AddTextured()
key,
Key name for the field value to add. See important note above.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point2dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point2dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point2dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point3dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point3dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point3dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point4dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point4dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Point4dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public StringField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public StringField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public StringField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public TransformField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public TransformField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public TransformField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Vector2dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Vector2dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Vector2dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Vector3dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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,
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
sectionId
The id of the section containing the field
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Vector3dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt,
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
Determines whether the texture in this slot will be treated as linear by rendering engines (ie - not gamma packed).
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
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.
public Vector3dField AddTextured()
key,
Key name for the field value to add. See important note above.
value,
Initial value for this field.
prompt
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.
Exceptions:
| ArgumentException | An element with the same key already exists in the dictionary |
Call this method to determine if a this FieldsList contains a field with the specified field name.
Returns: Returns true if a field with that matches fieldName is found or false if it is not found.
Call this method to get the field with the specified name.
Returns: If the field exists in the Fields dictionary then the field is returned otherwise; null is returned.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
byte[]
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Set()
key,
Key name for the field value to change. See important note above.
value,
New value for this field.
changeContext
The reason why the value is changing.
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.
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.
Returns: True if the field is found and the tag was set otherwise false is returned.
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.
Returns: Returns true if the field is found and its tag was retrieved otherwise; returns false.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.
Find a field with the specified key and get its value if found.
Returns: 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.