Export Options Panel - Report Viewer for Blazor
- 15 minutes to read
The Export Options panel allows a user to specify document export settings.
CSV Export Options
- Encoding
- Gets or sets the encoding of the text-based file to which a report is exported.
- Quote Strings with Separators
- Gets or sets a value indicating whether a string with separators should be placed in quotation marks when a document is exported to a Text-based file.
- Separator
- Specifies the symbol(s) to separate text elements when a document is exported as a Text-based file.
- Skip Empty Rows
- Specifies whether or not to include the empty rows into the resulting CSV file.
- Skip Empty Columns
- Specifies whether or not to include the empty columns into the resulting CSV file.
- Text Export Mode
- Gets or sets a value indicating whether to use the formatting of the data fields in the bound dataset for the cells in the exported TXT, CSV, XLS or XLSX document.
DOCX Export Options
- Floating Pictures
- Specifies whether to embed floating pictures into exported DOCX files.
- Empty First Page Header/Footer
- Specifies whether to display the header and footer contents on the exported document’s first page.
- Export Mode
- Gets or sets a value indicating how a document is exported to DOCX. The following modes are available:
- SingleFile. A document is exported to a single file. In this mode, page headers and footers are added to the resulting DOCX file only once, at the beginning and end of the document.
- SingleFilePageByPage. A document is exported to a single file, page-by-page.
- Export Page Breaks
- Specifies whether or not page breaks should be included in the resulting file when a document is exported to RTF/DOCX.
- Export Watermarks
- Specifies whether or not watermarks should be included in the resulting file.
- Keep Row Height
- Specifies whether the height of table rows in a resulting document should have fixed values, or adding a new line of text to a cell’s content should increase the row height.
- Page Range
- Specifies the range of pages to be exported. Use commas to separate page numbers. Use hyphens to set page ranges.
- Rasterization Resolution
- Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format.
- Rasterize Images
- Specifies whether or not vector images should be rasterized on export to the corresponding document format.
- Table Layout
- Specifies whether to use the table or frame layout in the resulting DOCX file.
Document Options
The Document Options property contains options that specify the Document Properties of the created DOCX file.
HTML Export Options
- Allow URLs with JS Content
- Gets or sets whether the JavaScript code can be placed in URLs in the resulting HTML document.
- Character Set
- Gets or sets the encoding name used when exporting a document to HTML.
- Embed Images in HTML
- Specifies whether or not images are embedded in HTML content.
- Export Mode
- Gets or sets a value indicating how a document is exported to HTML. The following modes are available:
- SingleFile. A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting HTML file only once, at the beginning and at the end of the document.
- SingleFilePageByPage. A document is exported to a single file, page-by-page. In this mode, all pages are exported one under another, separated by page borders (which are specified by the HtmlExportOptionsBase.PageBorderWidth and HtmlExportOptionsBase.PageBorderColor properties).
- DifferentFiles. A document is exported to multiple files, page-by-page. In this mode every document page is exported to a single HTML file.
- Export Watermarks
- Specifies whether to export watermarks to HTML along with the rest of the document content.
- Inline CSS
- Specifies whether the style properties are written to the <head> section of an HTML document, or they are defined at the same place where a specific style is assigned in a document.
- Page Border Color
- Gets or sets the color of page borders when a document is exported to HTML page-by-page.
- Page Border Width
- Gets or sets the width (in pixels) of page borders when a document is exported to HTML page-by-page.
- Page Range
- Gets or sets the range of pages to be exported.
- Rasterization Resolution
- Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format..
- Remove Secondary Symbols
- Gets or sets a value indicating whether secondary symbols should be removed from the resulting HTML file, to reduce its size.
- Table Layout
- Determines whether to use the table or non-table layout in the resulting HTML file.
- Title
- Gets or sets a title of the created HTML file
- Use HRef Hyperlinks
- Specifies whether or not the document navigation is implemented by using scripts.
Image Export Options
- Export Mode
- Specifies whether document pages are exported to a single or multiple images. The following modes are available:
- SingleFile.
Exports the document to a single image without indicating the borders of individual pages.
The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image.
When this export mode is used, the ImageExportOptions.PageRange property is ignored.
- SingleFilePageByPage.
The document is exported to a single image with borders drawn around each page.
The document’s page headers and footers, and top and bottom margins appear on every page.
The border settings are specified by the ImageExportOptions.PageBorderWidth and ImageExportOptions.PageBorderColor properties.
- DifferentFiles.
Exports each document page to a separate image (with the image file name indicating the page number).
The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image.
- Format
- Specifies the image format for exporting a document.
- Page Border Color
- Specifies the page border color when a document is exported to a single image page-by-page.
- Page Border Width
- Specifies the page border width (in pixels) when a document is exported to a single image page-by-page.
- Page Range
- Specifies the range of pages to be exported.
- Resolution
- Specifies the image resolution (in DPI).
- Retain Background Transparency
- Specifies whether a report is printed with a white or transparent background when the XtraReport.PageColor (BrickGraphics.PageBackColor) property is set to transparent.
- Text Rendering Mode
- Specifies the quality of text rendering in images (especially in images having small DPI values and a transparent background).
MHT Export Options
- Allow URLs with JS Content
- Gets or sets whether the JavaScript code can be placed in URLs in the resulting HTML document.
- Character Set
- Gets or sets the encoding name used when exporting a document to HTML.
- Export Mode
- Gets or sets a value indicating how a document is exported to HTML. The following modes are available:
- SingleFile. A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting HTML file only once, at the beginning and at the end of the document.
- SingleFilePageByPage. A document is exported to a single file, page-by-page. In this mode, all pages are exported one under another, separated by page borders (which are specified by the HtmlExportOptionsBase.PageBorderWidth and HtmlExportOptionsBase.PageBorderColor properties).
- DifferentFiles. A document is exported to multiple files, page-by-page. In this mode every document page is exported to a single HTML file.
- Export Watermarks
- Specifies whether to export watermarks to HTML along with the rest of the document content.
- Inline CSS
- Specifies whether the style properties are written to the <head> section of an HTML document, or they are defined at the same place where a specific style is assigned in a document.
- Page Border Color
- Gets or sets the color of page borders when a document is exported to HTML page-by-page.
- Page Border Width
- Gets or sets the width (in pixels) of page borders when a document is exported to HTML page-by-page.
- Page Range
- Gets or sets the range of pages to be exported.
- Rasterization Resolution
- Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format..
- Remove Secondary Symbols
- Gets or sets a value indicating whether secondary symbols should be removed from the resulting HTML file, to reduce its size.
- Table Layout
- Determines whether to use the table or non-table layout in the resulting HTML file.
- Title
- Gets or sets a title of the created HTML file
- Use HRef Hyperlinks
- Specifies whether or not the document navigation is implemented by using scripts.
PDF Export Options
- Convert Images to Jpeg
- Specifies whether to convert the bitmap and meta file images contained in the document to JPEG format during the export to PDF.
- Export Edit Fields to AcroForms
- Specifies whether to convert editable fields to AcroForms fields on PDF export.
- Image Quality
- Gets or sets the quality of images in the resulting PDF file.
- Never Embedded Fonts
- Gets or sets a semicolon-delimited string of values with the font names which should not be embedded in the resulting PDF file.
- Page Range
- Gets or sets the page range to be exported.
- PDF/A Compatibility
- Specifies document compatibility with the PDF/A specification.
- PDF/UA Compatibility
- Specifies document compatibility with the PDF/UA specification.
- Rasterization Resolution
- Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format.
- Rasterize Images
- Specifies whether or not vector images should be rasterized on export to the corresponding document format.
- Show Print Dialog on Open
- Gets or sets whether to display the Print dialog when a PDF file is opened.
- Signature Options
Provides access to digital signature options of PdfExportOptions.
This option is available in the Report Viewer for Blazor Server. Implement the IPdfSignatureOptionsProviderAsync interface to pass a signature collection to the Report Viewer.
Document Options
The Document Options property contains options that specify the Document Properties of the newly created PDF file.
Security Options
This property allows you to adjust the password security options of the resulting PDF file.
- EncryptionLevel
- Specifies the algorithm used to encrypt PDF content.
- OpenPassword
- Specifies the password for opening the exported PDF document.
- PermissionsPassword
- Specifies the PDF permissions password for the document.
PermissionsOptions
Provides access to the options that specify print, modify, copy, and access permission for the exported document.
- ChangingPermissions
- Specifies the permissions for changing the exported PDF document.
- EnableCopying
- Specifies the permissions for copying the content of the exported PDF document.
- EnableScreenReaders
- Specifies the permissions for screen readers access to the exported PDF document.
- PrintingPermissions
- Specifies the permissions for printing the exported PDF document.
RTF Export Options
- Empty First Page Header/Footer
- Specifies whether to display the header and footer contents on the exported document’s first page.
- Export Mode
- Gets or sets a value indicating how a document is exported to RTF. The following modes are available:
- SingleFile. A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting RTF file only once, at the beginning and at the end of the document.
- SingleFilePageByPage. A document is exported to a single file, page-by-page.
- Export Page Breaks
- Specifies whether or not page breaks should be included in the resulting file when a document is exported to RTF/DOCX.
- Export Watermarks
- Specifies whether or not watermarks should be included in the resulting file.
- Keep Row Height
- Specifies whether the height of table cells in a resulting document should have fixed values, or adding a new line of text to a cell’s content should increase the row height.
- Page Range
- Specifies the range of pages to be exported. Use commas to separate page numbers. Use hyphens to set page ranges.
- Rasterization Resolution
- Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format.
Text Export Options
- Encoding
- Gets or sets the encoding of the text-based file to which a report is exported.
- Quote Strings with Separators
- Gets or sets a value indicating whether a string with separators should be placed in quotation marks when a document is exported to a Text-based file.
- Separator
- Specifies the symbol(s) to separate text elements when a document is exported as a Text-based file.
- Text Export Mode
- Specifies how data field values are formatted in the exported document. If this option is set to Text, data fields are exported as strings and appear identical to those in the document. If the option is set to Value, data field values are exported as text with default formatting.
XLS Export Options
- Export Hyperlinks
- Specifies whether or not hyperlinks should be exported to Excel.
- Export Mode
- Specifies whether the document should be exported to a single or different XLS files, each page in a separate file.
- Fit To Printed Page Height
- Gets or sets whether the output document should be fit to the page height when printed.
- Fit To Printed Page Width
- Gets or sets whether the output document should be fit to the page width when printed.
- Ignore Errors
- Specifies the document errors to be ignored in a resulting Excel file.
- Page Range
- Gets or sets the range of pages to be exported.
- Rasterization Resolution
- Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format.
- Rasterize Images
- Specifies whether or not vector images should be rasterized on export to the corresponding document format.
- Raw Data Mode
- Enables the mode that produces simple tabular data without graphic elements, style and appearance settings.
- Right to Left Document
- Gets or sets whether the layout of the resulting XLS document should be aligned to support locales using right-to-left fonts.
- Sheet Name
- Gets or sets a name of the sheet in the created XLS file to which a document is exported.
- Show Grid Lines
- Gets or sets whether worksheet gridlines are visible in the resulting XLS file.
- Suppress 256 Columns Warning
- Gets or sets a value indicating whether to suppress the exception that raises when trying to export a document to an XLS file with more than 256 columns.
- Suppress 65536 Rows Warning
- Gets or sets a value indicating whether to suppress the exception that raises when trying to export a document to an XLS file with more than 65,536 rows.
- Text Export Mode
- Gets or sets a value indicating whether the cells in the resulting XLS document should use the same formatting as the original document.
- Workbook Color Palette Compliance
- Specifies the color palette compatibility mode with different workbooks versions.
Document Options
The Document Options property contains options that specify the Document Properties of the newly created XLS file.
Encryption Options
This property allows you to adjust the encryption options of the resulting XLS file.
- Password
- Sets a password for the exported XLS file. XLS files support ARC4 encryption (except for RC4CryptoAPI). Passwords for XLS files are stored as plain text in report definitions. Ensure that only trusted parties have access to report definition files.
- Type
- Lists the supported encryption types. Specifies one of the following encryption types:
- Strong (default). Applies the Agile Encryption mechanism.
- Compatible. Applies the Standard Encryption mechanism that is compatible with Excel 2007.
XLSX Export Options
- Export Hyperlinks
- Specifies whether or not hyperlinks should be exported to Excel.
- Export Mode
- Specifies whether the source is exported as a single XLSX file or multiple files, and whether each page is exported as a separate worksheet.
- Fit To Printed Page Height
- Gets or sets whether the output document should be fit to the page height when printed.
- Fit To Printed Page Width
- Gets or sets whether the output document should be fit to the page width when printed.
- Ignore Errors
- Specifies the document errors to be ignored in a resulting Excel file.
- Page Range
- Gets or sets the range of pages to be exported.
- Rasterization Resolution
- Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format.
- Rasterize Images
- Specifies whether or not vector images should be rasterized on export to the corresponding document format.
- Raw Data Mode
- Enables the mode that produces simple tabular data without graphic elements, style and appearance settings.
- Right to Left Document
- Gets or sets whether the layout of the resulting XLS document should be aligned to support locales using right-to-left fonts.
- Sheet Name
- Gets or sets a name of the sheet in the created XLS file to which a document is exported.
- Show Grid Lines
- Gets or sets whether worksheet gridlines are visible in the resulting XLS file.
- Text Export Mode
- Gets or sets a value indicating whether the cells in the resulting XLS document should use the same formatting as the original document.
Document Options
The Document Options property contains options that specify the Document Properties of the newly created XLS file.
Encryption Options
This property allows you to adjust the encryption options of the resulting XLS file.
- Password
- Sets a password for the exported XLS file. XLS files support ARC4 encryption (except for RC4CryptoAPI). Passwords for XLS files are stored as plain text in report definitions. Ensure that only trusted parties have access to report definition files.
- Type
- Lists the supported encryption types. Specifies one of the following encryption types:
- Strong (default). Applies the Agile Encryption mechanism.
- Compatible. Applies the Standard Encryption mechanism that is compatible with Excel 2007.
Review the following help topic for more information: Export Reports.