Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output Format "MsWord"

This output format generates a Microsoft Word file from index data of the document, either in DOC format, in DOCX format, or converted to PDF format.

The file extension specified in the .FileName property determines which of the formats will be generated.

Property

Description

OutputFormat[].TemplateFile

Definition of the Word document file to be used

The file serves as a template to be filled with the index field contents to be output. The template file itself remains unchanged.

The following options are available:

  • Specifying a name filter to identify the template file as a file attachment attached to the document, using the first attachment found

  • Specifying an absolute or relative file path to load the template file from the file system

  • Omitting the specification so that a blank document is used instead

    In this case, of the output elements listed below, only "Paragraph" and "Document Property" can be used. All the remaining elements are predefined and do not exist in an empty document.

The OutputName property has a special syntax. This syntax consists of a value composed of several parameters.

The first parameter is always named ElemType and specifies the element type. Depending on the element type, some other parameters are available to specify the element.

Element

Parameter

Paragraph

  1. ElemType*: Paragraph

  2. Number: paragraph number (default value: 1)

If the specified paragraph number is too high and thus the paragraph does not exist, a new paragraph is automatically appended to the document.

Bookmark

  1. ElemType*: Bookmark

  2. Number: number of the bookmark (default value: 1)

  3. Name: name of the bookmark (alternative to Number)

Form field

  1. ElemType*: FormField

  2. Number: number of the form field (default value: 1)

  3. Name: name of the form field (alternative to Number)

Control

  1. ElemType*: ContentControl

  2. Number: number of the control (default value: 1)

  3. Name: name of the control (as an alternative to Number)

Text box

  1. ElemType*: TextBox

  2. Number: number of the text box (default value: 1)

  3. Name: name of text box (alternative to Number)

Table

  1. ElemType*: Table

  2. Number: number of the table (default value: 1)

  3. ColNumber: number of the column (default value: 1)

A table must contain at least one predefined row with the column structure. If the cells of the first row are already filled with values, this row will be seen as the header row and the data output will not start until the second row.

According to the number of output values, the required number of rows is automatically added to the table. If the predefined table contains more (empty) rows than required, they will automatically be deleted.

Document property

  1. ElemType*: Property

  2. PropName*: Name of the document property (Title, Subject, Author, LastAuthor, Keywords, Comments, Company)

    An unknown name is read as a user-defined property.

In this section: