IPublishReportItem
This topic describes the properties and methods of the IPublishReportItem interface.
Every report item represents one language object and has the following properties:
| PublishReportItemType | The type of publish report item (e.g. Valid, Missing, Generated,...) |
| IshRef | The reference to the logical object |
| IshType | The type of the object: ISHMasterDoc, ISHModule, ISHLibrary, ISHIllustration or ISHTemplate |
| VersionNumber | The version number |
| ExpectedLanguage | The label of the language used for publishing |
| Languages | A list of the language(s) of the object. In case of an Illustration, there can be multiple languages, otherwise there will only be one language.
|
| DisplayLanguage | The language(s) of the object as a comma-space separated string. In case of an Illustration, there can be multiple languages (e.g. "en, nl, de"). Note that the list can potentially be cut after a number of languages, as displaying them all might take up to much space on the display.
|
| Resolution | The resolution of the illustration
|
| IshLogicalRef | The numeric reference of the logical object.
|
| IshVersionRef | The numeric reference of the version object.
|
| IshLngRef | The numeric reference of the language object.
|
| ObjectName | A string representing the object in the following format: ishref=versionnumber=language=resolution |
| Title | The logical title of the object
|
| Status | The status of the language object (e.g. Draft) |
| ObjectReleased | Boolean indicating whether the language object is released or not |
| BaselineReportResult | String with the baseline report result (e.g. NotReleased, ObjectMissingInBaseline,...) |
| DefinedInBaseline | Boolean indicate whether the version was defined in the baseline or not.
|
| InUse | Boolean indicating whether this object is used or not? Images |
| PreferredResolution | Boolean indicating if this is a preferred resolution or not?
|
| Depth | The depth at which the report item is found in the hierarchy. The root starting objects (typicall the root map and resources) are depth 0, children of the root starting objects are depth 1, children of those children are depth 2, etc.
|
| XmlValidationResult | Is the XML blob valid according to the DTD? |
| RevisionId | The element name of the revision exported during the publish |
| FileName | The file name of the content file (e.g. GUID-0E9EE49A-6FBE-4417-850B-FB542FF12696.ditamap, GUID-FEA0B28A-98B6-4D35-A164-D0DB46A8CE92-low.jpg,...) |
| Targets | List with IPublishTarget objects representing the targets which are collected during the export of this report item |
| Links | List with IPublishReference objects representing the links which are collected during the export of this report item |
| Imagelinks | List with IPublishReference objects representing the image links which are collected during the export of this report item |
| Hyperlinks | List with IPublishReference objects representing the hyper links which are collected during the export of this report item |
| Conrefs | List with IPublishReference objects containing the information of the conrefs collected during the export of this report item |
| KeyDefinitions | List with IPublishReference objects containing the information of the key definitions collected during the export of this report item |
| Messages | List with IMessage objects containing a warning or an error |