<xlsx>

Description

When rendering a QuickApp to an Excel workbook, it is possible to specify attributes for output rendering at both the <render> level and the <widget> level. When specifying configuration options at the <render> level, use the attributes as they are shown below. To specify configuration options at the <widget> or <layout> level, the attributes must be prefixed with the string: xlsx_.

For example, All options for the <render> element can also be specified at the level of a local widget. For example:

<render>
  <xlsx margins_="1;1;.25"/>
</render>

can also be specified at the local widget level by prepending the output target type to the attribute, as follows:

<widget class_="grid" xlsx_margins_="1;1;.25"/>

Properties specified at the local widget level override properties set within the <render> element. It is also important to note that global properties specified in the <render> element will only be applied to widgets that specify a worksheet name using the following attribute at the widget level:

<widget class_="grid" xlsx_sheetname_="My Worksheet"/>

Attributes

filename_

Specifies an optional file name of the Excel file. If omitted, the default file name is download.xlsx.

xlsx_sheetname_

Specifies the sheet tab name the widget or layout is rendered to in the Excel workbook. If omitted, the default worksheet title will be used (e.g., Sheet1).

If the specified name is greater than 31 characters, it is truncated to meet Excel's restrictions on worksheet name length.

Note: The xlsx_sheetname_ attribute can only be specified at the <widget> or <layout> level. It cannot be specified as an attribute to the <xlsx> child element of <render>.

xlsx_printtitle_

Specifies whether or not the <widget> or <layout> to which this attribute is applied appears at the top of every page when the worksheet is printed. Accepts a 1 or 0.

Note: This attribute can only be set on at most one <widget> or <layout>. It cannot be specified as an attribute to the <xlsx> child element of <render>.

filtered_

Specifies whether or not the resultant Excel spreadsheet will have filter buttons on tables created from the grid widgets of the QuickApp. Accepts 1 or 0.

type_

When type_="range", grids will be rendered into normal cell ranges in the Excel spreadsheet, as opposed to a table.

orientation_

Specifies the page orientation of the current worksheet when printed.

Valid values are:

• landscape
• portrait

pageorder_

Specifies the order in which to print pages when a widget exceeds a single page.

Valid values are:

down

Print down then over.

over

Print over then down.

The default is down.

scale_

Specifies the scale or "zoom" level of the worksheet when printed. Accepts an integer value representing the percentage of the document's actual size between 10 and 400.

The default is 100.

Note: The attribute scale_ should be omitted or set to 0 when using fitheight_ and/or fitwidth_.

fitwidth_

Specifies the maximum number of horizontal pages on which to fit the entire worksheet when printed.

Note: The attribute scale_ should be omitted or set to 0 when using fitheight_ and/or fitwidth_.

fitheight_

Specifies the maximum number of vertical pages on which to fit the entire worksheet when printed.

Note: The attribute scale_ should be omitted or set to 0 when using fitheight_ and/or fitwidth_.

headers_

Specifies what to print in all page headers when the worksheet is printed. Accepts text and valid Excel formatting codes.

footers_

Specifies what to print in all page footers when the worksheet is printed. Accepts text and valid Excel formatting codes.

headers_odd_

Specifies what to print in the headers on odd page numbers when the worksheet is printed. Accepts text and valid Excel formatting codes.

footers_odd_

Specifies what to print in the footers on odd page numbers when the worksheet is printed. Accepts text and valid Excel formatting codes.

headers_even_

Specifies what to print in the headers on even page numbers when the worksheet is printed. Accepts text and valid Excel formatting codes.

footers_even_

Specifies what to print in the footers on even page numbers when the worksheet is printed. Accepts text and valid Excel formatting codes.

headers_first_

Specifies what to print in the header of the first page of the document when the worksheet is printed. Accepts text and valid Excel formatting codes.

footers_first_

Specifies what to print in the footer of the first page of the document when the worksheet is printed. Accepts text and valid Excel formatting codes.

margins_

Specifies the margins of the worksheet when printed. Accepts decimal numbers representing inches.

Margins are specified at the <render> level as follows:

<render>
  <xlsx margins_="[LEFT/RIGHT_MARGIN];TOP/BOTTOM_MARGIN;HEADERS/FOOTERS_MARGIN"/>
</render>

To specify the same options at the <widget> level, use the following syntax:

