ConvertFrom-OfficeRtf

Aliases: ConvertFrom-Rtf

Namespace PSWriteOffice

Aliases

ConvertFrom-Rtf

Inputs

System.String

Outputs

OfficeIMO.Word.WordDocument System.String OfficeIMO.Pdf.PdfDocument System.IO.FileInfo

Source

Sources/PSWriteOffice/Cmdlets/Rtf/ConvertFromOfficeRtfCommand.cs:42 Edit on GitHub

Converts RTF input to Word, HTML, PDF, or Markdown output.

Remarks

Converts RTF input to Word, HTML, PDF, or Markdown output.

Examples

Authored help example

Convert RTF to Word.

PS>


New-OfficeRtf -Path .\Report.rtf -Text 'Summary', 'Ready for review'
            ConvertFrom-OfficeRtf -Path .\Report.rtf -As Word -OutputPath .\Report.docx -PassThru

Loads the RTF file and saves a Word document using OfficeIMO.Word.Rtf.

Convert RTF to HTML.

PS>


ConvertFrom-OfficeRtf -Path .\Report.rtf -As Html -OutputPath .\Report.html

Converts RTF to Word, then serializes Word to HTML.

Convert RTF to PDF.

PS>


ConvertFrom-OfficeRtf -Path .\Report.rtf -As Pdf -OutputPath .\Report.pdf

Uses OfficeIMO.Rtf.Pdf to save a PDF file.

Convert RTF to Markdown.

PS>


ConvertFrom-OfficeRtf -Path .\Report.rtf -As Markdown -OutputPath .\Report.md -PassThru

Converts the RTF document to Markdown using OfficeIMO.Rtf.Markdown.

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

ConvertFrom-OfficeRtf -As <Word|Html|Pdf|Markdown> [-ExcludeHeaderFooters] [-ExcludeImages] [-ExcludeNotes] [-ExcludeTables] [-FontFamily <String>] [-IncludeDefaultCss] [-IncludeFontStyles] [-IncludeHiddenText] [-IncludeListStyles] [-IncludeParagraphClasses] [-IncludeRunClasses] [-NoUnsupportedHtmlComments] [-OutputPath <String>] [-PassThru] -Path <String> [-UseImagePaths] [<CommonParameters>]

Parameter set: Path

Parameters

As OfficeRtfConversionTarget requiredposition: namedpipeline: Falsevalues: 4: Target document format.; Possible values: Word, Html, Pdf, Markdown
ExcludeHeaderFooters SwitchParameter optionalposition: namedpipeline: False: Exclude RTF headers and footers from PDF output.
ExcludeImages SwitchParameter optionalposition: namedpipeline: False: Exclude RTF images from PDF output.
ExcludeNotes SwitchParameter optionalposition: namedpipeline: False: Exclude RTF notes from PDF output.
ExcludeTables SwitchParameter optionalposition: namedpipeline: False: Exclude RTF tables from PDF output.
FontFamily String optionalposition: namedpipeline: False: Optional font family for RTF to HTML conversion.
IncludeDefaultCss SwitchParameter optionalposition: namedpipeline: False: Include the built-in default CSS for RTF to HTML conversion.
IncludeFontStyles SwitchParameter optionalposition: namedpipeline: False: Include font styles as inline CSS for RTF to HTML conversion.
IncludeHiddenText SwitchParameter optionalposition: namedpipeline: False: Include hidden RTF text when converting to PDF or Markdown.
IncludeListStyles SwitchParameter optionalposition: namedpipeline: False: Include list style metadata for RTF to HTML conversion.
IncludeParagraphClasses SwitchParameter optionalposition: namedpipeline: False: Emit paragraph styles as CSS classes for RTF to HTML conversion.
IncludeRunClasses SwitchParameter optionalposition: namedpipeline: False: Emit run styles as CSS classes for RTF to HTML conversion.
NoUnsupportedHtmlComments SwitchParameter optionalposition: namedpipeline: False: Do not emit HTML comments for unsupported RTF features when converting to Markdown.
OutputPath String optionalposition: namedpipeline: Falsealiases: OutPath: Optional output path. When omitted, the converted object or text is returned.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit a FileInfo when saving to disk.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: RTF file path.
UseImagePaths SwitchParameter optionalposition: namedpipeline: False: Store image references as file paths instead of base64 data URIs for HTML output.

Outputs

OfficeIMO.Word.WordDocument System.String OfficeIMO.Pdf.PdfDocument System.IO.FileInfo

ConvertFrom-OfficeRtf -As <Word|Html|Pdf|Markdown> [-ExcludeHeaderFooters] [-ExcludeImages] [-ExcludeNotes] [-ExcludeTables] [-FontFamily <String>] [-IncludeDefaultCss] [-IncludeFontStyles] [-IncludeHiddenText] [-IncludeListStyles] [-IncludeParagraphClasses] [-IncludeRunClasses] [-NoUnsupportedHtmlComments] [-OutputPath <String>] [-PassThru] -Text <String> [-UseImagePaths] [<CommonParameters>]

Parameter set: Text

Parameters

As OfficeRtfConversionTarget requiredposition: namedpipeline: Falsevalues: 4: Target document format.; Possible values: Word, Html, Pdf, Markdown
ExcludeHeaderFooters SwitchParameter optionalposition: namedpipeline: False: Exclude RTF headers and footers from PDF output.
ExcludeImages SwitchParameter optionalposition: namedpipeline: False: Exclude RTF images from PDF output.
ExcludeNotes SwitchParameter optionalposition: namedpipeline: False: Exclude RTF notes from PDF output.
ExcludeTables SwitchParameter optionalposition: namedpipeline: False: Exclude RTF tables from PDF output.
FontFamily String optionalposition: namedpipeline: False: Optional font family for RTF to HTML conversion.
IncludeDefaultCss SwitchParameter optionalposition: namedpipeline: False: Include the built-in default CSS for RTF to HTML conversion.
IncludeFontStyles SwitchParameter optionalposition: namedpipeline: False: Include font styles as inline CSS for RTF to HTML conversion.
IncludeHiddenText SwitchParameter optionalposition: namedpipeline: False: Include hidden RTF text when converting to PDF or Markdown.
IncludeListStyles SwitchParameter optionalposition: namedpipeline: False: Include list style metadata for RTF to HTML conversion.
IncludeParagraphClasses SwitchParameter optionalposition: namedpipeline: False: Emit paragraph styles as CSS classes for RTF to HTML conversion.
IncludeRunClasses SwitchParameter optionalposition: namedpipeline: False: Emit run styles as CSS classes for RTF to HTML conversion.
NoUnsupportedHtmlComments SwitchParameter optionalposition: namedpipeline: False: Do not emit HTML comments for unsupported RTF features when converting to Markdown.
OutputPath String optionalposition: namedpipeline: Falsealiases: OutPath: Optional output path. When omitted, the converted object or text is returned.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit a FileInfo when saving to disk.
Text String requiredposition: namedpipeline: False: Raw RTF text.
UseImagePaths SwitchParameter optionalposition: namedpipeline: False: Store image references as file paths instead of base64 data URIs for HTML output.

Outputs

OfficeIMO.Word.WordDocument System.String OfficeIMO.Pdf.PdfDocument System.IO.FileInfo