Documentation Center

IPublishPostProcessContext

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

Properties

MultiValueSeparatorThe multi value separator of the current project
DateTimeFormatThe standard date time format
PublishStartTimeStart time of PublishPostProcess
OutputFormatIPublishOutputFormat object containing all metadata fields of the output format
CombineLanguagesDetermines whether multiple languages are combined to one output
CompareDetermines whether compare was requested
IshTypeType of object to publish. The value is ISHPublication or one of the following: ISHMasterDoc, ISHModule, ISHLibrary, ISHIllustration or ISHTemplate
IshLevelLevel of the object to publish
IshRefThe logical identifier of the object to publish
VersionThe version number of the object to publish
IshLngRefThe language identifier of object to publish.
LanguagesThe language or the list with languages for a multiple languages publication
ResourcesThe list with logical identifiers of the resources
ItemsCollection with objects to pass to the following plugins in memory.
RootWorkDirectoryThe 'work' directory with the exported data set on which the plugins will be executed, for example, C:\InfoShare\Data\Publish\Data\2r1yonuwcoe\work
RootDocumentObjectFileLocation of the file containing the root of the XML structure hierarchy (root map). For DITA this is the root DITA Map.
PublicationOutputMetadataFileFile location of the metadata file of the publication output.
ConditionsFileLocation of the file containing the set of condition name/values that was provided to the publish service while publishing
CompareConditionsFileLocation of the file containing the set of condition name/values of the compare version that was provided to the publish service while publishing.
CompareReportFileFile location of the compare report file.
ReportItemsA IPublishSingleLanguageReportItemsList with the information of all the published objects (the root map or any objects referenced by the root map, child maps or topics) for all the published languages
XmlResolverXmlResolver to load XML files with a catalog
XmlNamespaceResolverGets the namespace resolver
RunModeThe RunMode indicates if the plugins are executed in Debug mode or during a Normal publish.
ProgressIdThe progress id (for the event monitor logging)
EventIdThe event id (for the event monitor logging)
EventMonitorGets the event monitor which can be used to log into event logs
CurrentProgressThe current progress of this event/background task
MaximumProgressThe maximum progress of this event/background task
PublishParametersCollection with the parameters that are specific to this publish operation
CommonParametersCollection with the common parameters from the publish plugin configuration
FinishDeployingBackgroundTaskSpecifies which background task will check and finish the deploying of the publish

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.
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.
IsCancelled
Checks whether the publish was cancelled by the user
IsFieldAvailable
Indicates whether the field is available for retrieval.
name
The field name.
level
The field level.
IsReleaseCandidate
Is the publish result a Release Candidate (up to now) or not?
RejectReleaseCandidate
According to this plugin, the publish is no longer a valid release candidate
MetadataFileLoader
Loads a metadata file from the file system into an IMetadataProvider object.
xmlMetadataFile
FileInfo object pointing to the metadata file on the file system
Save
Saves this object as XML into the RootWorkDirectory. This function returns the file path to the saved file.