IWriteMetadataContext

This topic describes the properties and methods of the IWriteMetadataContext interface.

IshType

Gets the object ISH Type: ISHMasterDoc, ISHModule, ISHIllustration, ISHTemplate or ISHLibrary.

LogicalId

Gets the object logical id.

IshLngRef

Gets the unique identifier of the language level. If the language level is not available, null is returned.

EventQueue

Gets the event queue service which allows adding a background task.

LogService

Gets the log service.

GetOriginalNumberFieldValue

Returns the single-value number field original value.
name
The field name.
level
The field level.

GetOriginalDateTimeFieldValue

Returns the single-value date and time field original value.

name
The field name.
level
The field level.

GetOriginalStringFieldValue

Returns the original value of the single-value string field or the original label for LOV and card fields.
name
The field name.
level
The field level.

GetOriginalStringFieldValue

Returns the original value of the single-value string field or the original label for LOV and card fields. If you specify valuetype=element, the elementname of the values is returned for LOV and card fields. This method cannot be used to get a string representation of a date or number field.

name
The field name.
level
The field level.
valueType
The value type

GetOriginalMultiNumberFieldValue

Returns the multi-value number field original value.
name
The field name.
level
The field level.

GetOriginalMultiDateTimeFieldValue

Returns the multi-value date and time field original value.

name
The field name.
level
The field level.

GetOriginalMultiStringFieldValue

Returns the multi-value string field original value (labels for LOV and card fields). This method cannot be used to get a string representations of a multi-value date or number field.

name
The field name.
level
The field level.

GetOriginalMultiStringFieldValue

Returns the multi-value string field original value (labels for LOV and card fields). If you specify valuetype=element, the elementname of the values is returned for LOV and card fields. This method cannot be used to get a string representations of a multi-value date or number field.

name
The field name.
level
The field level.
valueType
The value type

GetOriginalFieldValueAsString

Returns the original field value for any type of field as a string
name
The field name.
level
The field level.

GetOriginalFieldValueAsString

Returns the original field value for any type of field as a string
name
The field name.
level
The field level.
valueType
The value type

GetLanguage

Returns the language of the user
valueType

The type of the value. The allowed values are "value" and "element".

ValueType "value" will return "en" while ValueType "element" will return "VLANGUAGEEN".

SetNumberFieldValue

Sets the single-value number field value.
name
The field name.
level
The field level.
value
The new value of the field.

SetDateTimeFieldValue

Sets the single-value date and time field value.
name
The field name.
level
The field level.
value
The new value of the field.

SetStringFieldValue

Sets the single-value string field value or the label for LOV and card fields. This method cannot be used to set a string representation of a date or number field.
name
The field name.
level
The field level.
value
The new value of the field.

SetStringFieldValue

Sets the single-value string field value or the label for LOV and card fields. If you specify valuetype=element, the elementname of the values is set for LOV and card fields. This method cannot be used to set a string representation of a date or number field.
name
The field name.
level
The field level.
value
The new value of the field.
valueType
The value type

SetMultiNumberFieldValue

Sets the multi-value number field value.
name
The field name.
level
The field level.
value
List with the new values for the field.

SetMultiDateTimeFieldValue

Sets the multi-value date and time field value.
name
The field name.
level
The field level.
value
List with the new values for the field.

SetMultiStringFieldValue

Sets the multi-value string field value (labels for LOV and card fields). This method cannot be used to set a string representations of a multi-value date or number field.
name
The field name.
level
The field level.
value
List with the new values for the field.

SetMultiStringFieldValue

Sets the multi-value string field value (labels for LOV and card fields). If you specify valuetype=element, the elementname of the values is set for LOV and card fields. This method cannot be used to set a string representations of a multi-value date or number field.
name
The field name.
level
The field level.
value
List with the new values for the field.
valueType
The value type

IsFieldValueChanged

Indicates whether the field value changed.
name
The field name.
level
The field level.

IsFieldAvailable

Indicates whether the field is available for retrieval.

name
The field name.
level
The field level.

GetFieldType

Returns the field type.

name
The field name.
level
The field level.

MultiValueSeparator

The multi value separator of the current project.

DateTimeFormat

The standard date time format.

GetFieldValueAsString

Returns the field value as a string. You can use any type of field.

name
The field name.
level
The field level.

GetFieldValueAsString

Returns the field value as a string. You can use any type of field.

If you specify valuetype=element, the element name of the values is returned for LOV and card fields.

If you specify valuetype=id the internal card id is returned for LOV and card fields.

name
The field name.
level
The field level.
valueType
The value type.

GetNumberFieldValue

Returns the single-value number field value.
name
The field name.
level
The field level.

GetDateTimeFieldValue

Returns the single-value date and time field value.

name
The field name.
level
The field level.

GetStringFieldValue

Returns the single-value string field value (the label) for LOV and card fields.

This method cannot be used to get a string representation of a date or number field.

name
The field name.
level
The field level.

GetStringFieldValue

Returns the single-value string field value (the label) for LOV and card fields.

If you specify valuetype=element, the element name of the values is returned for LOV and card fields.

If you specify valuetype=id the internal card id is returned for LOV and card fields.

This method cannot be used to get a string representation of a date or number field.

name
The field name.
level
The field level.
valueType
The value type.

GetMultiNumberFieldValue

Returns the multi-value number field value.
name
The field name.
level
The field level.

GetMultiDateTimeFieldValue

Returns the multi-value date and time field value.

name
The field name.
level
The field level.

GetMultiStringFieldValue

Returns the multi-value string field value (labels for LOV and card fields).

This method cannot be used to get a string representations of a multi-value date or number field.

name
The field name.
level
The field level.

GetMultiStringFieldValue

Returns the multi-value string field value (labels for LOV and card fields).

If you specify valuetype=element, the element name of the values is returned for LOV and card fields.

If you specify valuetype=id the internal card id is returned for LOV and card fields.

This method cannot be used to get a string representations of a multi-value date or number field.

name
The field name.
level
The field level.
valueType
The value type