Get Started

API Reference

Class

PdfOperationResult`1

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Core/PdfOperationResult.cs:58
Modifiers sealed

Result returned by preflight-gated PDF operations.

Inheritance

  • Object
  • PdfOperationResult`1

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

Type Parameters

T
Operation value type.

Methods

public T RequireValue() #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:58
Returns: T

Returns the operation value or throws with diagnostics when the operation failed.

Properties

public String OperationName { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:28

Human-readable operation name.

public PdfPreflightCapability Capability { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:31

Preflight capability required by the operation.

public PdfDocumentPreflight Preflight { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:34

Preflight report used before attempting the operation.

public PdfMutationPlan MutationPlan { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:37

Mutation plan that selected the execution path, when this was an existing-document mutation.

public Boolean CanAttempt { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:40

True when preflight allowed the operation to be attempted.

public Boolean Succeeded { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:43

True when the operation completed and produced a value.

public T Value { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:46

Operation value when the operation completed.

public IReadOnlyList<String> Diagnostics { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:49

Human-readable diagnostics explaining a blocked or failed operation.

public Exception Exception { get; } #
OfficeIMO.Pdf/Core/PdfOperationResult.cs:52

Exception captured from an attempted operation, when available.