EntitySetFieldType(String, FieldType, ForgeTypeId) Method

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

fieldName  String

The name of the field to update.

value  FieldType

 

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.

Type Parameters

FieldType

The type of the field

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.

Reference