Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeWorkflowBuilder

OfficeIMO.Workflows

Namespace
OfficeIMO.Workflows
Assembly
OfficeIMO.Workflows
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Fluent configuration for one local document workflow.

Inheritance

  • object
  • OfficeWorkflowBuilder

Usage

Explore 21 API references to this type

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

Methods

public OfficeWorkflowBuilder Against(string comparisonPath) #

Sets the comparison input for a compare workflow.

Parameters

comparisonPath string required
public OfficeWorkflowRequest Build() #

Builds an independent request snapshot, inferring a locally executable conversion route from file extensions when possible.

public OfficeWorkflowBuilder ComparePages(OfficePageSelector? expectedPages, OfficePageSelector? actualPages) #

Selects independently ordered page scopes for ordinal rendered comparison. Null selects all pages on that side.

Parameters

expectedPages OfficeIMO.OfficePageSelector? required
actualPages OfficeIMO.OfficePageSelector? required
public OfficeWorkflowBuilder OnConflict(OfficePublicationPolicy policy) #

Sets destination conflict behavior.

Parameters

policy OfficeIMO.OfficePublicationPolicy required
public Task<OfficeWorkflowResult> RunAsync(IOfficeWorkflowRunner? runner = null, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #

Runs this workflow through the supplied runner or the default local runner.

Parameters

runner OfficeIMO.Workflows.IOfficeWorkflowRunner? = null optional
progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public OfficeWorkflowBuilder To(string outputPath) #

Sets the output artifact path.

Parameters

outputPath string required
public OfficeWorkflowBuilder WithComparisonPdfPassword(string? password) #

Sets the PDF password used for the comparison input.

Parameters

password string? required
public OfficeWorkflowBuilder WithId(string id) #

Sets the caller-visible request identifier.

Parameters

id string required
public OfficeWorkflowBuilder WithLimits(long maximumInputBytes, long maximumOutputBytes) #

Sets bounded input and output sizes for the workflow.

Parameters

maximumInputBytes long required
maximumOutputBytes long required
public OfficeWorkflowBuilder WithPdfOwnerPassword(string? password) #

Sets current owner authorization for replacing or removing PDF protection.

Parameters

password string? required
public OfficeWorkflowBuilder WithPdfPassword(string? password) #

Sets the PDF password used for the primary input.

Parameters

password string? required
public OfficeWorkflowBuilder WithProfile(OfficeConversionProfile profile) #

Sets the cross-format output profile.

Parameters

profile OfficeIMO.OfficeConversionProfile required