Documentation Center

IWriteBaselineItemsContext

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

Properties

CurrentActionGets the current action.
IshTypeGets the ISH Type of the object: ISHMasterDoc, ISHModule, ISHIllustration, ISHTemplate, ISHLibrary, ISHPublication , ISHBaseline or ISHAnnotation.
LogicalIdGets the logical ID of the object.
IshLogicalRefGets the unique identifier of the logical level.
EventQueueGets the event queue service, which allows adding a background task.
CurrentUserNameGets the name of the current user.
CurrentUserIdGets the ID of the current user.
HashIdGets the unique identifier of the object.
DateTimeFormatThe standard date time format
MultiValueSeparatorThe multi value separator of the current project
HasBaselineItemsSpecifies whether there are any baseline items in one of the lists.
ToBeInsertedGets the list of IBaselineItem objects that will be added to the baseline.
ToBeUpdatedGets the list of IBaselineItem objects that will be updated because a new version number was selected.
ToBeDeletedGets the list of IBaselineItem objects that will be removed from the baseline.

Methods

GetDateTimeFieldValue
Returns the single-value date and time field value.
name
The field name.
level
The field level.
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.
name
The field name.
level
The field level.
valueType
The value type. If set to element, the element name of the values is returned for LOV and card fields; if set to id, the internal card ID is returned for LOV and card fields.
GetFieldType
Returns the field type
name
The field name.
level
The field level.
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".

GetMultiDateTimeFieldValue
Returns the multi-value date and time field value.
name
The field name.
level
The field level.
GetMultiNumberFieldValue
Returns the multi-value number field value.
name
The field name.
level
The field level.
GetMultiStringFieldValue
Returns the multi-value string field value (the label) for LOV and card fields.
This method cannot be used to get string representations of date or number fields.
name
The field name.
level
The field level.
GetMultiStringFieldValue
Returns the multi-value string field value (the label) for LOV and card fields.
This method cannot be used to get string representations of date or number fields.
name
The field name.
level
The field level.
valueType
The value type. If set to element, the element name of the values is returned for LOV and card fields; if set to id, the internal card ID is returned for LOV and card fields.
GetNumberFieldValue
Returns the single-value number field 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.
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
GetOriginalMultiDateTimeFieldValue
Returns the multi-value date and time field original value.
name
The field name.
level
The field level.
GetOriginalMultiNumberFieldValue
Returns the multi-value number 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 string representations of multi-value date or number fields.
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.
valueType
The value type. If set to element, the element name of the values is returned for LOV and card fields.
GetOriginalNumberFieldValue
Returns the single-value number 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.
This method cannot be used to get a string representation of a date or number field.
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.
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. If set to element, the element name of the values is returned for LOV and card fields.
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.
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. If set to element, the element name of the values is returned for LOV and card fields; if set to id, the internal card ID is returned for LOV and card fields.
IsFieldAvailable
Indicates whether the field is available for retrieval.
name
The field name.
level
The field level.
IsFieldValueChanged
Indicates whether the field value changed.
name
The field name.
level
The field level.
IsObjectChanged
Indicates whether the object is changed.
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.
SetNumberFieldValue
Sets the single-value number field value.
name
The field name.
level
The field level.
value
The new value of 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.
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.
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).
This method cannot be used to set a string representation 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. If you set this to element, the element name of the values is set for LOV and card fields.
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.
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. If set to element, the element name of the values is set for LOV and card fields.