Cmdlet

Open-OfficeRtf

Module: PSWriteOffice
Inputs: System.String
Outputs: OfficeIMO.Rtf.RtfDocument
Source: OpenOfficeRtfCommand.cs:15 Edit on GitHub

Reads an RTF file or RTF text into a read result with the document, embedded payloads and diagnostics.

Syntax

Open-OfficeRtf
[-AsResult]
[-Path] <String>
[<CommonParameters>]

Parameter set: Path

Open-OfficeRtf
[-AsResult]
-LiteralPath <String>
[<CommonParameters>]

Parameter set: LiteralPath

Open-OfficeRtf
[-AsResult]
-Text <String>
[<CommonParameters>]

Parameter set: Text

Examples

Use the native OfficeRtf command.

$rtf = Open-OfficeRtf -Path .\Contract.rtf

Parameters

-AsResult SwitchParameter optional: AsResult for this operation.
-Path String requiredposition: 0pipeline: True (ByValue)sets: Path: Path for this operation.
-LiteralPath String requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: LiteralPath for this operation.
-Text String requiredsets: Text: Text for this operation.

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.