Cmdlet
New-OfficeExcelPdfOptions
Creates discoverable Excel-to-PDF conversion options for Convert-OfficeDocument -To Pdf.
Syntax
New-OfficeExcelPdfOptions
[-AllowDocumentFontEmbedding]
[-AllowSystemFontEmbedding]
[-ChartFidelity <Strict| BestEffort>]
[-ChartLayout <OfficeChartLayout>]
[-ChartStyle <OfficeChartStyle>]
[-EmptyCellText <String>]
[-Font <String>]
[-HeaderRowCount <Int32>]
[-IncludeSheetHeadings]
[-MarginBottom <OfficeLength>]
[-MarginLeft <OfficeLength>]
[-MarginRight <OfficeLength>]
[-MarginTop <OfficeLength>]
[-MaxRowsPerSheet <Int32>]
[-PageSize <PdfPageSize>]
[-PdfOptions <PdfCreateOptions>]
[-RespectWorkbookSheetVisibility]
[-RespectWorksheetHiddenRowsAndColumns]
[-Sheet <OfficeSheetSelector[]>]
[-UseBoundedWorksheetRead]
[-UseWorksheetCellStyles]
[-UseWorksheetCharts]
[-UseWorksheetColumnWidths]
[-UseWorksheetHeaderFooterImages]
[-UseWorksheetHeadersAndFooters]
[-UseWorksheetHyperlinks]
[-UseWorksheetImages]
[-UseWorksheetMergedCells]
[-UseWorksheetPageBreaks]
[-UseWorksheetPageSetup]
[-UseWorksheetPrintAreas]
[-UseWorksheetPrintTitleRows]
[-UseWorksheetRowHeights]
[-WorksheetLayout <WorksheetCanvas| FlowTable>]
[<CommonParameters>]#Parameter set:
DefaultExamples
Convert chosen sheets to PDF
$pdf = New-OfficeExcelPdfOptions -Sheet Summary, Orders -UseWorksheetPrintAreas
Convert-OfficeDocument -Path .\Reports\Q3-Sales.xlsx -OutputPath .\Reports\Q3-Sales.pdf -Options $pdfConverts only the Summary and Orders sheets, honouring the print areas set in the workbook.
Convert a folder of reports with page setup
$pdf = New-OfficeExcelPdfOptions -PageSize A4 -MarginLeft 1.5cm -MarginRight 1.5cm -UseWorksheetPageSetup -UseWorksheetHeadersAndFooters -UseWorksheetPrintTitleRows -RespectWorkbookSheetVisibility
Get-ChildItem -Path .\Reports -Filter *.xlsx |
Convert-OfficeDocument -To Pdf -OutputDirectory .\Pdf -Options $pdfConverts every workbook in the folder to A4 PDFs that use each sheet's page setup, headers and repeated titles.
Parameters
- -AllowDocumentFontEmbedding SwitchParameter
- Allow embedding installed fonts selected by a trusted workbook. System-font embedding must also be enabled.
- -AllowSystemFontEmbedding SwitchParameter
- Allow embedding fonts discovered on the current system.
- -ChartFidelity OfficeChartFidelity
- Chart handling: Strict (default) skips charts with formatting that cannot be drawn exactly; BestEffort draws the closest approximation and reports chart-approximation warnings.
- Possible values:
Strict,BestEffort - -ChartLayout OfficeChartLayout
- Chart layout override.
- -ChartStyle OfficeChartStyle
- Chart visual style override.
- -EmptyCellText String
- Text used when a worksheet cell is empty.
- -Font String
- Default font family used when the workbook does not specify one.
- -HeaderRowCount Int32
- Number of leading rows treated as headers.
- -IncludeSheetHeadings SwitchParameter
- Include worksheet row and column headings.
- -MarginBottom OfficeLength
- Bottom page margin in PDF points.
- -MarginLeft OfficeLength
- Left page margin in PDF points.
- -MarginRight OfficeLength
- Right page margin in PDF points.
- -MarginTop OfficeLength
- Top page margin in PDF points.
- -MaxRowsPerSheet Int32
- Maximum worksheet rows to read and render.
- -PageSize PdfPageSize
- PDF page size.
- -PdfOptions PdfCreateOptions
- Underlying low-level OfficeIMO PDF options.
- -RespectWorkbookSheetVisibility SwitchParameter
- Exclude workbook sheets marked hidden.
- Exclude hidden worksheet rows and columns.
- -Sheet OfficeSheetSelector[]
- Worksheet names, wildcard patterns or one-based positions. Live worksheet inputs are captured by name for reusable saved conversions.
- -UseBoundedWorksheetRead SwitchParameter
- Use bounded worksheet reads for large workbooks.
- -UseWorksheetCellStyles SwitchParameter
- Render worksheet cell styles.
- -UseWorksheetCharts SwitchParameter
- Render worksheet charts.
- -UseWorksheetColumnWidths SwitchParameter
- Honor worksheet column widths.
- Render images referenced by worksheet headers and footers.
- Render worksheet headers and footers.
- -UseWorksheetHyperlinks SwitchParameter
- Render worksheet hyperlinks.
- -UseWorksheetImages SwitchParameter
- Render worksheet images.
- -UseWorksheetMergedCells SwitchParameter
- Render merged worksheet cells.
- -UseWorksheetPageBreaks SwitchParameter
- Honor worksheet page breaks.
- -UseWorksheetPageSetup SwitchParameter
- Honor worksheet page setup.
- -UseWorksheetPrintAreas SwitchParameter
- Honor worksheet print areas.
- -UseWorksheetPrintTitleRows SwitchParameter
- Honor worksheet rows configured to repeat on printed pages.
- -UseWorksheetRowHeights SwitchParameter
- Honor worksheet row heights.
- -WorksheetLayout ExcelPdfWorksheetLayoutMode
- Controls how worksheet content is laid out on PDF pages.
- Possible values:
WorksheetCanvas,FlowTable
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.