ExcelPdfExportOptions
OfficeIMO.Excel.Pdf
Options controlling first-party OfficeIMO Excel-to-PDF export.
Inheritance
- object
- ExcelPdfExportOptions
Usage
Explore 7 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
Accepted by parameters 4
Constructors
public ExcelPdfExportOptions() #Methods
public ExcelPdfExportOptions Clone() #Creates an independent copy of renderer settings, including PDF options.
Returns
ExcelPdfExportOptionspublic ExcelPdfExportOptions UseProfile(PdfExportProfile profile) #Applies a high-level export profile by setting the Excel PDF options that correspond to that profile.
Parameters
- profile OfficeIMO.Pdf.PdfExportProfile
Returns
ExcelPdfExportOptionspublic ExcelPdfExportOptions UseRenderingProfile(OfficeRenderingProfile profile, OfficeRenderingProfileApplyMode mode = Replace) #Applies shared deterministic typography resources to the first-party PDF engine. Worksheet selection and page layout remain owned by this converter.
Parameters
- profile OfficeIMO.Drawing.OfficeRenderingProfile
- mode OfficeIMO.Drawing.OfficeRenderingProfileApplyMode = Replace
Returns
ExcelPdfExportOptionsInherited Methods
Properties
public bool FailOnLoss { get; set; } #Blocks output when conversion reports fidelity loss.
public PdfCreateOptions? PdfOptions { get; set; } #PDF creation options passed to the first-party PDF engine. The options are cloned before export.
public string? FontFamily { get; set; } #Optional workbook default font family used by the first-party PDF engine.
public PdfResourcePolicy ResourcePolicy { get; set; } #Host-resource policy. Defaults to balanced conversion: system fonts and bounded in-source resources are allowed, while local and remote reads are denied.
public PdfTextFallbackFeatures TextFallbacks { get; set; } #Built-in generated-text fallback groups applied by the Excel PDF converter.
public PdfPageSize? PageSize { get; set; } #Optional first-party page size in PDF points.
public PdfPageMargins? Margins { get; set; } #Optional first-party page margins in PDF points.
public ExcelPdfWorksheetLayoutMode WorksheetLayout { get; set; } #Controls whether sheets preserve worksheet coordinates or are reflowed as report tables. Defaults to ExcelPdfWorksheetLayoutMode.WorksheetCanvas.
public IReadOnlyList<string>? SheetNames { get; set; } #Optional workbook sheet names to export. When null or empty, all workbook sheets are exported in workbook order.
public bool RespectWorkbookSheetVisibility { get; set; } #When true, hidden workbook worksheets are omitted from the default all-sheets export. Explicit SheetNames still export requested sheets. Defaults to true.
public bool UseWorksheetPrintAreas { get; set; } #When true, worksheet print areas are used instead of the used range when configured. Defaults to true.
public bool UseWorksheetPageSetup { get; set; } #When true, worksheet orientation and margins are applied when explicit PDF options do not replace them. Defaults to true.
public bool UseWorksheetPrintTitleRows { get; set; } #When true, worksheet repeated print-title rows are exported as PDF table header rows. Defaults to true.
public bool UseWorksheetPrintTitleColumns { get; set; } #Repeats the worksheet's print-title columns on horizontal pages, including title columns outside the selected print area. Defaults to true.
public bool UseWorksheetPageBreaks { get; set; } #When true, manual worksheet row page breaks split the exported PDF table across pages. Defaults to true.
public bool UseWorksheetCellStyles { get; set; } #When true, simple worksheet cell number formats, font emphasis, colors, alignment, and borders are exported to PDF table cells. Defaults to true.
public bool UseWorksheetHyperlinks { get; set; } #When true, external worksheet cell hyperlinks and internal workbook links to exported sheets are exported as PDF table-cell link annotations. Defaults to true.
public bool UseWorksheetImages { get; set; } #When true, supported worksheet pictures, shapes, and text boxes are exported at worksheet coordinates in canvas mode. Flow mode exports pictures and reports omitted shapes. Defaults to true.
public bool UseWorksheetCharts { get; set; } #When true, supported worksheet charts are exported as first-party PDF drawing snapshots. Defaults to true.
public OfficeChartStyle? ChartStyle { get; set; } #Optional shared chart style applied to exported worksheet chart snapshots and generated chart legend tables.
public OfficeChartLayout? ChartLayout { get; set; } #Optional shared chart layout applied to exported worksheet chart snapshots.
public bool UseWorksheetMergedCells { get; set; } #When true, worksheet merged cells are exported as PDF table column and row spans. Defaults to true.
public bool UseWorksheetColumnWidths { get; set; } #When true, explicit worksheet column widths influence PDF table column proportions. Defaults to true.
public bool UseWorksheetRowHeights { get; set; } #When true, explicit worksheet row heights influence PDF table row heights. Defaults to true.
public bool IncludeSheetHeadings { get; set; } #Determines whether exported sheets start with a generated worksheet-name heading. Defaults to false.
public int HeaderRowCount { get; set; } #Number of leading worksheet rows styled as table headers. Defaults to one row.
public int? MaxRowsPerSheet { get; set; } #Optional maximum number of used-range rows exported from each sheet.
public long MaxMaterializedWorksheetCells { get; set; } #Maximum dense worksheet positions retained across all export ranges, including empty cells. Defaults to 1,000,000. Raise this only for trusted workbooks with sufficient memory.
public bool UseBoundedWorksheetRead { get; set; } #When true together with ExcelPdfExportOptions.MaxRowsPerSheet, worksheet values and direct cell styles are read only through the bounded worksheet range. Metadata stored after the worksheet cell stream, such as print settings, merges, hyperlinks, and drawing anchors, is not materialized. Defaults to false.
public string EmptyCellText { get; set; } #Text used for empty worksheet cells in the exported PDF table. Defaults to an empty string.