Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output Format "MsExcel"

This output format generates a Microsoft Excel file from index data of the document, either in XLSX 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 Excel workbook 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 an empty workbook is used instead

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

Cell or cell range

  1. ElemType*: Range

  2. SheetNo: number of the worksheet (default value: 1)

  3. SheetName: name of worksheet (alternative to SheetNo)

  4. StartCell*: first cell

With StartCell only a single cell can be defined; nevertheless, a range of cells can be filled. In the case of multiple values, all subsequent values are output to the underlying cells according to their number. If these cells already contain a value, new rows are automatically inserted into the worksheet. In the case of header data fields, multiple values can represent elements of an array. In the case of table fields, however, the respective value of each row represents a scalar value to be output. For table fields, the element type Range is the only supported output form.

A cell can be filled not only with a text value but also with a typed value. Therefore, the original value from the xSuite Interface document is passed implicitly if an .OutputFormat is not defined for a text formatting. For correct display of such a value in the workbook, set a suitable cell formatting there.

Text box

  1. ElemType*: TextBox

  2. SheetNo: number of worksheet (default value: 1)

  3. SheetName: name of worksheet (alternative to SheetNo)

  4. BoxNo: number of the text box (default value: 1)

  5. BoxName: name of text box (alternative to BoxNo)

Workbook property

  1. ElemType*: Property

  2. PropName*: workbook property name(Title, Subject, Author, LastAuthor, Keywords, Comments, Company)

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

In this section: