Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 622 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

ConvertTo-OfficeDocument

Module PSWriteOffice
Inputs
System.Object[]
Outputs
OfficeIMO.Workflows.OfficeWorkflowResult OfficeIMO.Workflows.OfficeConversionBatchResult OfficeIMO.Workflows.OfficeConversionBatchItemResult
Source
ConvertToOfficeDocumentCommand.cs:32 Edit on GitHub

Converts a file or file batch through the canonical OfficeIMO workflow runner.

Syntax

ConvertTo-OfficeDocument [-ConflictPolicy <Fail|Rename|Replace>] [-ConversionOptions <OfficeWorkflowConversionOptions>] [-ConversionRouteId <String>] [-InputPath] <Object[]> [-MaximumInputBytes <Int64>] [-MaximumOutputBytes <Int64>] [-OutputPath] <String> [-OutputProfile <Faithful|Lightweight|PrintReady|TextOnly>] [-Password <String>] [-SummaryVariable <String>] [<CommonParameters>]
#
Parameter set: File
ConvertTo-OfficeDocument [-CheckpointDirectory <String>] [-ConflictPolicy <Fail|Rename|Replace>] [-ConversionOptions <OfficeWorkflowConversionOptions>] [-ConversionRouteId <String>] [-InputPath] <Object[]> [-ItemResults] [-MaximumConcurrency <Int32>] [-MaximumFiles <Int32>] [-MaximumInputBytes <Int64>] [-MaximumOutputBytes <Int64>] -OutputDirectory <String> [-OutputProfile <Faithful|Lightweight|PrintReady|TextOnly>] [-Password <String>] [-RetryFailed] [-SummaryVariable <String>] -TargetExtension <String> [<CommonParameters>]
#
Parameter set: Files
ConvertTo-OfficeDocument [-CheckpointDirectory <String>] [-ConflictPolicy <Fail|Rename|Replace>] [-ConversionOptions <OfficeWorkflowConversionOptions>] [-ConversionRouteId <String>] -InputDirectory <String> [-ItemResults] [-MaximumConcurrency <Int32>] [-MaximumFiles <Int32>] [-MaximumInputBytes <Int64>] [-MaximumOutputBytes <Int64>] [-NoRecurse] -OutputDirectory <String> [-OutputProfile <Faithful|Lightweight|PrintReady|TextOnly>] [-Password <String>] [-RetryFailed] [-SourceExtension <String[]>] [-SummaryVariable <String>] -TargetExtension <String> [<CommonParameters>]
#
Parameter set: Directory

Description

Requires PowerShell 7.4 or newer. Returns verified workflow evidence; unsupported input is diagnosed by the owning route.

Examples

Authored help example

Convert one supported input with output evidence.

ConvertTo-OfficeDocument -InputPath ./report.pdf -OutputPath ./report.docx

Convert selected PDFs to editable Word documents.

Get-ChildItem ./reports -Filter *.pdf | ConvertTo-OfficeDocument -OutputDirectory ./word -TargetExtension docx -ItemResults

Run a resumable directory job with an explicit loss policy.

ConvertTo-OfficeDocument -InputDirectory ./source -OutputDirectory ./pdf -TargetExtension pdf -CheckpointDirectory ./state -ConversionOptions (New-OfficeConversionOptions -RequireNoLoss)

Parameters

-ConflictPolicy String optional
Existing destination behavior. Checkpoint jobs require Fail.
Possible values: Fail, Rename, Replace
-ConversionOptions OfficeWorkflowConversionOptions optional
Renderer and reconstruction settings from New-OfficeConversionOptions.
-ConversionRouteId String optional
Optional exact canonical route identifier from Get-OfficeConversionRoute.
-InputPath Object[] requiredposition: 0pipeline: True (ByValue, ByPropertyName)aliases: FullName, LiteralPath, Pathsets: File, Files
Literal source paths or FileInfo objects. Strings, arrays and file pipelines share one bounded selection.
-MaximumInputBytes Int64 optional
Maximum bytes read from one source.
-MaximumOutputBytes Int64 optional
Maximum generated bytes per document.
-OutputPath String requiredposition: 1sets: File
Single-file destination; its extension selects the target format.
-OutputProfile String optional
Cross-format output intent, subject to the selected route's supported profiles.
Possible values: Faithful, Lightweight, PrintReady, TextOnly
-Password String optional
Runtime-only password for encrypted Office or PDF source files.
-SummaryVariable String optional
Variable receiving the final batch summary or single-file result.
-CheckpointDirectory String optionalsets: Files, Directory
Separate durable state directory. Completed artifacts are verified and reused.
-ItemResults SwitchParameter optionalsets: Files, Directory
Stream per-file evidence instead of only the bounded batch summary.
-MaximumConcurrency Int32 optionalsets: Files, Directory
Maximum concurrently running batch items.
-MaximumFiles Int32 optionalsets: Files, Directory
Maximum selected or discovered files.
-OutputDirectory String requiredsets: Files, Directory
Destination directory for selected-file or directory batches.
-RetryFailed SwitchParameter optionalsets: Files, Directory
Retry recorded failures without replacing verified completed artifacts.
-TargetExtension String requiredaliases: Tosets: Files, Directory
Target extension for every batch item, with or without a leading dot.
-InputDirectory String requiredsets: Directory
Literal source directory for a batch.
-NoRecurse SwitchParameter optionalsets: Directory
Do not traverse child directories.
-SourceExtension String[] optionalsets: Directory
Limit directory discovery to these source extensions.

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.