<dynamic>
  <widget class_="grid" xlsx_margins_="[LEFT/RIGHT_MARGIN];TOP/BOTTOM_MARGIN;HEADERS/FOOTERS_MARGIN"/>
</dynamic>

Values for margins_ can be entered as a single number for each variable when corresponding margins are the same (i.e., the left margin and right margin are both 1 inch, or as two values separated by a comma (,) if different margin sizes are desired (i.e., the top margin should be .25 inches and the bottom margin should be .5 inches) would be specified with the following value: "1;.25,.5;0"

papersize_

Specifies the paper size to use when printed.

Valid values are as follows:

• Letter - 8.5 x 11 in. (default)
• Tabloid - 11 x 17 in.
• Ledger - 17 x 11 in.
• Legal - 8.5 x 14 in
• Statement - 5.5 x 8.5 in.
• Executive - 7.25 x 10.5 in.
• Folio - 8.5 x 13 in.
• Note 8.5 x 11 in
• Quarto - 215 x 275 mm
• A3 - 297 x 420 mm.
• A4 - 210 x 297 mm
• A5 - 148 x 210mm
• A6 - 105 x 148 mm
• B4 - 250 x 353 mm
• B5 - 176 x 250 mm
• C - 17 x 22 in
• D - 22 x 34 in
• E - 34 x 44 in

render_text_

This attribute specifies whether or not to render text widgets into Excel TextBox objects. Accepts a 1 or 0.

The style_, color_, width_, and height_ attributes (or the corresponding xlsx_[attr]_ attributes when specified at the <widget> level) are used to configure the rendered TextBox in Excel. If a width or height is not specified, the renderer computes an estimated size for the TextBox. However, this may not fit the text exactly, so use the attributes to size as desired.

Note: The style_ attribute only interprets the following CSS properties during render: font-family, color, font-size, font-weight, font-style).

To include newlines in the text, the value of the text_ attribute for the corresponding <widget class_="text"> must be enclosed as a single-quoted string in curly braces so that any newline characters (i.e., \n) will be evaluated correctly. For instance, <widget class_="text" text_="{'this\nthat'}"/> would render the text with a newline between this and that.

The default is 0.

render_textbox_

This attribute specifies whether or not to render textbox widgets into the Excel workbook. Accepts a 1 or 0.

Each line of text in the textbox widget is rendered as text in a separate cell in the output workbook.

The default is 0.

(Available as of version 11.06)

flatten_headers_

Specifies whether or not to change newlines in multi-line column labels into spaces when rendered to an Excel workbook. Accepts a 1 or 0.

The default is 0.

gridlines_

Specifies whether or not workbook grid lines are present when the Excel workbook is printed. Accepts 1 or 0.

Gridlines print only around actual data in a worksheet.

The default is 0.

(Available as of version 12.09)

printfixedcols_

Specifies the columns that will appear on every page when the workbook is printed. Accepts either an integer value or a range of the form [FIRST_COLUMN]:[LAST_COLUMN].

If an integer is provided, the first n columns of the table will be printed on each page, where n is the specified value. For example, for printfixedcols_="3" specifies that the first three columns of the grid widget will be printed on every page of the workbook.

If a range of the form [FIRST_COLUMN]:[LAST_COLUMN], the columns corresponding to those column numbers will be printed on each page. For example, printfixedcols_="2:3" specifies that the second and third columns should be printed on every page of the workbook.

Note: This setting only works when specified once per Excel worksheet, so be sure to separate tables onto separate sheets (using xlsx_sheetname_) for multiple tables in a single workbook.

(Available as of version 12.14)

int64mode_

Specifies whether to convert 64-bit integer columns to either floating-point values or string values in the rendered workbook, since XLSX files do not support 64-bit integers.

Valid values are:

float

Convert 64-bit integer values to floating-point values.

string

Convert 64-bit integer values to string values.

If this attribute is not set, an error will occur when trying to render a table that contains 64-bit integer columns to an Excel workbook.

(Available as of version 11.25)

As of version 12.17, rendering 64-bit integer columns in XLSX respects the format attribute for a column (e.g., via the <col> or <willbe> operations). Setting this attribute to type:num or type:nocommas on a bigint column indicates the 64-bit integer values should be rendered as floating-point values. Setting it to type:char renders them as string values in the workbook. This allows individual columns to be specified differently. The attribute int64mode_ is used to specify how to render 64-bit integer columns that are unspecified via the column format type.