# OfficeWorkflowProgress

Progress update for one workflow request.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

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

**Modifiers**

sealed

Progress update for one workflow request.

## Inheritance

- object
- OfficeWorkflowProgress

## Usage

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

### Accepted by parameters 20

- Method [IOfficeOutputWorkflowRunner.AssemblePdfAsync](/api/workflows/officeimo-workflows-iofficeoutputworkflowrunner/#method-assemblepdfasync-officeimo-workflows-pdfassemblyrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [IOfficeOutputWorkflowRunner.ExportPdfPagesAsync](/api/workflows/officeimo-workflows-iofficeoutputworkflowrunner/#method-exportpdfpagesasync-officeimo-workflows-pdfpageimageexportrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [IOfficeProvenanceWorkflowRunner.RunProvenanceAsync](/api/workflows/officeimo-workflows-iofficeprovenanceworkflowrunner/#method-runprovenanceasync-officeimo-workflows-officeprovenanceworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [IOfficeProvenanceWorkflowRunner.RunProvenanceBatchAsync](/api/workflows/officeimo-workflows-iofficeprovenanceworkflowrunner/#method-runprovenancebatchasync-collections-generic-ienumerable-officeimo-workflows-officeprovenanceworkflowrequest-officeimo-workflows-officeprovenanceworkflowbatchoptions-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [IOfficeWorkflowRunner.RunAsync](/api/workflows/officeimo-workflows-iofficeworkflowrunner/#method-runasync-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [IOfficeWorkflowRunner.RunBatchAsync](/api/workflows/officeimo-workflows-iofficeworkflowrunner/#method-runbatchasync-collections-generic-ienumerable-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [IPdfRedactionWorkflowRunner.RunRedactionAsync](/api/workflows/officeimo-workflows-ipdfredactionworkflowrunner/#method-runredactionasync-officeimo-workflows-pdfredactionworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [IPdfRedactionWorkflowRunner.RunRedactionBatchAsync](/api/workflows/officeimo-workflows-ipdfredactionworkflowrunner/#method-runredactionbatchasync-collections-generic-ienumerable-officeimo-workflows-pdfredactionworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflow.RunAsync](/api/workflows/officeimo-workflows-officeworkflow/#method-runasync-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowBuilder.RunAsync](/api/workflows/officeimo-workflows-officeworkflowbuilder/#method-runasync-officeimo-workflows-iofficeworkflowrunner-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.AssemblePdfAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-assemblepdfasync-officeimo-workflows-pdfassemblyrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.ExportPdfPagesAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-exportpdfpagesasync-officeimo-workflows-pdfpageimageexportrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.RunAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runasync-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.RunBatchAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runbatchasync-collections-generic-ienumerable-officeimo-workflows-officeworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.RunOcrSessionAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runocrsessionasync-collections-generic-ienumerable-officeimo-workflows-officeocrsessionrequest-officeimo-ocr-iocrengine-iprogress-officeimo-workflows-officeworkflowprogress-iprogress-officeimo-workflows-officeocrsessionresult-threading-cancellationtoken-collections-generic-ireadonlylist-system-string-collections-generic-ireadonlylist-officeimo-workflows-officeworkflowprotectedsource) parameter `progress`
- Method [OfficeWorkflowRunner.RunProvenanceAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runprovenanceasync-officeimo-workflows-officeprovenanceworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.RunProvenanceBatchAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runprovenancebatchasync-collections-generic-ienumerable-officeimo-workflows-officeprovenanceworkflowrequest-officeimo-workflows-officeprovenanceworkflowbatchoptions-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.RunRedactionAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runredactionasync-officeimo-workflows-pdfredactionworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.RunRedactionBatchAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runredactionbatchasync-officeimo-workflows-pdfredactionbatchrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`
- Method [OfficeWorkflowRunner.SplitPdfAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-splitpdfasync-officeimo-workflows-pdfsplitworkflowrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `progress`

Filter members 

Show inherited

## Constructors

`public OfficeWorkflowProgress(string requestId, string stage, string message, double fraction, double? overallFraction = null)` [#](#constructor-ctor-string-string-string-double-nullable-system-double)

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

Creates a progress update.

Parameters

**requestId string required**

**stage string required**

**message string required**

**fraction double required**

**overallFraction double? = null optional**

## 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 RequestId { get; }` [#](#property-requestid)

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

Caller-provided request identifier.

`public string Stage { get; }` [#](#property-stage)

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

Stable execution stage.

`public string Message { get; }` [#](#property-message)

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

User-facing progress message.

`public double Fraction { get; }` [#](#property-fraction)

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

Normalized completion fraction.

`public double OverallFraction { get; }` [#](#property-overallfraction)

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

Normalized overall batch fraction, equal to [OfficeWorkflowProgress.Fraction](/api/workflows/officeimo-workflows-officeworkflowprogress/) for a single request.

<!-- PowerForge markdown artifact sha256:0CE56E980126B88A9B1E4C6D7EDBC92A77DDB6FF1A0283ECE556C5B50273201E -->
