Cmdlet

Get-OfficeConversionRoute

Module PSWriteOffice

Inputs

System.String[]

Outputs

OfficeIMO.OfficeConversionCapability

Source

GetOfficeConversionRouteCommand.cs:35 Edit on GitHub

Lists conversion contracts from the installed OfficeIMO catalog and their availability for PSWriteOffice batch PDF export.

Syntax

Get-OfficeConversionRoute [-Id <String[]>] [-PdfBatch] [-SourceExtension <String>] [-TargetExtension <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Each row retains the owning package, API, input kind, fidelity, support evidence, text-formatting contract and known limitations. PdfBatchSupported describes Export-OfficeDocumentPdf in the current host. Other routes may have format-specific cmdlets or .NET APIs; a catalog entry alone does not establish that a converter, credentials, fonts or optional providers are ready for a particular input.

Examples

Authored help example

Inspect a Word-to-PDF contract before converting documents.

Get-OfficeConversionRoute -SourceExtension docx -TargetExtension pdf | Format-List *

Extension filters accept a leading dot and compare without regard to case.

Find routes available to batch PDF export in this host.

Get-OfficeConversionRoute -PdfBatch | Select-Object Id, SourceExtensions, PackageId, Fidelity, KnownLimitations

Batch PDF export requires PowerShell 7.4 or newer. Windows PowerShell 5.1 can inspect the catalog and use supported single-file commands.

Inspect several route identifiers from the pipeline.

'docx-pdf', 'pdf-docx' | Get-OfficeConversionRoute

The pipeline also accepts objects with an Id property.

Parameters

-Id String[] optionalpipeline: True (ByValue, ByPropertyName): Exact route identifiers, for example docx-pdf or pdf-docx. Unknown identifiers return no rows.
-PdfBatch SwitchParameter optional: Return only routes supported by Export-OfficeDocumentPdf batch parameter sets in the current host.
-SourceExtension String optional: Accepted source extension, with or without a leading dot.
-TargetExtension String optional: Destination extension, with or without a leading dot.

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.