Namespace: Autodesk.Revit.DB.ExtensibleStorage Class: Entity

Entity.Set<FieldType>(String, FieldType, ForgeTypeId)

Method

Description:
Stores the value of the field in the entity.

Remarks:

The template parameter must match the type of the field (specified when creating the Schema) exactly; this method does not perform data type conversions. The types for containers are IList for arrays and IDictionary for maps.

This method only modifies your copy of the Entity. Store the Entity in an element or another Entity to save the new value. Write access check is not performed on each call to Set. Instead, write access is checked when you try to save the Entity in an Element or another Entity.

This method is a shortcut that will look up the field by name. If you want to call it on many entities, it is faster if you look up the field yourself.

Syntax

public void Set<FieldType>(
	string fieldName,
	FieldType value,
	ForgeTypeId unitTypeId
)

Public Sub Set(Of FieldType) ( 
	fieldName As String,
	value As FieldType,
	unitTypeId As ForgeTypeId
)

public:
generic<typename FieldType>
void Set(
	String^ fieldName, 
	FieldType value, 
	ForgeTypeId^ unitTypeId
)

member Set : 
        fieldName : string * 
        value : 'FieldType * 
        unitTypeId : ForgeTypeId -> unit

Parameters

Parameter	Type	Description
fieldName	String	The name of the field to update.
value
unitTypeId	ForgeTypeId	Identifier of the unit from which the value will be converted before storing. Must be compatible with the spec specified when creating the Schema.

Return Value

Exceptions

Exception	Condition
ArgumentNullException	A non-optional argument was NULL
InvalidOperationException	The Field belongs to a different Schema from this Entity, or this Entity is invalid.
ArgumentException	Requested type does not match the field type.
ArgumentException	The name matches no field in this Entity's Schema.
ArgumentException	The unitTypeId value is not compatible with the field description.
ArgumentException	This field's subschema prevents writing.
ArgumentException	Invalid floating-point value.