MetadataValueType Property
The type of the metadata item's value.
Syntax
__property TicsBoxMetadataValueTypes MetadataValueType[int MetadataIndex] = { read=FMetadataValueType, write=FSetMetadataValueType };
enum TicsBoxMetadataValueTypes {
mtString=0,
mtNumber=1,
mtMultiSelect=2
};
Default Value
mtString
Remarks
The type of the metadata item's value.
This property specifies the type of the metadata item's value, and controls how the component encodes MetadataValue when submitting it to the server. Possible values, and their corresponding Box types, are:
| Value Type | Encoded As | Corresponding Box Types |
| 0 (mtString - default) | String | string, date, enum (single-select) |
| 1 (mtNumber) | Number | float (note: actually any numeric value, including integers) |
| 2 (mtMultiSelect) | Array of strings | enum (multi-select) |
The MetadataValue property should hold a comma-separated list of strings when this property is set to 2 (mtMultiSelect).
This property may be used as input when CreateMetadata or UpdateMetadata is called if the MetadataModOp property is set to one of the following:
- 1 (opAdd)
- 2 (opReplace)
- 6 (opTest)
Important: Box only allows string-typed metadata items in the /global/properties metadata container; the component will always ignore this property and encode metadata items as strings when creating or updating the /global/properties container.
The MetadataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.
This property is not available at design time.
Data Type
Integer