ExportDocToPDF

The ExportDocToPDF command uses the Microsoft Word export filter to produce a PDF file directly from a Microsoft Word document.

Note

This command is only available for Microsoft Word documents and requires Microsoft Office 2007 or Microsoft Office 2010 and the optional PDF/XPS add-in.

The ExportDocToPDF command provides a number of optional parameters which affect the way in which the PDF document is generated. If no optional parameters are provided ITP/Server will use sensible defaults.

It is possible to set a global default for some of the optional parameters. These global defaults can be set in the [Configuration] section of the dp.ini file. Refer to the description of the parameters below to see if these have a corresponding global setting.

Syntax

ExportDocToPDF
  Src(<text>)
  Dest(<text>)
  OptimiseForPrint(True or False)
  IncludeProperties(True or False)
  ExportBookmarks(<number>)
  BitmapFonts(True or False)
  ProducePDFA(True or False)
  AccessibilityInfo(True or False)
  TimeOut(<number>);

Parameters

Src: Required.
The Word document that ITP/Server will convert to the PDF format.

Dest: Required.
The resulting PDF document.

OptimiseForPrint: Optional.
Indicates if the resulting PDF document should be optimized for printing (True) or for screen reading (False).

This parameter defaults to False when omitted but the default value can be changed using the following setting in the dp.ini file:

ExportDocToPDF.OptimiseForPrint=(Y or N)

IncludeProperties: Optional.
Indicates whether or not some document properties (author, title, etc.) from the Word document should be copied into the PDF document. This parameter defaults to False when omitted.

ExportBookmarks: Optional.
Indicates whether or not a bookmark table should be added to the PDF document.
Supported values are:

0 No bookmarks are generated.
1 Bookmarks are generated based on the Heading styles in the Word document.
2 Bookmarks are generated based on bookmarks in the Word document.

This parameter defaults to 0 when omitted.

BitmapFonts: Optional.
If font licenses do not permit a font to be embedded in the PDF document this setting indicates how the font is handled.
True; a bitmap of the text is included in the PDF document.
False; the font is referred but not included. It is up to the viewer/printer to select an appropriate (substitute) font.

This parameter defaults to True when omitted but the default value can be changed using the following setting in the dp.ini file:

ExportDocToPDF.FontBitmaps=(Y or N)

ProducePDFA: Optional.
Indicates whether or not the PDF document is limited to the PDF/A (ISO 19005-1) subset. Such documents are more self-contained but could be larger or show more visual artifacts.
This parameter defaults to False when omitted but the default value can be changed using the following setting in the dp.ini file:

ExportDocToPDF.ExportPDFA=(Y or N)

AccessibilityInfo: Optional.
Indicates whether or not structure information is embedded in the PDF document to facilitate screen readers. This parameter defaults to True when omitted.

TimeOut: Optional.
The time-out for this command in seconds. If the WordProcessor exceeds this time-out the process is terminated and ITP/Server will report a runtime error.
If this parameter is omitted the appropriate default time-out value for either batch or interactive jobs is used. A time-out value of 0 disables the time-out.
This feature is currently only supported for Microsoft Word.