Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

New-OfficeRtfPdfOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Rtf.Pdf.RtfPdfExportOptions

Creates discoverable RTF-to-PDF conversion options for Convert-OfficeDocument -To Pdf.

Syntax

New-OfficeRtfPdfOptions
[-AllowDocumentFontEmbedding]
[-AllowSystemFontEmbedding]
[-DefaultImageHeight <OfficeLength>]
[-DefaultImageWidth <OfficeLength>]
[-IncludeHiddenText]
[-MaximumSystemFontFamilies <Int32>]
[-NoHeaderFooters]
[-NoImages]
[-NoMetadata]
[-NoNotes]
[-NoTables]
[-PdfOptions <PdfCreateOptions>]
[<CommonParameters>]
#
Parameter set: Default

Description

Pass the result to Convert-OfficeDocument -Options when converting RTF files to PDF.

Examples

Include document structure and bound system-font discovery.

$options = New-OfficeRtfPdfOptions -NoImages -NoTables -NoHeaderFooters -MaximumSystemFontFamilies 32
Convert-OfficeDocument -To Pdf -Path .\Report.rtf -OutputPath .\Report.pdf -Options $options

Parameters

-AllowDocumentFontEmbedding SwitchParameter optional
Allow embedding fonts referenced by the RTF document.
-AllowSystemFontEmbedding SwitchParameter optional
Allow embedding fonts discovered on the current system.
-DefaultImageHeight OfficeLength optional
Fallback image height in PDF points.
-DefaultImageWidth OfficeLength optional
Fallback image width in PDF points.
-IncludeHiddenText SwitchParameter optional
Include text marked hidden.
-MaximumSystemFontFamilies Int32 optional
Maximum number of system font families to discover.
-NoHeaderFooters SwitchParameter optional
Render headers and footers.
-NoImages SwitchParameter optional
Render images.
-NoMetadata SwitchParameter optional
Copy document metadata into the PDF.
-NoNotes SwitchParameter optional
Render document notes.
-NoTables SwitchParameter optional
Render tables.
-PdfOptions PdfCreateOptions optional
Underlying low-level OfficeIMO PDF 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.