PreviewDocument and related properties

The property PreviewDocument specifies the file path that is used to store preview documents. If this property is empty, then no preview documents are generated. If a file path is specified, then KCM Core generates a preview document when the Master Template run is interrupted for user interaction, such as when a Start or Continue call returns Model.ResultCode.Interact. The preview document is generated in the format specified by the property PreviewDocumentFormat. It is allowed to use the same path for both the preview document and the final result document.

If the property PreviewDocumentOnServer is enabled, then the file path is interpreted as a path accessible from KCM Core. If the property PreviewDocumentOnServer is disabled, then the .NET API downloads the file from KCM Core to the specified local path. The default value for the property PreviewDocumentOnServer is false.

The property PreviewDocumentFormat specifies the file format in which the preview document is generated. This format can be either "native" or case insensitive "PDF". The default is "native", which means that the word processor format of the Master Template itself gets generated.