Get Started

API Reference

Cmdlet

New-OfficeRtfPdfOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Rtf.Pdf.RtfPdfSaveOptions
Source
Sources/PSWriteOffice/Cmdlets/Rtf/NewOfficeRtfPdfOptionsCommand.cs:15 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Include document structure and bound system-font discovery.

PS>


$options = New-OfficeRtfPdfOptions -IncludeImages -IncludeTables -IncludeHeaderFooters -MaximumSystemFontFamilies 32
            Export-OfficeDocumentPdf -InputPath .\Report.rtf -Path .\Report.pdf -RtfOptions $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-OfficeRtfPdfOptions [-AllowDocumentFontEmbedding] [-AllowSystemFontEmbedding] [-DefaultImageHeight <Double>] [-DefaultImageWidth <Double>] [-IncludeHeaderFooters] [-IncludeHiddenText] [-IncludeImages] [-IncludeMetadata] [-IncludeNotes] [-IncludeTables] [-MaximumSystemFontFamilies <Int32>] [-PdfOptions <PdfOptions>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AllowDocumentFontEmbedding SwitchParameter optionalposition: namedpipeline: False
Allow embedding fonts referenced by the RTF document.
AllowSystemFontEmbedding SwitchParameter optionalposition: namedpipeline: False
Allow embedding fonts discovered on the current system.
DefaultImageHeight Double optionalposition: namedpipeline: False
Fallback image height in PDF points.
DefaultImageWidth Double optionalposition: namedpipeline: False
Fallback image width in PDF points.
IncludeHeaderFooters SwitchParameter optionalposition: namedpipeline: False
Render headers and footers.
IncludeHiddenText SwitchParameter optionalposition: namedpipeline: False
Include text marked hidden.
IncludeImages SwitchParameter optionalposition: namedpipeline: False
Render images.
IncludeMetadata SwitchParameter optionalposition: namedpipeline: False
Copy document metadata into the PDF.
IncludeNotes SwitchParameter optionalposition: namedpipeline: False
Render document notes.
IncludeTables SwitchParameter optionalposition: namedpipeline: False
Render tables.
MaximumSystemFontFamilies Int32 optionalposition: namedpipeline: False
Maximum number of system font families to discover.
PdfOptions PdfOptions optionalposition: namedpipeline: False
Underlying low-level OfficeIMO PDF options.

Outputs

OfficeIMO.Rtf.Pdf.RtfPdfSaveOptions