Class WorkbookPdfSaveOptions

Options that control how a Workbook is exported to PDF.

Inheritance

object

WorkbookPdfSaveOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Spreadsheet.Export.Pdf

Assembly: DRIT.Spreadsheet.dll

Syntax

public sealed class WorkbookPdfSaveOptions

Constructors

WorkbookPdfSaveOptions()

Options that control how a Workbook is exported to PDF.

Declaration

public WorkbookPdfSaveOptions()

Properties

BookmarkEntries

Custom bookmark entries. When non-empty, these override the default per-sheet bookmarks. Each entry specifies a title and a sheet index to navigate to.

Declaration

public IList<PdfBookmarkEntry> BookmarkEntries { get; set; }

Property Value

Type	Description
IList<PdfBookmarkEntry>

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

Compliance

PDF compliance level. When set to a value other than None, the exported PDF conforms to the specified PDF/A standard.

Declaration

public PdfCompliance Compliance { get; set; }

Property Value

Type	Description
PdfCompliance

CopyDocumentProperties

When true document-level metadata (Title, Author, Subject, Keywords) from DocumentProperties is written to the PDF Info dictionary.

Declaration

public bool CopyDocumentProperties { get; set; }

Property Value

Type	Description
bool

CustomPropertiesExport

Specifies how document properties are exported to the PDF. When set to None, overrides CopyDocumentProperties and suppresses metadata.

Declaration

public PdfCustomPropertiesExport CustomPropertiesExport { get; set; }

Property Value

Type	Description
PdfCustomPropertiesExport

FallbackFontName

Name of the font to use when the requested font cannot be found.

Declaration

public string FallbackFontName { get; set; }

Property Value

Type	Description
string

FallbackFontSizePt

Point size used together with FallbackFontName.

Declaration

public double FallbackFontSizePt { get; set; }

Property Value

Type	Description
double

FontDirectories

Additional directories that are 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, regardless of whether the cell has explicit borders. Takes precedence over the per-sheet PrintGridlines setting; set either flag to draw grid lines.

Declaration

public bool ForceGridLines { get; set; }

Property Value

Type	Description
bool

IncludeBookmarks

When true a PDF outline (bookmark) entry is added for each exported sheet.

Declaration

public bool IncludeBookmarks { get; set; }

Property Value

Type	Description
bool

IncludeHiddenColumns

When true hidden columns are rendered with their natural width; otherwise they occupy no horizontal space.

Declaration

public bool IncludeHiddenColumns { get; set; }

Property Value

Type	Description
bool

IncludeHiddenRows

When true hidden rows are rendered with their natural height; otherwise they occupy no vertical space.

Declaration

public bool IncludeHiddenRows { get; set; }

Property Value

Type	Description
bool

IncludeHiddenSheets

When true sheets with Hidden or VeryHidden visibility are also exported.

Declaration

public bool IncludeHiddenSheets { get; set; }

Property Value

Type	Description
bool

IncludeRowColumnHeaders

When true a column-letter band (A, B, C …) is rendered at the top of every page and a row-number band (1, 2, 3 …) is rendered at the left side, mirroring Excel's "Print headings" option. Takes precedence over the per-sheet PrintHeadings setting; set either flag to include header bands.

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>

SecurityOptions

PDF security (encryption + permissions) options. When null, the PDF is not encrypted.

Declaration

public PdfSecurityOptions SecurityOptions { get; set; }

Property Value

Type	Description
PdfSecurityOptions

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>