OfficeImageExportProgress

Edit on GitHub

Namespace OfficeIMO.Drawing

Assembly OfficeIMO.Core

Source revision 45ddf07f0b84 with working tree changes

Source OfficeImageExportProgress.cs:16

Modifiers sealed

Progress snapshot for a single or batch image-export operation.

Inheritance

Object
OfficeImageExportProgress

Usage

Explore 3 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

Property OfficeImageExportOptions.Progress

Accepted by parameters 2

Method OfficeImageExportBatchBuilder.WithProgress parameter progress
Method OfficeImageExportBuilder.WithProgress parameter progress

Constructors

public OfficeImageExportProgress(OfficeImageExportProgressStage stage, Int32 completedCount, Int32? totalCount = null, String? name = null, String? destinationPath = null)

OfficeImageExportProgress.cs:16

Creates an immutable progress snapshot.

Parameters

stage OfficeIMO.Drawing.OfficeImageExportProgressStage requiredposition: 0
completedCount System.Int32 requiredposition: 1
totalCount System.Int32? = null optionalposition: 2
name System.String? = null optionalposition: 3
destinationPath System.String? = null optionalposition: 4

Inherited Methods

Properties

public OfficeImageExportProgressStage Stage { get; } #

OfficeImageExportProgress.cs:30

Current export stage.

public Int32 CompletedCount { get; } #

OfficeImageExportProgress.cs:33

Number of completed results.

public Int32? TotalCount { get; } #

OfficeImageExportProgress.cs:36

Total expected result count when known.

public String? Name { get; } #

OfficeImageExportProgress.cs:39

Current result name when known.

public String? DestinationPath { get; } #

OfficeImageExportProgress.cs:42

Current normalized destination path when saving.