Documentation Center

IPublishOutputFormat

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

Id

Gets the id of the output format.

Name

Gets the label of the output format.

EdtDefinition

Gets the EDT definition of the output format.

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