Documentation Center

IPublishOutputFormat

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

Properties

IdGets the ID of the output format
NameGets the label of the output format
EdtDefinitionGets the Electronic Document Type definition of the output format
MultiValueSeparatorThe multi value separator of the current project
DateTimeFormatThe standard date time format

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.
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.
IsFieldAvailable
Indicates whether the field is available for retrieval.
name
The field name.
level
The field level.