PdfOperationResult`1

Edit on GitHub

Namespace OfficeIMO.Pdf

Assembly OfficeIMO.Pdf

Source revision 33d062b583cb with working tree changes

Source PdfOperationResult.cs:58

Implements

IOfficeResult<T> IOfficeResult

Modifiers sealed

Result returned by preflight-gated PDF operations.

Inheritance

Object
PdfOperationResult`1

Usage

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

Method PdfDocument.AppendMetadataRevisionResult
Method PdfDocument.FlattenVisualAnnotationsResult
Method PdfDocument.MergeWithResult
Method PdfDocument.ReplaceMetadataResult
Method PdfDocument.SynchronizeMetadataResult
Method PdfDocument.UpdateMetadataResult
Method PdfDocumentAttachments.ExtractResult
Extension method PdfDocumentForms.FillAndFlattenResult
Extension method PdfDocumentForms.FillResult
Extension method PdfDocumentForms.FlattenResult
Method PdfDocumentForms.AppendRevisionResult
Method PdfDocumentForms.FillAndFlattenResult
Method PdfDocumentForms.FillResult
Method PdfDocumentForms.FlattenResult
Method PdfDocumentFormsCompatibilityExtensions.FillAndFlattenResult
Method PdfDocumentFormsCompatibilityExtensions.FillResult
Method PdfDocumentFormsCompatibilityExtensions.FlattenResult
Method PdfDocumentImageEditor.ExtractResult
Method PdfDocumentImageEditor.PlacementsResult
Method PdfDocumentPages.AppendResult
Method PdfDocumentPages.ApplyAttributesResult
Method PdfDocumentPages.DeleteResult
Method PdfDocumentPages.DuplicateResult
Method PdfDocumentPages.ExtractResult
Method PdfDocumentPages.InsertResult
Method PdfDocumentPages.MoveResult
Method PdfDocumentPages.NormalizeRotationResult
Method PdfDocumentPages.PrependResult
Method PdfDocumentPages.ReorderResult
Method PdfDocumentPages.RotateByResult
Method PdfDocumentPages.RotateResult
Method PdfDocumentPages.SetPageBoxResult
Method PdfDocumentPages.SplitByBookmarksResult
Method PdfDocumentPages.SplitResult
Method PdfDocumentRedactions.ApplyResult
Method PdfDocumentRedactions.ApplyWithEvidenceResult
Method PdfDocumentResources.FontsResult
Method PdfDocumentResources.RawStructureResult
Method PdfDocumentSecurity.DecryptResult
Method PdfDocumentSecurity.EncryptResult
Method PdfDocumentSecurity.PrepareExternalSignatureResult
Method PdfDocumentSecurity.ReencryptResult
Method PdfDocumentStamper.ContentResult
Method PdfDocumentStamper.ImageResult
Method PdfDocumentStamper.ImageWatermarkResult
Method PdfDocumentStamper.OverlayPageResult
Method PdfDocumentStamper.TextResult
Method PdfDocumentStamper.TextWatermarkResult
Method PdfDocumentStamper.UnderlayPageResult

Type Parameters

T: Operation value type.

Methods

public T RequireValue() #

PdfOperationResult.cs:58

Returns: T

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

Inherited Methods

Properties

public String OperationName { get; } #

PdfOperationResult.cs:28

Human-readable operation name.

public PdfPreflightCapability Capability { get; } #

PdfOperationResult.cs:31

Preflight capability required by the operation.

public PdfDocumentPreflight Preflight { get; } #

PdfOperationResult.cs:34

Preflight report used before attempting the operation.

public PdfMutationPlan? MutationPlan { get; } #

PdfOperationResult.cs:37

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

public Boolean CanAttempt { get; } #

PdfOperationResult.cs:40

True when preflight allowed the operation to be attempted.

public Boolean Succeeded { get; } #

PdfOperationResult.cs:43

True when the operation completed and produced a value.

public T? Value { get; } #

PdfOperationResult.cs:46

Operation value when the operation completed.

public IReadOnlyList<String> Diagnostics { get; } #

PdfOperationResult.cs:49

Human-readable diagnostics explaining a blocked or failed operation.

public Exception? Exception { get; } #

PdfOperationResult.cs:52

Exception captured from an attempted operation, when available.