Viewer Export settings
In Overview, we mentioned that you could use the exportsSettings property of Angular, React, and Vue Report Viewer Components or the ExportsSettings property of the second argument of ActiveReports.Viewer constructor to preset the default export settings for each supported format.
The value of exportsSettings should be an object of the following shape:
const exportsSettings = {
pdf: {
author: "GrapeCity",
// default values for other PDF Export settings
},
xslx: {
author: "GrapeCity",
// default values for other XLSX export settings
},
html: {
title: "GrapeCity",
/// default value for other HTML export settings
},
};
Each export format has unique settings. The following sections list them.
PDF Export Settings
| Name | Type | Description |
|---|---|---|
| title | string | Sets the title that appears in the PDF document metadata |
| author | string | Sets the author name that appears in the PDF document metadata |
| subject | string | Sets the subject that appears in the PDF document metadata |
| keywords | string | Sets the list of keywords that appears in the PDF document metadata |
| userPassword | string | Sets the password that a user should enter in the PDF viewer to access the document. Restrictions specified in the settings are applied. |
| ownerPassword | string | Sets the password that a user should enter in the PDF viewer to get the unrestricted access to the document |
| printing | 'lowResolution' | 'highResolution' | 'none' | Sets the allowed printing mode for the PDF document |
| copying | boolean | Indicates whether it is allowed to copy the content of the PDF document |
| modifying | boolean | Indicates whether it is allowed to modify the content of the PDF document |
| annotating | boolean | Indicates whether it is allowed to annotate the content of the PDF document |
| contentAccessibility | boolean | Indicates whether accessibility features are allowed for the PDF document |
| documentAssembly | boolean | Indicates whether it is allowed to assemble the PDF document with other documents |
| pdfVersion | '1.3' | '1.4' | '1.5' | '1.6' | '1.7' | '1.7ext3' | Sets the PDF document version |
| autoPrint | boolean | Indicates whether the PDF document should start printing when opens |
| filename | string | Indicates the file name of the PDF document |
Notes:
- The default PDF Version (1.3) allows setting only four base types of permissions: printing, modifying, copying, and annotating. All other permissions need PDF 1.4+.
- Document assembly permission is always displayed as "Not allowed" in the Adobe Acrobat Reader (and possibly in other reader applications), as this application does not allow combining documents at all. The Adobe Acrobat should show the real state of assembly permission.
XLSX Export settings
| Name | Type | Description |
|---|---|---|
| creator | string | Sets the author name that appears in the XLSX document metadata |
| size | string | Sets the name of the paper size for printing the XLSX document |
| orientation | 'Landscape' | 'Portrait' | Sets the orientation of the paper for printing the XLSX document |
| sheetName | string | Sets the prefix for sheets names of the XLSX document |
| password | string | Sets the password that a user should be provided in the XLSX viewer to access the document |
| filename | string | Sets the file name of the XLSX document |
Html Export settings
| Name | Type | Description |
|---|---|---|
| title | string | Sets the title of the HTML document |
| filename | string | Sets the file name of the HTML document |
| autoPrint | boolean | Indicates whether the document should start printing when opened |
| multiPage | boolean | Indicates whether the output HTML document should export each report page into a separate document. |
| embedImages | 'embed' | 'external' | 'none' | Sets the mode of saving images in the output document. 'embed' indicates that images are converted to base64 and embedded within the document. 'external' indicates that images reside in external files. This mode only available if outputType is 'zip' or 'auto'. |
| outputType | 'zip' | 'html' | 'auto' | Sets the format of the output document. 'zip' compresses the output files to an archive, 'html' produces one or more HTML files, and 'auto' chooses the output format based on multiPage and embedImages properties values |