Get Started

API Reference

Cmdlet

New-OfficeExcelPdfOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Excel.Pdf.ExcelPdfSaveOptions
Source
Sources/PSWriteOffice/Cmdlets/Excel/NewOfficeExcelPdfOptionsCommand.cs:18 Edit on GitHub

Creates discoverable Excel-to-PDF conversion options for Export-OfficeDocumentPdf.

Remarks

Creates discoverable Excel-to-PDF conversion options for Export-OfficeDocumentPdf.

Examples

Authored help example

Export selected visible sheets with workbook layout features.

PS>


$options = New-OfficeExcelPdfOptions -SheetName Summary,Services -UseWorksheetCharts -UseWorksheetImages
            Export-OfficeDocumentPdf -InputPath .\Report.xlsx -Path .\Report.pdf -ExcelOptions $options

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-OfficeExcelPdfOptions [-AllowDocumentFontEmbedding] [-AllowSystemFontEmbedding] [-ChartLayout <OfficeChartLayout>] [-ChartStyle <OfficeChartStyle>] [-EmptyCellText <String>] [-FontFamily <String>] [-HeaderRowCount <Int32>] [-IncludeSheetHeadings] [-MarginBottom <Double>] [-MarginLeft <Double>] [-MarginRight <Double>] [-MarginTop <Double>] [-MaxRowsPerSheet <Int32>] [-PageSize <PageSize>] [-PdfOptions <PdfOptions>] [-RespectWorkbookSheetVisibility] [-RespectWorksheetHiddenRowsAndColumns] [-SheetName <String[]>] [-UseBoundedWorksheetRead] [-UseWorksheetCellStyles] [-UseWorksheetCharts] [-UseWorksheetColumnWidths] [-UseWorksheetHeaderFooterImages] [-UseWorksheetHeadersAndFooters] [-UseWorksheetHyperlinks] [-UseWorksheetImages] [-UseWorksheetMergedCells] [-UseWorksheetPageBreaks] [-UseWorksheetPageSetup] [-UseWorksheetPrintAreas] [-UseWorksheetPrintTitleRows] [-UseWorksheetRowHeights] [-WorksheetLayout <WorksheetCanvas|FlowTable>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AllowDocumentFontEmbedding SwitchParameter optionalposition: namedpipeline: False
Allow embedding fonts stored in the workbook.
AllowSystemFontEmbedding SwitchParameter optionalposition: namedpipeline: False
Allow embedding fonts discovered on the current system.
ChartLayout OfficeChartLayout optionalposition: namedpipeline: False
Chart layout override.
ChartStyle OfficeChartStyle optionalposition: namedpipeline: False
Chart visual style override.
EmptyCellText String optionalposition: namedpipeline: False
Text used when a worksheet cell is empty.
FontFamily String optionalposition: namedpipeline: False
Default font family used when the workbook does not specify one.
HeaderRowCount Int32 optionalposition: namedpipeline: False
Number of leading rows treated as headers.
IncludeSheetHeadings SwitchParameter optionalposition: namedpipeline: False
Include worksheet row and column headings.
MarginBottom Double optionalposition: namedpipeline: False
Bottom page margin in PDF points.
MarginLeft Double optionalposition: namedpipeline: False
Left page margin in PDF points.
MarginRight Double optionalposition: namedpipeline: False
Right page margin in PDF points.
MarginTop Double optionalposition: namedpipeline: False
Top page margin in PDF points.
MaxRowsPerSheet Int32 optionalposition: namedpipeline: False
Maximum worksheet rows to read and render.
PageSize PageSize optionalposition: namedpipeline: False
PDF page size.
PdfOptions PdfOptions optionalposition: namedpipeline: False
Underlying low-level OfficeIMO PDF options.
RespectWorkbookSheetVisibility SwitchParameter optionalposition: namedpipeline: False
Exclude workbook sheets marked hidden.
RespectWorksheetHiddenRowsAndColumns SwitchParameter optionalposition: namedpipeline: False
Exclude hidden worksheet rows and columns.
SheetName String[] optionalposition: namedpipeline: Falsealiases: SheetNames
Worksheet names to export. The default exports all eligible sheets.
UseBoundedWorksheetRead SwitchParameter optionalposition: namedpipeline: False
Use bounded worksheet reads for large workbooks.
UseWorksheetCellStyles SwitchParameter optionalposition: namedpipeline: False
Render worksheet cell styles.
UseWorksheetCharts SwitchParameter optionalposition: namedpipeline: False
Render worksheet charts.
UseWorksheetColumnWidths SwitchParameter optionalposition: namedpipeline: False
Honor worksheet column widths.
UseWorksheetHeaderFooterImages SwitchParameter optionalposition: namedpipeline: False
Render images referenced by worksheet headers and footers.
UseWorksheetHeadersAndFooters SwitchParameter optionalposition: namedpipeline: False
Render worksheet headers and footers.
UseWorksheetHyperlinks SwitchParameter optionalposition: namedpipeline: False
Render worksheet hyperlinks.
UseWorksheetImages SwitchParameter optionalposition: namedpipeline: False
Render worksheet images.
UseWorksheetMergedCells SwitchParameter optionalposition: namedpipeline: False
Render merged worksheet cells.
UseWorksheetPageBreaks SwitchParameter optionalposition: namedpipeline: False
Honor worksheet page breaks.
UseWorksheetPageSetup SwitchParameter optionalposition: namedpipeline: False
Honor worksheet page setup.
UseWorksheetPrintAreas SwitchParameter optionalposition: namedpipeline: False
Honor worksheet print areas.
UseWorksheetPrintTitleRows SwitchParameter optionalposition: namedpipeline: False
Honor worksheet rows configured to repeat on printed pages.
UseWorksheetRowHeights SwitchParameter optionalposition: namedpipeline: False
Honor worksheet row heights.
WorksheetLayout ExcelPdfWorksheetLayoutMode optionalposition: namedpipeline: Falsevalues: 2
Controls how worksheet content is laid out on PDF pages.
Possible values: WorksheetCanvas, FlowTable

Outputs

OfficeIMO.Excel.Pdf.ExcelPdfSaveOptions