TSVGExportParameters Class
Parameters used when exporting to SVG.
Syntax
Unit: FlexCel.Render
TSVGExportParameters = class(TFlexCelObject);
Properties
| Name |
Description |
| Workbook |
Excel file that we are exporting. Note that this is a LightClone() of the original ExcelFile that was passed to the export, and might have a different active sheet. If you need to access the file from the export action, use this parameter and not the original ExcelFile.
|
| PageNumber |
Page number we are currently exporting.
|
| SheetPageNumber |
Page number in the sheet we are exporting. Different from PageNumber, this value is local to the current sheet, and it is reset every time we export a different sheet. If you are exporting a single sheet (FlexCelSVGExport.AllVisibleSheets is false), then this variable will have the same value as PageNumber |
| TotalPages |
Total number of pages to export.
|
| TotalPagesInSheet |
Number of pages in the sheet we are exporting. Different from TotalPages, this value is local to the current sheet, and it is reset every time we export a different sheet. If you are exporting a single sheet (FlexCelSVGExport.AllVisibleSheets is false), then this variable will have the same value as TotalPages |
| FileStream |
Stream where the image will be saved. If you leave it null, the image won't be saved to a stream.
|
| FileName |
Filename where the image will be saved. If you leave it null or empty, the image won't be saved to a file.
|
| Canceled |
Set this property to true to cancel the export process.
|
| Title |
Title to be saved with the image. If null or empty, the svg image will have no title tag.
|
| Description |
Description to be saved with the image. If null or empty, the svg image will have no description tag.
|
| ExtraSVGAttributes |
Extra attributes that will be added to the <svg> definition. Keep it null to not add any extra attribute.
|