Cmdlet

New-OfficeExcelPdfOptions

Module: PSWriteOffice
Inputs: None
Outputs: OfficeIMO.Excel.Pdf.ExcelToPdfOptions
Source: NewOfficeExcelPdfOptionsCommand.cs:18 Edit on GitHub

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

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

Examples

Export selected visible sheets with workbook layout features.

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

Parameters

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