# OfficeWorkflowRequest

One typed local workflow request.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeWorkflowContracts.cs:135](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L135)

**Modifiers**

sealed

One typed local workflow request.

## Inheritance

- object
- OfficeWorkflowRequest

## Usage

Explore 6 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.

### Returned or exposed by 1

- Method [OfficeWorkflowBuilder.Build](/api/workflows/officeimo-workflows-officeworkflowbuilder/#method-build)

### Accepted by parameters 5

- Method [IOfficeWorkflowRunner.RunAsync](/api/workflows/officeimo-workflows-iofficeworkflowrunner/#method-runasync-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `request`
- Method [IOfficeWorkflowRunner.RunBatchAsync](/api/workflows/officeimo-workflows-iofficeworkflowrunner/#method-runbatchasync-collections-generic-ienumerable-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `requests`
- Method [OfficeWorkflow.RunAsync](/api/workflows/officeimo-workflows-officeworkflow/#method-runasync-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `request`
- Method [OfficeWorkflowRunner.RunAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runasync-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `request`
- Method [OfficeWorkflowRunner.RunBatchAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runbatchasync-collections-generic-ienumerable-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `requests`

Filter members 

Show inherited

## Constructors

`public OfficeWorkflowRequest()` [#](#constructor-ctor)

[OfficeWorkflowContracts.cs:135](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L135)

`Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string Id { get; set; }` [#](#property-id)

[OfficeWorkflowContracts.cs:135](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L135)

Caller-provided request identifier used by progress and batch results.

`public OfficeWorkflowOperation Operation { get; set; }` [#](#property-operation)

[OfficeWorkflowContracts.cs:138](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L138)

Requested operation.

`public string InputPath { get; set; }` [#](#property-inputpath)

[OfficeWorkflowContracts.cs:141](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L141)

Primary input file.

`public OfficeWorkflowStreamInput? InputStream { get; set; }` [#](#property-inputstream)

[OfficeWorkflowContracts.cs:144](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L144)

Optional provider access for [OfficeWorkflowRequest.InputPath](/api/workflows/officeimo-workflows-officeworkflowrequest/). The path remains the original location or absolute URI.

`public OfficeWorkflowDirectoryPackageInput? InputDirectoryPackage { get; set; }` [#](#property-inputdirectorypackage)

[OfficeWorkflowContracts.cs:147](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L147)

Optional provider directory package for a registered conversion route. Mutually exclusive with InputStream; requires an explicit output.

`public int[]? PageNumbers { get; set; }` [#](#property-pagenumbers)

[OfficeWorkflowContracts.cs:150](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L150)

Ordered one-based pages for ExtractPages, including intentional repeats. Limited to 100,000 entries.

`public OfficePageSelector? PageSelector { get; set; }` [#](#property-pageselector)

[OfficeWorkflowContracts.cs:153](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L153)

Document-relative ordered selection for ExtractPages, resolved against the captured input. Cannot be combined with PageNumbers.

`public int MaximumExtractedPages { get; set; }` [#](#property-maximumextractedpages)

[OfficeWorkflowContracts.cs:156](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L156)

Maximum selected pages for ExtractPages, including repeats. Must be 1 through 100,000.

`public string? ComparisonPath { get; set; }` [#](#property-comparisonpath)

[OfficeWorkflowContracts.cs:159](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L159)

Comparison input used by [OfficeWorkflowOperation.Compare](/api/workflows/officeimo-workflows-officeworkflowoperation/).

`public OfficeWorkflowStreamInput? ComparisonStream { get; set; }` [#](#property-comparisonstream)

[OfficeWorkflowContracts.cs:162](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L162)

Optional provider access for [OfficeWorkflowRequest.ComparisonPath](/api/workflows/officeimo-workflows-officeworkflowrequest/).

`public OfficePageSelector? ComparisonExpectedPages { get; set; }` [#](#property-comparisonexpectedpages)

[OfficeWorkflowContracts.cs:165](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L165)

Ordered expected-page scope for Compare; null selects the whole primary document.

`public OfficePageSelector? ComparisonActualPages { get; set; }` [#](#property-comparisonactualpages)

[OfficeWorkflowContracts.cs:167](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L167)

Ordered actual-page scope for Compare; null selects the whole comparison document. Pages are paired by selection position.

`public string? ConversionRouteId { get; set; }` [#](#property-conversionrouteid)

[OfficeWorkflowContracts.cs:170](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L170)

Conversion route identifier from [OfficeWorkflowCatalog](/api/workflows/officeimo-workflows-officeworkflowcatalog/).

`public OfficeConversionOptions? ConversionOptions { get; set; }` [#](#property-conversionoptions)

[OfficeWorkflowContracts.cs:173](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L173)

Optional route-specific settings, independently copied and validated before asynchronous execution.

`public IOfficeConversionSettings? RegisteredConversionSettings { get; set; }` [#](#property-registeredconversionsettings)

[OfficeWorkflowContracts.cs:175](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L175)

Adapter-owned conversion settings, validated and independently copied by the selected registration before execution.

`public OfficeScanCleanupOptions? ScanCleanup { get; set; }` [#](#property-scancleanup)

[OfficeWorkflowContracts.cs:177](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L177)

Explicit scan preparation and raster-output acknowledgement for ScanCleanup.

`public WordImageOptimizationOptions? WordImageOptimization { get; set; }` [#](#property-wordimageoptimization)

[OfficeWorkflowContracts.cs:180](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L180)

Embedded-media settings for AnalyzeWordImages and OptimizeWordImages.

`public string? OutputPath { get; set; }` [#](#property-outputpath)

[OfficeWorkflowContracts.cs:183](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L183)

Requested output file. Inspect does not require one; compare emits HTML when one is supplied.

`public OfficeWorkflowStreamOutput? OutputStream { get; set; }` [#](#property-outputstream)

[OfficeWorkflowContracts.cs:186](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L186)

Optional verified direct-write access for the original [OfficeWorkflowRequest.OutputPath](/api/workflows/officeimo-workflows-officeworkflowrequest/) provider location.

`public OfficePublicationPolicy ConflictPolicy { get; set; }` [#](#property-conflictpolicy)

[OfficeWorkflowContracts.cs:189](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L189)

Conflict behavior used when publishing an artifact.

`public IOfficePublicationGuard? PublicationGuard { get; set; }` [#](#property-publicationguard)

[OfficeWorkflowContracts.cs:192](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L192)

Optional live application ownership check for final publication candidates.

`public OfficeConversionProfile OutputProfile { get; set; }` [#](#property-outputprofile)

[OfficeWorkflowContracts.cs:195](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L195)

Cross-format output intent.

`public string? PdfPassword { get; set; }` [#](#property-pdfpassword)

[OfficeWorkflowContracts.cs:198](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L198)

Optional PDF password. It is used only while executing and is never copied to results or reports.

`public PdfLoadOptions? InputPdfLoadOptions { get; set; }` [#](#property-inputpdfloadoptions)

[OfficeWorkflowContracts.cs:201](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L201)

Optional primary PDF read settings, including resource limits, for PDF conversion. Independently copied before execution.

`public string? ComparisonPdfPassword { get; set; }` [#](#property-comparisonpdfpassword)

[OfficeWorkflowContracts.cs:207](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L207)

Optional password for the comparison PDF. When omitted, [OfficeWorkflowRequest.PdfPassword](/api/workflows/officeimo-workflows-officeworkflowrequest/) is reused. It is used only while executing and is never copied to results or reports.

`public PdfStandardEncryptionOptions? OutputEncryption { get; set; }` [#](#property-outputencryption)

[OfficeWorkflowContracts.cs:210](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L210)

New password protection for ProtectPdf. Cloned before execution; credentials remain request-only.

`public PdfAConversionOptions? PdfAConversion { get; set; }` [#](#property-pdfaconversion)

[OfficeWorkflowContracts.cs:216](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L216)

PDF/A conversion settings for ConvertToPdfA. When omitted, the library defaults apply. Copied before execution. An encrypted source needs its owner password in [OfficeWorkflowRequest.PdfPassword](/api/workflows/officeimo-workflows-officeworkflowrequest/); the PDF/A copy is written without encryption.

`public string? PdfOwnerPassword { get; set; }` [#](#property-pdfownerpassword)

[OfficeWorkflowContracts.cs:219](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L219)

Current owner password for replacing or removing protection. Falls back to PdfPassword when omitted.

`public IPdfExternalSigner? OutputSigner { get; set; }` [#](#property-outputsigner)

[OfficeWorkflowContracts.cs:222](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L222)

Runtime signer for SignPdf. The caller retains ownership and must keep it alive until execution completes.

`public PdfExternalSignatureOptions? OutputSignatureOptions { get; set; }` [#](#property-outputsignatureoptions)

[OfficeWorkflowContracts.cs:225](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L225)

Signature and appearance settings for SignPdf, copied before asynchronous execution.

`public IPdfSignatureCryptographyProvider? OutputSignatureValidator { get; set; }` [#](#property-outputsignaturevalidator)

[OfficeWorkflowContracts.cs:228](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L228)

Required runtime cryptographic verifier for SignPdf. Chain trust is reported independently from signature math.

`public OfficeOperationLimits Limits { get; set; }` [#](#property-limits)

[OfficeWorkflowContracts.cs:231](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L231)

Shared request resource limits.

<!-- PowerForge markdown artifact sha256:50D87CD8D5ECA523C0275474A288958468A8F0A7F105BAC7035CD765C4EF70B8 -->
