Class WorkbookImageSaveOptions
Options that control how a Workbook is exported to raster images.
Inherited Members
Namespace: DRIT.Spreadsheet.Export.Image
Assembly: DRIT.Spreadsheet.dll
Syntax
public sealed class WorkbookImageSaveOptionsConstructors
WorkbookImageSaveOptions()
Options that control how a Workbook is exported to raster images.
Declaration
public WorkbookImageSaveOptions()Properties
CancellationToken
Token that can cancel the export operation. The export pipeline checks the token before rendering each page and throws OperationCanceledException if cancellation has been requested.
Declaration
public CancellationToken CancellationToken { get; set; }Property Value
| Type | Description |
|---|---|
| CancellationToken |
Dpi
Output resolution in dots per inch. Default: 150.
Declaration
public float Dpi { get; set; }Property Value
| Type | Description |
|---|---|
| float |
FallbackFontName
Font name used when the cell's font cannot be located.
Declaration
public string FallbackFontName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
FallbackFontSizePt
Point size paired with FallbackFontName.
Declaration
public double FallbackFontSizePt { get; set; }Property Value
| Type | Description |
|---|---|
| double |
FontDirectories
Additional directories searched for TrueType / OpenType font files.
Declaration
public IList<string> FontDirectories { get; set; }Property Value
| Type | Description |
|---|---|
| IList<string> |
ForceGridLines
When true a hairline grey grid line is drawn around every visible cell, overriding the per-sheet PrintGridlines setting.
Declaration
public bool ForceGridLines { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Format
Output image format. Default: PNG.
Declaration
public ImageExportFormat Format { get; set; }Property Value
| Type | Description |
|---|---|
| ImageExportFormat |
IncludeHiddenColumns
When true hidden columns are rendered with their natural width.
Declaration
public bool IncludeHiddenColumns { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IncludeHiddenRows
When true hidden rows are rendered with their natural height.
Declaration
public bool IncludeHiddenRows { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IncludeHiddenSheets
When true hidden sheets are also exported.
Declaration
public bool IncludeHiddenSheets { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IncludeRowColumnHeaders
When true column-letter and row-number header bands are rendered.
Declaration
public bool IncludeRowColumnHeaders { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
PageSavingCallback
Optional page-saving callback invoked before and after each page. When null no callback is invoked.
Declaration
public IPageSavingCallback PageSavingCallback { get; set; }Property Value
| Type | Description |
|---|---|
| IPageSavingCallback |
Progress
Optional IProgress<T> receiver that is notified before and after each page is rendered. When null no progress is reported.
Declaration
public IProgress<SaveProgress> Progress { get; set; }Property Value
| Type | Description |
|---|---|
| IProgress<SaveProgress> |
SheetIndexes
Zero-based indexes of sheets to export. When null or empty all visible sheets are exported (or all sheets when IncludeHiddenSheets is true).
Declaration
public IList<int>? SheetIndexes { get; set; }Property Value
| Type | Description |
|---|---|
| IList<int> |