IWriteMetadataContext
This topic describes the properties and methods of the IWriteMetadataContext interface.
Properties
| CurrentAction | Gets the current action. |
| IshType | Gets the ISH Type of the object: ISHMasterDoc, ISHModule, ISHIllustration, ISHTemplate, ISHLibrary, ISHPublication , ISHBaseline, ISHAnnotation or ISHProject. |
| LogicalId | Gets the logical ID of the object. |
| IshLogicalRef | Gets the unique identifier of the logical level. |
| IshVersionRef | Gets the unique identifier of the version level. If the version level is unavailable, null is returned. |
| 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.
|
| CurrentUserName | Gets the name of the current user. |
| CurrentUserId | Gets the ID of the current user. |
| HashId | Gets the unique identifier of the object. |
| DateTimeFormat | The standard date time format |
| MultiValueSeparator | The multi value separator of the current project |
Methods
- GetDateTimeFieldValue
- Returns the single-value date and time field value.
- GetFieldValueAsString
- Returns the field value as a string. You can use any type of field.
- GetFieldValueAsString
- Returns the field value as a string. You can use any type of field.
- GetFieldType
- Returns the field type
- GetLanguage
- Returns the language of the user
- GetMultiDateTimeFieldValue
- Returns the multi-value date and time field value.
- GetMultiNumberFieldValue
- Returns the multi-value number field value.
- GetMultiStringFieldValue
- Returns the multi-value string field value (the label) for LOV and card fields.
- GetMultiStringFieldValue
- Returns the multi-value string field value (the label) for LOV and card fields.
- GetNumberFieldValue
- Returns the single-value number field value.
- GetOriginalDateTimeFieldValue
- Returns the single-value date and time field original value.
- GetOriginalFieldValueAsString
- Returns the original field value for any type of field as a string
- GetOriginalFieldValueAsString
- Returns the original field value for any type of field as a string
- GetOriginalMultiDateTimeFieldValue
- Returns the multi-value date and time field original value.
- GetOriginalMultiNumberFieldValue
- Returns the multi-value number field original value.
- GetOriginalMultiStringFieldValue
- Returns the multi-value string field original value (labels for LOV and card fields).
- GetOriginalMultiStringFieldValue
- Returns the multi-value string field original value (labels for LOV and card fields).
- GetOriginalNumberFieldValue
- Returns the single-value number field original value.
- GetOriginalStringFieldValue
- Returns the original value of the single-value string field or the original label for LOV and card fields.
- GetOriginalStringFieldValue
- Returns the original value of the single-value string field or the original label for LOV and card fields.
- GetStringFieldValue
- Returns the single-value string field value (the label) for LOV and card fields.
- GetStringFieldValue
- Returns the single-value string field value (the label) for LOV and card fields.
- IsFieldAvailable
- Indicates whether the field is available for retrieval.
- IsFieldValueChanged
- Indicates whether the field value changed.
- IsObjectChanged
- Indicates whether the object is changed.
- SetDateTimeFieldValue
- Sets the single-value date and time field value.
- SetNumberFieldValue
- Sets the single-value number field value.
- SetMultiDateTimeFieldValue
- Sets the multi-value date and time field value.
- SetMultiNumberFieldValue
- Sets the multi-value number field value.
- 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.
- SetMultiStringFieldValue
- Sets the multi-value string field value (labels for LOV and card fields).
- SetStringFieldValue
- Sets the single-value string field value or the label for LOV and card fields.
- SetStringFieldValue
- Sets the single-value string field value or the label for LOV and card fields.