API Reference
ExcelToPdfOptions
Options controlling first-party OfficeIMO Excel-to-PDF export.
Inheritance
- Object
- ExcelToPdfOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
Accepted by parameters
- Method ExcelPdfConverterExtensions.SaveAsPdf
- Method ExcelPdfConverterExtensions.SaveAsPdf
- Method ExcelPdfConverterExtensions.SaveAsPdfAsync
- Method ExcelPdfConverterExtensions.SaveAsPdfAsync
- Method ExcelPdfConverterExtensions.SaveAsPdfResult
- Method ExcelPdfConverterExtensions.SaveAsPdfResult
- Method ExcelPdfConverterExtensions.SaveAsPdfResultAsync
- Method ExcelPdfConverterExtensions.SaveAsPdfResultAsync
- Method ExcelPdfConverterExtensions.ToPdfBytes
- Method ExcelPdfConverterExtensions.ToPdfDocument
- Method ExcelPdfConverterExtensions.ToPdfDocumentResult
Constructors
public ExcelToPdfOptions() #Methods
public ExcelToPdfOptions UseProfile(PdfExportProfile profile) #ExcelToPdfOptionsApplies a high-level export profile by setting the Excel PDF options that correspond to that profile.
Parameters
- profile OfficeIMO.Pdf.PdfExportProfile
public ExcelToPdfOptions UseRenderingProfile(OfficeRenderingProfile profile, OfficeRenderingProfileApplyMode mode = Replace) #ExcelToPdfOptionsApplies 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
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public PdfOptions 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 Nullable<PageSize> PageSize { get; set; } #Optional first-party page size in PDF points.
public Nullable<PageMargins> 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 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 Boolean 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 Boolean UseWorksheetPrintAreas { get; set; } #When true, worksheet print areas are used instead of the used range when configured. Defaults to true.
public Boolean UseWorksheetPageSetup { get; set; } #When true, worksheet orientation and margins are applied when explicit PDF options do not replace them. Defaults to true.
public Boolean UseWorksheetPrintTitleRows { get; set; } #When true, worksheet repeated print-title rows are exported as PDF table header rows. Defaults to true.
public Boolean UseWorksheetPageBreaks { get; set; } #When true, manual worksheet row page breaks split the exported PDF table across pages. Defaults to true.
public Boolean 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 Boolean 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 Boolean UseWorksheetImages { get; set; } #When true, supported worksheet drawing images are exported at worksheet coordinates in canvas mode or as flow images in compatibility mode. Defaults to true.
public Boolean 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 Boolean UseWorksheetMergedCells { get; set; } #When true, worksheet merged cells are exported as PDF table column and row spans. Defaults to true.
public Boolean UseWorksheetColumnWidths { get; set; } #When true, explicit worksheet column widths influence PDF table column proportions. Defaults to true.
public Boolean UseWorksheetRowHeights { get; set; } #When true, explicit worksheet row heights influence PDF table row heights. Defaults to true.
public Boolean IncludeSheetHeadings { get; set; } #Determines whether exported sheets start with a generated worksheet-name heading. Defaults to false.
public Int32 HeaderRowCount { get; set; } #Number of leading worksheet rows styled as table headers. Defaults to one row.
public Nullable<Int32> MaxRowsPerSheet { get; set; } #Optional maximum number of used-range rows exported from each sheet.
public Boolean UseBoundedWorksheetRead { get; set; } #When true together with 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.