Documentation Center

IPublishReportItem

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

Every report item represents one language object and has the following properties:
PublishReportItemTypeThe type of publish report item (e.g. Valid, Missing, Generated,...)
IshRefThe reference to the logical object
IshTypeThe type of the object: ISHMasterDoc, ISHModule, ISHLibrary, ISHIllustration or ISHTemplate
VersionNumberThe version number
ExpectedLanguageThe label of the language used for publishing
LanguagesA 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.
DisplayLanguageThe 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.
ResolutionThe resolution of the illustration
IshLogicalRefThe numeric reference of the logical object.
IshVersionRefThe numeric reference of the version object.
IshLngRefThe numeric reference of the language object.
ObjectNameA string representing the object in the following format: ishref=versionnumber=language=resolution
TitleThe logical title of the object
StatusThe status of the language object (e.g. Draft)
ObjectReleasedBoolean indicating whether the language object is released or not
BaselineReportResultString with the baseline report result (e.g. NotReleased, ObjectMissingInBaseline,...)
DefinedInBaselineBoolean indicate whether the version was defined in the baseline or not.
InUseBoolean indicating whether this object is used or not? Images
PreferredResolutionBoolean indicating if this is a preferred resolution or not?
DepthThe 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.
XmlValidationResultIs the XML blob valid according to the DTD?
RevisionIdThe element name of the revision exported during the publish
FileNameThe file name of the content file (e.g. GUID-0E9EE49A-6FBE-4417-850B-FB542FF12696.ditamap, GUID-FEA0B28A-98B6-4D35-A164-D0DB46A8CE92-low.jpg,...)
TargetsList with IPublishTarget objects representing the targets which are collected during the export of this report item
LinksList with IPublishReference objects representing the links which are collected during the export of this report item
ImagelinksList with IPublishReference objects representing the image links which are collected during the export of this report item
HyperlinksList with IPublishReference objects representing the hyper links which are collected during the export of this report item
ConrefsList with IPublishReference objects containing the information of the conrefs collected during the export of this report item
KeyDefinitionsList with IPublishReference objects containing the information of the key definitions collected during the export of this report item
MessagesList with IMessage objects containing a warning or an error