IPublishPostProcessContext
This topic describes the properties and methods of the IPublishPostProcessContext interface.
Properties
| MultiValueSeparator | The multi value separator of the current project |
| DateTimeFormat | The standard date time format |
| PublishStartTime | Start time of PublishPostProcess |
| OutputFormat | IPublishOutputFormat object containing all metadata fields of the output format |
| CombineLanguages | Determines whether multiple languages are combined to one output |
| Compare | Determines whether compare was requested |
| IshType | Type of object to publish. The value is ISHPublication or one of the following: ISHMasterDoc, ISHModule, ISHLibrary, ISHIllustration or ISHTemplate |
| IshLevel | Level of the object to publish |
| IshRef | The logical identifier of the object to publish |
| Version | The version number of the object to publish |
| IshLngRef | The language identifier of object to publish.
|
| Languages | The language or the list with languages for a multiple languages publication |
| Resources | The list with logical identifiers of the resources |
| Items | Collection with objects to pass to the following plugins in memory.
|
| RootWorkDirectory | The 'work' directory with the exported data set on which the plugins will be executed, for example, C:\InfoShare\Data\Publish\Data\2r1yonuwcoe\work |
| RootDocumentObjectFile | Location of the file containing the root of the XML structure hierarchy (root map). For DITA this is the root DITA Map. |
| PublicationOutputMetadataFile | File location of the metadata file of the publication output.
|
| ConditionsFile | Location of the file containing the set of condition name/values that was provided to the publish service while publishing |
| CompareConditionsFile | Location of the file containing the set of condition name/values of the compare version that was provided to the publish service while publishing.
|
| CompareReportFile | File location of the compare report file.
|
| ReportItems | A 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 |
| XmlResolver | XmlResolver to load XML files with a catalog |
| XmlNamespaceResolver | Gets the namespace resolver |
| RunMode | The RunMode indicates if the plugins are executed in Debug mode or during a Normal publish.
|
| ProgressId | The progress id (for the event monitor logging) |
| EventId | The event id (for the event monitor logging) |
| EventMonitor | Gets the event monitor which can be used to log into event logs |
| CurrentProgress | The current progress of this event/background task |
| MaximumProgress | The maximum progress of this event/background task |
| PublishParameters | Collection with the parameters that are specific to this publish operation |
| CommonParameters | Collection with the common parameters from the publish plugin configuration |
| FinishDeployingBackgroundTask | Specifies which background task will check and finish the deploying of the publish |
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.
- 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.
- 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.
- IsCancelled
- Checks whether the publish was cancelled by the user
- IsFieldAvailable
- Indicates whether the field is available for retrieval.
- 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.
- Save
-
Saves this object as XML into the
RootWorkDirectory. This function returns the file path to the saved file.