Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 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/

API Reference

Class

OfficeConversionBatchBuilder

Edit on GitHub
Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Source ../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:9
Modifiers sealed

Fluent batch configuration using the same routes, profiles, renderer settings and publication policies as a single conversion.

Inheritance

  • Object
  • OfficeConversionBatchBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

public OfficeConversionBatchRequest Build() #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:39
Returns: OfficeConversionBatchRequest

Creates an independent request snapshot.

public OfficeConversionBatchBuilder OnConflict(OfficeWorkflowConflictPolicy policy) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:33
Returns: OfficeConversionBatchBuilder

Sets ordinary batch destination behavior; durable jobs require Fail.

Parameters

policy OfficeIMO.Workflows.OfficeWorkflowConflictPolicy requiredposition: 0
public Task<OfficeConversionBatchResult> RunAsync(IOfficeWorkflowRunner runner = null, IProgress<OfficeConversionBatchItemResult> progress = null, CancellationToken cancellationToken = default, IOfficeWorkflowPublicationGuard publicationGuard = null) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:47
Returns: Task<OfficeConversionBatchResult>

Executes this batch. Item callbacks may arrive concurrently; the summary remains bounded.

Parameters

runner OfficeIMO.Workflows.IOfficeWorkflowRunner = null optionalposition: 0
progress System.IProgress{OfficeIMO.Workflows.OfficeConversionBatchItemResult} = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
publicationGuard OfficeIMO.Workflows.IOfficeWorkflowPublicationGuard = null optionalposition: 3
public OfficeConversionBatchBuilder SelectExtensions(Boolean recursive, params String[] extensions) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:36
Returns: OfficeConversionBatchBuilder

Restricts directory selection to source extensions and optional descendants.

Parameters

recursive System.Boolean requiredposition: 0
extensions System.String[] requiredposition: 1
public OfficeConversionBatchBuilder ToDirectory(String outputDirectory, String targetExtension = ".pdf") #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:9
Returns: OfficeConversionBatchBuilder

Sets the destination tree and target extension. The default target is PDF.

Parameters

outputDirectory System.String requiredposition: 0
targetExtension System.String = ".pdf" optionalposition: 1
public OfficeConversionBatchBuilder Via(String routeId) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:12
Returns: OfficeConversionBatchBuilder

Selects an explicit executable route when source extensions are ambiguous.

Parameters

routeId System.String requiredposition: 0
public OfficeConversionBatchBuilder WithCheckpoint(String checkpointDirectory, Boolean retryFailed = false) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:19
Returns: OfficeConversionBatchBuilder

Enables hash-verified completion and restartable publication. Checkpoint jobs require the Fail conflict policy.

Parameters

checkpointDirectory System.String requiredposition: 0
retryFailed System.Boolean = false optionalposition: 1
public OfficeConversionBatchBuilder WithConcurrency(Int32 maximumConcurrency) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:26
Returns: OfficeConversionBatchBuilder

Sets the bounded parallel execution budget.

Parameters

maximumConcurrency System.Int32 requiredposition: 0
public OfficeConversionBatchBuilder WithConversionOptions(OfficeWorkflowConversionOptions options) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:15
Returns: OfficeConversionBatchBuilder

Captures existing format-specific renderer options.

Parameters

options OfficeIMO.Workflows.OfficeWorkflowConversionOptions requiredposition: 0
public OfficeConversionBatchBuilder WithLimits(Int64 maximumInputBytes, Int64 maximumOutputBytes, Int32 maximumFiles = 1000000) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:29
Returns: OfficeConversionBatchBuilder

Sets per-document input and output byte limits and the maximum discovered file count.

Parameters

maximumInputBytes System.Int64 requiredposition: 0
maximumOutputBytes System.Int64 requiredposition: 1
maximumFiles System.Int32 = 1000000 optionalposition: 2
public OfficeConversionBatchBuilder WithPdfPassword(String password) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:24
Returns: OfficeConversionBatchBuilder

Sets the runtime PDF input password without storing it in checkpoints.

Parameters

password System.String requiredposition: 0
public OfficeConversionBatchBuilder WithProfile(OfficeWorkflowOutputProfile profile) #
../../../../_/OfficeIMO.Workflows/OfficeConversionBatchBuilder.cs:22
Returns: OfficeConversionBatchBuilder

Sets the cross-format output intent.

Parameters

profile OfficeIMO.Workflows.OfficeWorkflowOutputProfile requiredposition: 0