API Reference

Class

PdfDocument

Namespace OfficeIMO.Pdf

Assembly OfficeIMO.Pdf

Source revision 804a7612eee4 with working tree changes

Modifiers sealed

Root PDF lifecycle and capability container. Author content through PdfDocument.Create or PdfDocument.Compose; use the focused capability properties for reading and existing-document operations.

Inheritance

Object
PdfDocument

Usage

Explore 146 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 121

Method PdfAcroFormEditResult.ToDocument
Method PdfAnnotationEditResult.ToDocument
Method PdfAttachmentEditResult.ToDocument
Method PdfBatesDocumentResult.ToDocument
Method PdfBookmarkEditResult.ToDocument
Method PdfDestructiveCropResult.ToDocument
Method PdfDocument.AppendMetadataRevision
Method PdfDocument.AppendMetadataRevisionResult
Method PdfDocument.Compose
Method PdfDocument.Create
Method PdfDocument.CreateFromImages
Method PdfDocument.FlattenVisualAnnotations
Method PdfDocument.FlattenVisualAnnotationsResult
Method PdfDocument.Load
Method PdfDocument.LoadAsync
Method PdfDocument.Merge
Method PdfDocument.MergeBytes
Method PdfDocument.MergeWith
Method PdfDocument.MergeWithResult
Method PdfDocument.Meta
Method PdfDocument.ReplaceMetadata
Method PdfDocument.ReplaceMetadataResult
Method PdfDocument.SynchronizeMetadata
Method PdfDocument.SynchronizeMetadataResult
Method PdfDocument.UpdateMetadata
Method PdfDocument.UpdateMetadataResult
Method PdfDocumentConversionResult.RequireNoLoss
Method PdfDocumentConversionResult.RequireValue
Property PdfDocumentConversionResult.Value
Extension method PdfDocumentForms.FillAndFlattenResult
Extension method PdfDocumentForms.FillResult
Extension method PdfDocumentForms.FlattenResult
Method PdfDocumentForms.AppendRevision
Method PdfDocumentForms.AppendRevisionResult
Method PdfDocumentForms.Fill
Method PdfDocumentForms.FillAndFlatten
Method PdfDocumentForms.FillAndFlattenResult
Method PdfDocumentForms.FillResult
Method PdfDocumentForms.Flatten
Method PdfDocumentForms.FlattenResult
Method PdfDocumentForms.ImportData
Method PdfDocumentForms.ImportXfdf
Method PdfDocumentFormsCompatibilityExtensions.FillAndFlattenResult
Method PdfDocumentFormsCompatibilityExtensions.FillResult
Method PdfDocumentFormsCompatibilityExtensions.FlattenResult
Method PdfDocumentPages.Append
Method PdfDocumentPages.AppendResult
Method PdfDocumentPages.ApplyAttributes
Method PdfDocumentPages.ApplyAttributesResult
Method PdfDocumentPages.CropAndTranslate
Method PdfDocumentPages.Delete
Method PdfDocumentPages.DeleteResult
Method PdfDocumentPages.Duplicate
Method PdfDocumentPages.DuplicateResult
Method PdfDocumentPages.Extract
Method PdfDocumentPages.ExtractResult
Method PdfDocumentPages.Insert
Method PdfDocumentPages.InsertResult
Method PdfDocumentPages.Move
Method PdfDocumentPages.MoveResult
Method PdfDocumentPages.NormalizeRotation
Method PdfDocumentPages.NormalizeRotationResult
Method PdfDocumentPages.Prepend
Method PdfDocumentPages.PrependResult
Method PdfDocumentPages.Reorder
Method PdfDocumentPages.ReorderResult
Method PdfDocumentPages.Resize
Method PdfDocumentPages.Rotate
Method PdfDocumentPages.RotateBy
Method PdfDocumentPages.RotateByResult
Method PdfDocumentPages.RotateResult
Method PdfDocumentPages.SetArtBox
Method PdfDocumentPages.SetBleedBox
Method PdfDocumentPages.SetCropBox
Method PdfDocumentPages.SetMediaBox
Method PdfDocumentPages.SetPageBox
Method PdfDocumentPages.SetPageBoxResult
Method PdfDocumentPages.SetTrimBox
Method PdfDocumentPages.Split
Method PdfDocumentPages.SplitByBookmarks
Method PdfDocumentPages.SplitByBookmarksResult
Method PdfDocumentPages.SplitResult
Method PdfDocumentRedactions.AddAnnotation
Method PdfDocumentRedactions.Apply
Method PdfDocumentRedactions.ApplyResult
Method PdfDocumentSecurity.CompleteExternalSignature
Method PdfDocumentStamper.Content
Method PdfDocumentStamper.ContentResult
Method PdfDocumentStamper.Image
Method PdfDocumentStamper.ImageResult
Method PdfDocumentStamper.ImageWatermark
Method PdfDocumentStamper.ImageWatermarkResult
Method PdfDocumentStamper.OverlayPage
Method PdfDocumentStamper.OverlayPageResult
Method PdfDocumentStamper.Text
Method PdfDocumentStamper.TextResult
Method PdfDocumentStamper.TextWatermark
Method PdfDocumentStamper.TextWatermarkResult
Method PdfDocumentStamper.UnderlayPage
Method PdfDocumentStamper.UnderlayPageResult
Method PdfDocumentStamper.Watermark
Method PdfExternalSignatureCompletion.ToDocument
Method PdfExternalSignaturePreparation.Complete
Property PdfImageEditResult.Document
Method PdfImpositionResult.ToDocument
Method PdfInteractiveContentFlattenResult.ToDocument
Method PdfInterleaveResult.ToDocument
Method PdfJavaScriptEditResult.ToDocument
Method PdfMergeResult.RequireValue
Method PdfMergeResult.ToDocument
Property PdfMergeResult.Value
Method PdfOptimizationActionResult.ToDocument
Method PdfPageRewriteResult.ToDocument
Property PdfProductionFixupResult.Document
Method PdfProductionSplitPart.ToDocument
Method PdfRedactionApplyResult.ToDocument
Method PdfRepairArtifactResult.ToDocument
Method PdfSanitizationResult.ToDocument
Method PdfSecurityMutationResult.ToDocument
Property PdfTextEditResult.Document
Method PdfUnsignedDerivativeResult.ToDocument

Accepted by parameters 25

Extension method PdfDocument.ExportImages parameter document
Extension method PdfDocument.ToImages parameter document
Method PdfDocument.Merge parameter documents
Method PdfDocument.MergeResult parameter documents
Method PdfDocument.MergeWith parameter document
Method PdfDocument.MergeWithResult parameter document
Constructor PdfDocumentConversionResult.PdfDocumentConversionResult parameter document
Method PdfDocumentConversionResult.Process parameter process
Method PdfDocumentConversionResult.WithValue parameter value
Method PdfDocumentPages.Append parameter sourceDocument
Method PdfDocumentPages.AppendResult parameter sourceDocument
Method PdfDocumentPages.Insert parameter sourceDocument
Method PdfDocumentPages.InsertResult parameter sourceDocument
Method PdfDocumentPages.Prepend parameter sourceDocument
Method PdfDocumentPages.PrependResult parameter sourceDocument
Method PdfDocumentProof.AnalyzePageChanges parameter actualDocument
Method PdfDocumentProof.AssertRewritePreservationMatrix parameter rewrite
Method PdfDocumentProof.AssertRewritePreserved parameter rewrittenDocument
Method PdfDocumentProof.AssessRewritePreservation parameter rewrittenDocument
Method PdfDocumentProof.AssessRewritePreservationMatrix parameter rewrite
Method PdfDocumentProof.CompareReview parameter actualDocument
Method PdfDocumentProof.CompareVisual parameter actualDocument
Method PdfDocumentProof.CompareVisualPages parameter actualDocument
Method PdfImageExportExtensions.ExportImages parameter document
Method PdfImageExportExtensions.ToImages parameter document

Examples

using OfficeIMO.Pdf;

PdfDocument.Create(pdf => pdf.Content(content => content
    .H1("OfficeIMO.Pdf")
    .Paragraph(paragraph => paragraph.Text("Hello from OfficeIMO."))))
    .Save("hello.pdf");

Methods

Analyze 2 overloads

public PdfAnalysisReport Analyze(PdfComplianceProfile complianceProfile = None) #

PdfDocument.Operations.cs:41

Returns: PdfAnalysisReport

Produces one consolidated health and capability report. Supply a compliance profile to include artifact readback readiness.

Parameters

complianceProfile OfficeIMO.Pdf.PdfComplianceProfile = None optionalposition: 0

public PdfAnalysisReport Analyze(PdfComplianceProfile complianceProfile, CancellationToken cancellationToken) #

PdfDocument.Operations.cs:49

Returns: PdfAnalysisReport

Produces one consolidated health and capability report with cooperative cancellation.

Parameters

complianceProfile OfficeIMO.Pdf.PdfComplianceProfile requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

public PdfAppendOnlyMutationReport AnalyzeAppendOnlyMutation(PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:192

Returns: PdfAppendOnlyMutationReport

Analyzes which append-only mutation actions OfficeIMO.Pdf can safely attempt for this PDF.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

AnalyzeTextEncoding 2 overloads

public IReadOnlyList<PdfTextEncodingDiagnostic> AnalyzeTextEncoding() #

PdfDocument.TextDiagnostics.cs:14

Returns: IReadOnlyList<PdfTextEncodingDiagnostic>

Analyzes generated document text against the configured PDF text encoding before rendering.

public IReadOnlyList<PdfTextEncodingDiagnostic> AnalyzeTextEncoding(CancellationToken cancellationToken) #

PdfDocument.TextDiagnostics.cs:23

Returns: IReadOnlyList<PdfTextEncodingDiagnostic>

Analyzes generated PDF text while honoring cancellation during document traversal.

Parameters

cancellationToken System.Threading.CancellationToken requiredposition: 0: Token checked before preflight and while visiting generated content.

Returns

Encoding diagnostics in generated document order.

Exceptions

OperationCanceledException – The supplied token is canceled.

public PdfDocument AppendMetadataRevision(String? title = null, String? author = null, String? subject = null, String? keywords = null, Boolean createXmpMetadata = false)

PdfDocument.Operations.cs:722

Returns: PdfDocument

Appends a metadata-only incremental revision without rewriting the existing PDF bytes.

Parameters

title System.String? = null optionalposition: 0
author System.String? = null optionalposition: 1
subject System.String? = null optionalposition: 2
keywords System.String? = null optionalposition: 3
createXmpMetadata System.Boolean = false optionalposition: 4

public PdfOperationResult<PdfDocument> AppendMetadataRevisionResult(String? title = null, String? author = null, String? subject = null, String? keywords = null, PdfLoadOptions? options = null, Boolean createXmpMetadata = false)

PdfDocument.Operations.cs:735

Returns: PdfOperationResult<PdfDocument>

Attempts to append a metadata-only incremental revision, returning diagnostics when blocked or failed.

Parameters

title System.String? = null optionalposition: 0
author System.String? = null optionalposition: 1
subject System.String? = null optionalposition: 2
keywords System.String? = null optionalposition: 3
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4
createXmpMetadata System.Boolean = false optionalposition: 5

AssessCompliance 3 overloads

public PdfComplianceReadinessReport AssessCompliance() #

PdfDocument.IO.cs:8

Returns: PdfComplianceReadinessReport

Analyzes this generated document against its configured compliance profile using the same layout path as PDF output.

public PdfComplianceReadinessReport AssessCompliance(PdfComplianceProfile profile) #

PdfDocument.IO.cs:16

Returns: PdfComplianceReadinessReport

Analyzes this document against a formal compliance profile. Generated documents use layout evidence; opened documents use artifact readback evidence.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile requiredposition: 0: Compliance profile to assess without enabling formal profile generation.

public PdfComplianceReadinessReport AssessCompliance(PdfComplianceProfile profile, CancellationToken cancellationToken) #

PdfDocument.IO.cs:21

Returns: PdfComplianceReadinessReport

Analyzes a compliance profile while observing cancellation during opened-PDF readback.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

AssessComplianceProof 2 overloads

public PdfComplianceProofReport AssessComplianceProof(IEnumerable<PdfExternalValidationResult>? externalValidations = null)

PdfDocument.IO.cs:37

Returns: PdfComplianceProofReport

Combines generated-document compliance readiness for the configured profile with external validator evidence.

Parameters

externalValidations System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfExternalValidationResult>? = null optionalposition: 0

public PdfComplianceProofReport AssessComplianceProof(PdfComplianceProfile profile, IEnumerable<PdfExternalValidationResult>? externalValidations = null)

PdfDocument.IO.cs:86

Returns: PdfComplianceProofReport

Combines generated-document compliance readiness for a formal profile with external validator evidence.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile requiredposition: 0: Compliance profile to assess without enabling formal profile generation.
externalValidations System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfExternalValidationResult>? = null optionalposition: 1: Optional external validator results to combine with OfficeIMO.Pdf readiness evidence.

public PdfDeclaredComplianceClaimsReport AssessDeclaredComplianceClaims(IEnumerable<PdfExternalValidationResult>? externalValidations = null)

PdfDocument.DeclaredCompliance.cs:10

Returns: PdfDeclaredComplianceClaimsReport

Assesses PDF/A and PDF/UA declarations found in XMP metadata against the exact PDF bytes. Declared metadata alone is never accepted as conformance proof.

Parameters

externalValidations System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfExternalValidationResult>? = null optionalposition: 0

AssessMutations 2 overloads

public PdfMutationPortfolioReport AssessMutations(IEnumerable<PdfMutationOperation>? operations = null, IEnumerable<String>? fieldNames = null, PdfLoadOptions? options = null, PdfMutationExecutionPreference executionPreference = Automatic)

PdfDocument.MutationPortfolio.cs:16

Returns: PdfMutationPortfolioReport

Assesses several mutation families against one shared preflight snapshot.

Parameters

operations System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfMutationOperation>? = null optionalposition: 0
fieldNames System.Collections.Generic.IEnumerable<System.String>? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
executionPreference OfficeIMO.Pdf.PdfMutationExecutionPreference = Automatic optionalposition: 3

public PdfMutationPortfolioReport AssessMutations(CancellationToken cancellationToken, IEnumerable<PdfMutationOperation>? operations = null, IEnumerable<String>? fieldNames = null, PdfLoadOptions? options = null, PdfMutationExecutionPreference executionPreference = Automatic)

PdfDocument.MutationPortfolio.cs:29

Returns: PdfMutationPortfolioReport

Assesses mutation families with cooperative cancellation and one shared preflight snapshot.

Parameters

cancellationToken System.Threading.CancellationToken requiredposition: 0
operations System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfMutationOperation>? = null optionalposition: 1
fieldNames System.Collections.Generic.IEnumerable<System.String>? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
executionPreference OfficeIMO.Pdf.PdfMutationExecutionPreference = Automatic optionalposition: 4

AssessRenderCompatibility 2 overloads

public PdfRenderCompatibilityReport AssessRenderCompatibility(PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:204

Returns: PdfRenderCompatibilityReport

Assesses managed page-render fidelity without rasterizing or writing image artifacts.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

public PdfRenderCompatibilityReport AssessRenderCompatibility(PdfLoadOptions? options, PdfPageRenderOptions? renderOptions)

PdfDocument.Operations.cs:209

Returns: PdfRenderCompatibilityReport

Assesses managed page-render fidelity with configurable per-page diagnostic limits.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 0
renderOptions OfficeIMO.Pdf.PdfPageRenderOptions? requiredposition: 1

public PdfDocument Compose(Action<PdfDocumentBuilder> compose) #

PdfDocument.Blocks.Flow.cs:23

Returns: PdfDocument

Higher-level composition model (page size/margins/footer + content), similar to other document DSLs. Sugar only; composes into the same PdfDocument blocks and options.

Parameters

compose System.Action<OfficeIMO.Pdf.PdfDocumentBuilder> requiredposition: 0

Create 2 overloads

public static PdfDocument Create(PdfOptions? options = null) #

PdfDocument.Meta.cs:82

Returns: PdfDocument

Creates a new, empty PDF document with optional options.

Parameters

options OfficeIMO.Pdf.PdfOptions? = null optionalposition: 0: Page size, margins and default font options. When null, sensible defaults are used.

Returns

New PdfDocument instance.

public static PdfDocument Create(Action<PdfDocumentBuilder> compose, PdfOptions? options = null) #

PdfDocument.Meta.cs:102

Returns: PdfDocument

Creates and composes a PDF document through the canonical authoring DSL.

Parameters

compose System.Action<OfficeIMO.Pdf.PdfDocumentBuilder> requiredposition: 0: Document composition callback.
options OfficeIMO.Pdf.PdfOptions? = null optionalposition: 1: Optional document-wide rendering, catalog, security, and compliance options.

Returns

The composed PdfDocument.

CreateComplianceArtifact 2 overloads

public PdfComplianceArtifact CreateComplianceArtifact() #

PdfDocument.IO.cs:43

Returns: PdfComplianceArtifact

Atomically renders or snapshots this document with readiness evidence for its configured compliance profile.

public PdfComplianceArtifact CreateComplianceArtifact(PdfComplianceProfile profile) #

PdfDocument.IO.cs:51

Returns: PdfComplianceArtifact

Atomically renders or snapshots this document with readiness evidence for profile. Use the returned artifact's bytes for external validation, then call its PdfComplianceArtifact.AssessProof method with those validator results.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile requiredposition: 0

CreateFromImages 4 overloads

public static PdfDocument CreateFromImages(IEnumerable<String> imagePaths, PdfImageDocumentOptions? options = null) #

PdfDocument.Images.cs:122

Returns: PdfDocument

Creates one PDF page per image file in caller order.

Parameters

imagePaths System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
options OfficeIMO.Pdf.PdfImageDocumentOptions? = null optionalposition: 1

public static PdfDocument CreateFromImages(IEnumerable<String> imagePaths, PdfImageDocumentOptions? options, CancellationToken cancellationToken)

PdfDocument.Images.cs:132

Returns: PdfDocument

Creates one PDF page per image file in caller order with cooperative cancellation.

Parameters

imagePaths System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
options OfficeIMO.Pdf.PdfImageDocumentOptions? requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2

public static PdfDocument CreateFromImages(IEnumerable<PdfImageDocumentSource> images, PdfImageDocumentOptions? options = null)

PdfDocument.Images.cs:145

Returns: PdfDocument

Creates one PDF page per encoded image source in caller order.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> requiredposition: 0
options OfficeIMO.Pdf.PdfImageDocumentOptions? = null optionalposition: 1

public static PdfDocument CreateFromImages(IEnumerable<PdfImageDocumentSource> images, PdfImageDocumentOptions? options, CancellationToken cancellationToken)

PdfDocument.Images.cs:153

Returns: PdfDocument

Creates one PDF page per encoded image source in caller order with cooperative cancellation.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> requiredposition: 0
options OfficeIMO.Pdf.PdfImageDocumentOptions? requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2

public PdfDebuggerReport Debug(PdfDebuggerOptions? options = null, PdfLoadOptions? readOptions = null) #

PdfDocument.Operations.cs:240

Returns: PdfDebuggerReport

Creates a bounded debugger projection of objects, revisions, pages, resources, and content operators.

Parameters

options OfficeIMO.Pdf.PdfDebuggerOptions? = null optionalposition: 0
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public PdfDiagnosticReport Diagnostics(PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:228

Returns: PdfDiagnosticReport

Builds a combined PDF diagnostic report for this document.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

public PdfInteractiveContentFlattenResult FlattenInteractiveContent(PdfInteractiveContentFlattenOptions? options = null) #

PdfDocument.InteractiveFlattening.cs:6

Returns: PdfInteractiveContentFlattenResult

Flattens readable AcroForm fields and supported visual annotations into one new PDF artifact.

Parameters

options OfficeIMO.Pdf.PdfInteractiveContentFlattenOptions? = null optionalposition: 0

public PdfDocument FlattenVisualAnnotations() #

PdfDocument.Operations.cs:703

Returns: PdfDocument

Creates a new PDF with visual annotation appearance streams painted into page content where supported.

public PdfOperationResult<PdfDocument> FlattenVisualAnnotationsResult(PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:710

Returns: PdfOperationResult<PdfDocument>

Attempts to flatten visual annotation appearance streams, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

public PdfPageInteractionMap GetEditingInteractions(Int32 pageNumber) #

PdfDocument.EditingInteractions.cs:7

Returns: PdfPageInteractionMap

Reads visual hit regions for permitted annotation and form editing, without extracting page text or images.

Parameters

pageNumber System.Int32 requiredposition: 0

GetPageLayouts 2 overloads

public IReadOnlyList<PdfPageLayoutInfo> GetPageLayouts(PdfLoadOptions? options = null) #

PdfDocument.PageLayouts.cs:10

Returns: IReadOnlyList<PdfPageLayoutInfo>

Reads page geometry without extracting document content or requiring copy permission.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

public IReadOnlyList<PdfPageLayoutInfo> GetPageLayouts(PdfLoadOptions? options, CancellationToken cancellationToken) #

PdfDocument.PageLayouts.cs:19

Returns: IReadOnlyList<PdfPageLayoutInfo>

Reads page geometry with cooperative cancellation, without extracting document content or requiring copy permission.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

GetPrintablePageLayouts 2 overloads

public IReadOnlyList<PdfPageLayoutInfo> GetPrintablePageLayouts(PdfLoadOptions? options = null) #

PdfDocument.PageLayouts.cs:27

Returns: IReadOnlyList<PdfPageLayoutInfo>

Reads page geometry for printing after enforcing the authenticated document permissions.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

public IReadOnlyList<PdfPageLayoutInfo> GetPrintablePageLayouts(PdfLoadOptions? options, CancellationToken cancellationToken)

PdfDocument.PageLayouts.cs:36

Returns: IReadOnlyList<PdfPageLayoutInfo>

Reads page geometry for printing with cooperative cancellation after enforcing the authenticated document permissions.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

Inspect 2 overloads

public PdfDocumentInfo Inspect(PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:99

Returns: PdfDocumentInfo

Inspects metadata, pages, annotations, fields, and catalog-level state.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

public PdfDocumentInfo Inspect(PdfLoadOptions? options, CancellationToken cancellationToken) #

PdfDocument.Operations.cs:105

Returns: PdfDocumentInfo

Inspects metadata, pages, annotations, fields, and catalog-level state with cooperative cancellation.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

InspectContentSafety 2 overloads

public static OfficeContentSafetyReport InspectContentSafety(String filePath, OfficeContentSafetyOptions? options = null, PdfLoadOptions? readOptions = null)

PdfDocument.ContentSafety.cs:14

Returns: OfficeContentSafetyReport

Inspects decoded PDF text for exact paint, clipping, geometry, contrast, and Unicode evidence.

Parameters

filePath System.String requiredposition: 0
options OfficeIMO.ContentSafety.OfficeContentSafetyOptions? = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2

public static OfficeContentSafetyReport InspectContentSafety(Byte[] pdf, OfficeContentSafetyOptions? options = null, PdfLoadOptions? readOptions = null)

PdfDocument.ContentSafety.cs:25

Returns: OfficeContentSafetyReport

Inspects encoded PDF bytes without treating concealment as evidence of AI authorship.

Parameters

pdf System.Byte[] requiredposition: 0
options OfficeIMO.ContentSafety.OfficeContentSafetyOptions? = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2

public PdfDocumentViewInfo InspectForViewing(PdfLoadOptions? options = null, CancellationToken cancellationToken = default)

PdfDocument.Viewing.cs:11

Returns: PdfDocumentViewInfo

Inspects authenticated page geometry for viewing without requiring content-copy permission. Full logical inspection is included only when extraction is authorized. This does not change mutation or extraction policy.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

public PdfDocumentViewInfo InspectGeometryForViewing(PdfLoadOptions? options = null, CancellationToken cancellationToken = default)

PdfDocument.Viewing.cs:18

Returns: PdfDocumentViewInfo

Inspects authenticated page geometry and permissions without decoding logical page content, even when extraction is permitted.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

public PdfSanitizationReport InspectSanitization(PdfSanitizationOptions? options = null) #

PdfDocument.Operations.cs:872

Returns: PdfSanitizationReport

Inspects what the supplied sanitization policy would remove without modifying the PDF.

Parameters

options OfficeIMO.Pdf.PdfSanitizationOptions? = null optionalposition: 0

Load 5 overloads

public static PdfDocument Load(Byte[] pdf, PdfLoadOptions? loadOptions = null) #

PdfDocument.Meta.cs:110

Returns: PdfDocument

Loads an existing PDF from bytes and snapshots the caller-owned input once.

Parameters

pdf System.Byte[] requiredposition: 0
loadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public static PdfDocument Load(String path, PdfLoadOptions? loadOptions = null) #

PdfDocument.Meta.cs:131

Returns: PdfDocument

Loads an existing PDF from a bounded file snapshot.

Parameters

path System.String requiredposition: 0
loadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public static PdfDocument Load(Stream stream, PdfLoadOptions? loadOptions = null) #

PdfDocument.Meta.cs:137

Returns: PdfDocument

Loads a complete PDF from a readable stream. Seekable streams are read from the beginning and restored.

Parameters

stream System.IO.Stream requiredposition: 0
loadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public static PdfDocument Load(String path, PdfLoadOptions? loadOptions, CancellationToken cancellationToken) #

PdfDocument.Meta.cs:141

Returns: PdfDocument

Loads a bounded file snapshot with cooperative cancellation.

Parameters

path System.String requiredposition: 0
loadOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2

public static PdfDocument Load(Stream stream, PdfLoadOptions? loadOptions, CancellationToken cancellationToken) #

PdfDocument.Meta.cs:145

Returns: PdfDocument

Loads a bounded stream snapshot with cooperative cancellation and preserves seekable stream position.

Parameters

stream System.IO.Stream requiredposition: 0
loadOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2

LoadAsync 2 overloads

public static async Task<PdfDocument> LoadAsync(String path, PdfLoadOptions? loadOptions = null, CancellationToken cancellationToken = default)

Returns: Task<PdfDocument>

Asynchronously loads an existing PDF from a bounded file snapshot.

Parameters

path System.String requiredposition: 0
loadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2

public static async Task<PdfDocument> LoadAsync(Stream stream, PdfLoadOptions? loadOptions = null, CancellationToken cancellationToken = default)

Returns: Task<PdfDocument>

Asynchronously loads a complete PDF from a readable caller-owned stream.

Parameters

stream System.IO.Stream requiredposition: 0
loadOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2

Merge 5 overloads

public static PdfDocument Merge(PdfMergeOptions options, params PdfDocument[] documents) #

PdfDocument.Merge.cs:8

Returns: PdfDocument

Merges loaded or generated documents using an explicit structure policy.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
documents OfficeIMO.Pdf.PdfDocument[] requiredposition: 1

public static PdfDocument Merge(PdfMergeOptions options, IEnumerable<PdfDocument> documents) #

PdfDocument.Merge.cs:12

Returns: PdfDocument

Merges loaded or generated documents using an explicit structure policy.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
documents System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfDocument> requiredposition: 1

public static PdfDocument Merge(params PdfDocument[] documents) #

PdfDocument.Operations.cs:481

Returns: PdfDocument

Creates one PDF by merging all supplied documents in order through a single merge pass.

Parameters

documents OfficeIMO.Pdf.PdfDocument[] requiredposition: 0

public static PdfDocument Merge(IEnumerable<PdfDocument> documents) #

PdfDocument.Operations.cs:485

Returns: PdfDocument

Creates one PDF by merging all supplied documents in order through a single merge pass.

Parameters

documents System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfDocument> requiredposition: 0

public static PdfDocument Merge(IEnumerable<PdfDocument> documents, CancellationToken cancellationToken) #

PdfDocument.Operations.cs:565

Returns: PdfDocument

Creates one PDF by merging all supplied documents in order through a cancellable single merge pass.

Parameters

documents System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfDocument> requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

MergeBytes 3 overloads

public static PdfDocument MergeBytes(PdfMergeOptions options, IEnumerable<Byte[]> pdfs) #

PdfDocument.Merge.cs:19

Returns: PdfDocument

Merges caller-owned PDF byte payloads using an explicit structure policy. The inputs are consumed synchronously and are not retained by the returned document.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
pdfs System.Collections.Generic.IEnumerable<System.Byte[]> requiredposition: 1

public static PdfDocument MergeBytes(IEnumerable<Byte[]> pdfs) #

PdfDocument.Operations.cs:493

Returns: PdfDocument

Creates one PDF by merging the supplied caller-owned PDF byte payloads in order. The inputs are consumed synchronously and are not retained by the returned document.

Parameters

pdfs System.Collections.Generic.IEnumerable<System.Byte[]> requiredposition: 0

public static PdfDocument MergeBytes(IEnumerable<Byte[]> pdfs, CancellationToken cancellationToken) #

PdfDocument.Operations.cs:503

Returns: PdfDocument

Creates one PDF by merging the supplied caller-owned PDF byte payloads in order through a cancellable single merge pass. The inputs are consumed synchronously and are not retained by the returned document.

Parameters

pdfs System.Collections.Generic.IEnumerable<System.Byte[]> requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

public static PdfMergeResult MergeBytesResult(PdfMergeOptions options, IEnumerable<Byte[]> pdfs) #

PdfDocument.Merge.cs:69

Returns: PdfMergeResult

Merges caller-owned PDF byte payloads with an explicit structure policy and returns readback evidence. The inputs are consumed synchronously and are not retained by the result.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
pdfs System.Collections.Generic.IEnumerable<System.Byte[]> requiredposition: 1

MergeResult 3 overloads

public static PdfMergeResult MergeResult(PdfMergeOptions options, params PdfDocument[] documents) #

PdfDocument.Merge.cs:37

Returns: PdfMergeResult

Merges loaded or generated documents with an explicit structure policy and returns readback evidence.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
documents OfficeIMO.Pdf.PdfDocument[] requiredposition: 1

public static PdfMergeResult MergeResult(PdfMergeOptions options, IEnumerable<PdfDocument> documents) #

PdfDocument.Merge.cs:41

Returns: PdfMergeResult

Merges loaded or generated documents with an explicit structure policy and returns readback evidence.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
documents System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfDocument> requiredposition: 1

public static PdfMergeResult MergeResult(PdfMergeOptions options, IEnumerable<PdfDocument> documents, CancellationToken cancellationToken)

PdfDocument.Merge.cs:45

Returns: PdfMergeResult

Merges documents with an explicit structure policy and cooperative cancellation, returning readback evidence.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
documents System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfDocument> requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2

MergeToBytes 5 overloads

public static Byte[] MergeToBytes(PdfMergeOptions options, params Byte[][] pdfs) #

PdfDocument.Merge.cs:26

Returns: Byte[]

Merges caller-owned PDF byte payloads using an explicit structure policy and returns the merged artifact directly. The inputs are consumed synchronously and are not retained; the returned array is owned by the caller.

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
pdfs System.Byte[][] requiredposition: 1

public static Byte[] MergeToBytes(PdfMergeOptions options, IEnumerable<Byte[]> pdfs) #

PdfDocument.Merge.cs:33

Returns: Byte[]

Parameters

options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 0
pdfs System.Collections.Generic.IEnumerable<System.Byte[]> requiredposition: 1

public static Byte[] MergeToBytes(params Byte[][] pdfs) #

PdfDocument.Operations.cs:512

Returns: Byte[]

Merges the supplied caller-owned PDF byte payloads and returns the merged artifact directly. The inputs are consumed synchronously and are not retained; the returned array is owned by the caller.

Parameters

pdfs System.Byte[][] requiredposition: 0

public static Byte[] MergeToBytes(IEnumerable<Byte[]> pdfs) #

PdfDocument.Operations.cs:519

Returns: Byte[]

Merges the supplied caller-owned PDF byte payloads and returns the merged artifact directly. The inputs are consumed synchronously and are not retained; the returned array is owned by the caller.

Parameters

pdfs System.Collections.Generic.IEnumerable<System.Byte[]> requiredposition: 0

public static Byte[] MergeToBytes(IEnumerable<Byte[]> pdfs, CancellationToken cancellationToken) #

PdfDocument.Operations.cs:528

Returns: Byte[]

Merges the supplied caller-owned PDF byte payloads through a cancellable single pass and returns the merged artifact directly. The inputs are consumed synchronously and are not retained; the returned array is owned by the caller.

Parameters

pdfs System.Collections.Generic.IEnumerable<System.Byte[]> requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

MergeWith 5 overloads

public PdfDocument MergeWith(PdfDocument document, PdfMergeOptions options) #

PdfDocument.Merge.cs:80

Returns: PdfDocument

Merges this PDF with another loaded or generated PDF using an explicit structure policy.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 1

public PdfDocument MergeWith(PdfDocument document) #

PdfDocument.Operations.cs:607

Returns: PdfDocument

Creates a new PDF by merging this PDF with another loaded or generated PDF.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0

public PdfDocument MergeWith(Byte[] pdf) #

PdfDocument.Operations.cs:633

Returns: PdfDocument

Creates a new PDF by merging this PDF with another PDF byte payload. The input is consumed synchronously and is not retained by the returned document.

Parameters

pdf System.Byte[] requiredposition: 0

public PdfDocument MergeWith(String path) #

PdfDocument.Operations.cs:659

Returns: PdfDocument

Creates a new PDF by merging this PDF with another PDF file.

Parameters

path System.String requiredposition: 0

public PdfDocument MergeWith(Stream stream) #

PdfDocument.Operations.cs:679

Returns: PdfDocument

Creates a new PDF by merging this PDF with another readable PDF stream.

Parameters

stream System.IO.Stream requiredposition: 0

MergeWithResult 5 overloads

public PdfMergeResult MergeWithResult(PdfDocument document, PdfMergeOptions options) #

PdfDocument.Merge.cs:87

Returns: PdfMergeResult

Merges this PDF with another loaded or generated PDF and returns structure and readback evidence.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
options OfficeIMO.Pdf.PdfMergeOptions requiredposition: 1

public PdfOperationResult<PdfDocument> MergeWithResult(PdfDocument document, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:624

Returns: PdfOperationResult<PdfDocument>

Attempts to merge this PDF with another loaded or generated PDF, returning diagnostics when blocked or failed.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public PdfOperationResult<PdfDocument> MergeWithResult(Byte[] pdf, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:651

Returns: PdfOperationResult<PdfDocument>

Attempts to merge this PDF with another PDF byte payload, returning diagnostics when blocked or failed. The input is consumed synchronously and is not retained by the result.

Parameters

pdf System.Byte[] requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public PdfOperationResult<PdfDocument> MergeWithResult(String path, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:671

Returns: PdfOperationResult<PdfDocument>

Attempts to merge this PDF with another PDF file, returning diagnostics when blocked or failed.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public PdfOperationResult<PdfDocument> MergeWithResult(Stream stream, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:695

Returns: PdfOperationResult<PdfDocument>

Attempts to merge this PDF with another readable PDF stream, returning diagnostics when blocked or failed.

Parameters

stream System.IO.Stream requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public PdfDocument Meta(String? title = null, String? author = null, String? subject = null, String? keywords = null) #

PdfDocument.Meta.cs:265

Returns: PdfDocument

Sets PDF metadata. Only values provided are updated; missing parameters keep previous values. Pass an empty string to clear a previously assigned value.

Parameters

title System.String? = null optionalposition: 0: Document title metadata.
author System.String? = null optionalposition: 1: Document author metadata.
subject System.String? = null optionalposition: 2: Document subject metadata.
keywords System.String? = null optionalposition: 3: Document keywords metadata.

Returns

This PdfDocument for chaining.

PlanMutation 2 overloads

public PdfMutationPlan PlanMutation(PdfMutationOperation operation, IEnumerable<String>? fieldNames = null, PdfLoadOptions? options = null, PdfMutationExecutionPreference executionPreference = Automatic)

PdfDocument.Operations.cs:149

Returns: PdfMutationPlan

Chooses a full-rewrite, append-only, or blocked path for an existing-document mutation.

Parameters

operation OfficeIMO.Pdf.PdfMutationOperation requiredposition: 0
fieldNames System.Collections.Generic.IEnumerable<System.String>? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
executionPreference OfficeIMO.Pdf.PdfMutationExecutionPreference = Automatic optionalposition: 3

public PdfMutationPlan PlanMutation(PdfMutationOperation operation, IEnumerable<String>? fieldNames, PdfLoadOptions? options, PdfMutationExecutionPreference executionPreference, CancellationToken cancellationToken)

PdfDocument.Operations.cs:159

Returns: PdfMutationPlan

Chooses a mutation path while observing cancellation during parsing and preflight.

Parameters

operation OfficeIMO.Pdf.PdfMutationOperation requiredposition: 0
fieldNames System.Collections.Generic.IEnumerable<System.String>? requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 2
executionPreference OfficeIMO.Pdf.PdfMutationExecutionPreference requiredposition: 3
cancellationToken System.Threading.CancellationToken requiredposition: 4

Preflight 6 overloads

public static PdfDocumentPreflight Preflight(Byte[] pdf, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:11

Returns: PdfDocumentPreflight

Reports read and rewrite capabilities for a PDF byte array without requiring the document to open successfully. This is useful for encrypted, malformed, or otherwise unsupported input that still needs a diagnostic report.

Parameters

pdf System.Byte[] requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public static PdfDocumentPreflight Preflight(Byte[] pdf, PdfLoadOptions? options, CancellationToken cancellationToken) #

PdfDocument.Operations.cs:20

Returns: PdfDocumentPreflight

Reports read and rewrite capabilities for a PDF byte array with cooperative cancellation.

Parameters

pdf System.Byte[] requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2

public static PdfDocumentPreflight Preflight(String path, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:27

Returns: PdfDocumentPreflight

Reports read and rewrite capabilities for a PDF file without requiring the document to open successfully. This is useful for encrypted, malformed, or otherwise unsupported input that still needs a diagnostic report.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public static PdfDocumentPreflight Preflight(Stream stream, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:34

Returns: PdfDocumentPreflight

Reports read and rewrite capabilities for a readable PDF stream without requiring the document to open successfully. The stream is consumed from its current position.

Parameters

stream System.IO.Stream requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public PdfDocumentPreflight Preflight(PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:122

Returns: PdfDocumentPreflight

Reports read and rewrite capabilities for this PDF.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0

public PdfDocumentPreflight Preflight(PdfLoadOptions? options, CancellationToken cancellationToken) #

PdfDocument.Operations.cs:126

Returns: PdfDocumentPreflight

Reports read and rewrite capabilities with cooperative cancellation.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

public PdfDocumentReadResult Read(PdfReadOptions? options = null, CancellationToken cancellationToken = default) #

PdfDocument.Meta.cs:179

Returns: PdfDocumentReadResult

Builds the canonical semantic document result using the structured profile by default.

Parameters

options OfficeIMO.Pdf.PdfReadOptions? = null optionalposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

public PdfInspectionReadResult ReadForInspection(PdfReadOptions? options = null, CancellationToken cancellationToken = default)

PdfDocument.InspectionRead.cs:14

Returns: PdfInspectionReadResult

Reads supported selected pages while retaining structural facts and explicit outcomes for unmappable text and unsupported content-stream filters. Existing PdfDocument.Read remains fail-fast. Cancellation, resource admission, authentication, permissions, structural parsing, and unexpected stage failures remain terminal and are never converted to partial success.

Parameters

options OfficeIMO.Pdf.PdfReadOptions? = null optionalposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

RemoveSelectedContent 2 overloads

public static OfficeContentCleanupResult RemoveSelectedContent(Byte[] pdf, OfficeContentCleanupSelection selection, OfficeContentCleanupOptions? options = null, PdfLoadOptions? readOptions = null)

PdfDocument.ContentSafety.cs:41

Returns: OfficeContentCleanupResult

Physically removes exact selected PDF text spans and verifies the rewritten artifact.

Parameters

pdf System.Byte[] requiredposition: 0
selection OfficeIMO.ContentSafety.OfficeContentCleanupSelection requiredposition: 1
options OfficeIMO.ContentSafety.OfficeContentCleanupOptions? = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3

public static OfficeContentCleanupResult RemoveSelectedContent(String inputPath, String outputPath, OfficeContentCleanupSelection selection, OfficeContentCleanupOptions? options = null, PdfLoadOptions? readOptions = null)

PdfDocument.ContentSafety.cs:82

Returns: OfficeContentCleanupResult

Atomically writes an explicitly cleaned PDF artifact.

Parameters

inputPath System.String requiredposition: 0
outputPath System.String requiredposition: 1
selection OfficeIMO.ContentSafety.OfficeContentCleanupSelection requiredposition: 2
options OfficeIMO.ContentSafety.OfficeContentCleanupOptions? = null optionalposition: 3
readOptions OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4

public PdfDocument ReplaceMetadata(PdfMetadata metadata) #

PdfDocument.Operations.cs:893

Returns: PdfDocument

Creates a new PDF with exactly the supplied metadata.

Parameters

metadata OfficeIMO.Pdf.PdfMetadata requiredposition: 0

public PdfOperationResult<PdfDocument> ReplaceMetadataResult(PdfMetadata metadata, PdfLoadOptions? options = null) #

PdfDocument.Operations.cs:904

Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with exactly the supplied metadata, returning diagnostics when blocked or failed.

Parameters

metadata OfficeIMO.Pdf.PdfMetadata requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1

public PdfSanitizationResult Sanitize(PdfSanitizationOptions? options = null) #

PdfDocument.Operations.cs:867

Returns: PdfSanitizationResult

Removes or quarantines active content and embedded payloads through a proven full rewrite.

Parameters

options OfficeIMO.Pdf.PdfSanitizationOptions? = null optionalposition: 0

Save 4 overloads

public PdfSaveResult Save(Stream stream) #

PdfDocument.IO.cs:145

Returns: PdfSaveResult

Writes the complete document to stream. Seekable streams are overwritten and rewound.

Parameters

stream System.IO.Stream requiredposition: 0: Writable destination stream.

public PdfSaveResult Save(Stream stream, CancellationToken cancellationToken) #

PdfDocument.IO.cs:149

Returns: PdfSaveResult

Writes the PDF while observing cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

public PdfSaveResult Save(String path) #

PdfDocument.IO.cs:182

Returns: PdfSaveResult

Saves the document to path. Creates the directory if needed.

Parameters

path System.String requiredposition: 0: Destination file path, e.g. "C:\\Docs\\Report.pdf".

public PdfSaveResult Save(String path, CancellationToken cancellationToken) #

PdfDocument.IO.cs:186

Returns: PdfSaveResult

Writes the PDF while observing cancellation.

Parameters

path System.String requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

SaveAsync 3 overloads

public async Task<PdfSaveResult> SaveAsync(Stream stream, CancellationToken cancellationToken = default) #

Returns: Task<PdfSaveResult>

Asynchronously writes the complete document to stream. Seekable streams are overwritten and rewound.

Parameters

stream System.IO.Stream requiredposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

public Task<PdfSaveResult> SaveAsync(String path, CancellationToken cancellationToken = default) #

PdfDocument.IO.cs:260

Returns: Task<PdfSaveResult>

Asynchronously saves the document to path.

Parameters

path System.String requiredposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

public async Task<PdfSaveResult> SaveAsync(String path, OfficeConversionFileConflictPolicy conflictPolicy, CancellationToken cancellationToken)

Returns: Task<PdfSaveResult>

Asynchronously saves the document to path using the requested destination conflict policy.

Parameters

path System.String requiredposition: 0
conflictPolicy OfficeIMO.OfficeConversionFileConflictPolicy requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2

SaveResult 4 overloads

public PdfSaveResult SaveResult(Stream stream) #

PdfDocument.IO.cs:161

Returns: PdfSaveResult

Attempts to write the document to stream and returns output diagnostics instead of throwing.

Parameters

stream System.IO.Stream requiredposition: 0

public PdfSaveResult SaveResult(Stream stream, CancellationToken cancellationToken) #

PdfDocument.IO.cs:165

Returns: PdfSaveResult

Writes the PDF while observing cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

public PdfSaveResult SaveResult(String path) #

PdfDocument.IO.cs:208

Returns: PdfSaveResult

Attempts to save the document to path and returns output diagnostics instead of throwing.

Parameters

path System.String requiredposition: 0

public PdfSaveResult SaveResult(String path, CancellationToken cancellationToken) #

PdfDocument.IO.cs:212

Returns: PdfSaveResult

Writes the PDF while observing cancellation.

Parameters

path System.String requiredposition: 0
cancellationToken System.Threading.CancellationToken requiredposition: 1

SaveResultAsync 2 overloads

public async Task<PdfSaveResult> SaveResultAsync(Stream stream, CancellationToken cancellationToken = default) #

Returns: Task<PdfSaveResult>

Attempts to asynchronously write the document to stream and returns output diagnostics instead of throwing.

Parameters

stream System.IO.Stream requiredposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

public async Task<PdfSaveResult> SaveResultAsync(String path, CancellationToken cancellationToken = default) #

Returns: Task<PdfSaveResult>

Attempts to asynchronously save the document to path and returns output diagnostics instead of throwing.

Parameters

path System.String requiredposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1

public PdfDocument SynchronizeMetadata(String? title = null, String? author = null, String? subject = null, String? keywords = null, Boolean createXmpMetadata = true)

PdfDocument.Operations.cs:824

Returns: PdfDocument

Creates a normalized full-rewrite PDF whose Info dictionary and XMP packet share the supplied common fields. Null values preserve existing values and empty strings clear them.

Parameters

title System.String? = null optionalposition: 0
author System.String? = null optionalposition: 1
subject System.String? = null optionalposition: 2
keywords System.String? = null optionalposition: 3
createXmpMetadata System.Boolean = true optionalposition: 4

public PdfOperationResult<PdfDocument> SynchronizeMetadataResult(String? title = null, String? author = null, String? subject = null, String? keywords = null, Boolean createXmpMetadata = true, PdfLoadOptions? options = null)

PdfDocument.Operations.cs:846

Returns: PdfOperationResult<PdfDocument>

Attempts an Info/XMP synchronization through the planner-selected full-rewrite or append-only path.

Parameters

title System.String? = null optionalposition: 0
author System.String? = null optionalposition: 1
subject System.String? = null optionalposition: 2
keywords System.String? = null optionalposition: 3
createXmpMetadata System.Boolean = true optionalposition: 4
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 5

ToBytes 2 overloads

public Byte[] ToBytes() #

PdfDocument.IO.cs:95

Returns: Byte[]

Renders the document into a PDF byte array in memory.

public Byte[] ToBytes(CancellationToken cancellationToken) #

PdfDocument.IO.cs:99

Returns: Byte[]

Renders the PDF while observing cancellation.

Parameters

cancellationToken System.Threading.CancellationToken requiredposition: 0

ToBytesResult 2 overloads

public PdfBytesResult ToBytesResult() #

PdfDocument.IO.cs:114

Returns: PdfBytesResult

Attempts to render the document into a PDF byte array and returns diagnostics instead of throwing.

public PdfBytesResult ToBytesResult(CancellationToken cancellationToken) #

PdfDocument.IO.cs:118

Returns: PdfBytesResult

Renders the PDF while observing cancellation.

Parameters

cancellationToken System.Threading.CancellationToken requiredposition: 0

public MemoryStream ToStream() #

PdfDocument.IO.cs:109

Returns: MemoryStream

Renders the document into a new writable memory stream positioned at the beginning.

public static Boolean TryPrepareImageBytes(Byte[] data, out Byte[] preparedBytes, out OfficeImageInfo? imageInfo, out Boolean wasTranscoded, out String? unsupportedReason)

PdfDocument.Blocks.ImageValidation.cs:106

Returns: Boolean

Prepares source image bytes for first-party PDF embedding. Writer-safe JPEG and PNG data is retained; supported SVG and other raster formats supported by OfficeRasterImageDecoder are normalized to PNG.

Parameters

data System.Byte[] requiredposition: 0
preparedBytes System.Byte[] requiredposition: 1
imageInfo OfficeIMO.Drawing.OfficeImageInfo? requiredposition: 2
wasTranscoded System.Boolean requiredposition: 3
unsupportedReason System.String? requiredposition: 4

public static Boolean TryValidateImageBytes(Byte[] data, out OfficeImageInfo? imageInfo, out String? unsupportedReason) #

PdfDocument.Blocks.ImageValidation.cs:92

Returns: Boolean

Checks whether image bytes can be embedded by the first-party PDF writer.

Parameters

data System.Byte[] requiredposition: 0
imageInfo OfficeIMO.Drawing.OfficeImageInfo? requiredposition: 1
unsupportedReason System.String? requiredposition: 2

public PdfDocument UpdateMetadata(String? title = null, String? author = null, String? subject = null, String? keywords = null)

PdfDocument.Operations.cs:808

Returns: PdfDocument

Creates a new PDF with updated metadata. Null values preserve existing fields; empty strings clear fields.

Parameters

title System.String? = null optionalposition: 0
author System.String? = null optionalposition: 1
subject System.String? = null optionalposition: 2
keywords System.String? = null optionalposition: 3

public PdfOperationResult<PdfDocument> UpdateMetadataResult(String? title = null, String? author = null, String? subject = null, String? keywords = null, PdfLoadOptions? options = null)

PdfDocument.Operations.cs:879

Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with updated metadata, returning diagnostics when blocked or failed.

Parameters

title System.String? = null optionalposition: 0
author System.String? = null optionalposition: 1
subject System.String? = null optionalposition: 2
keywords System.String? = null optionalposition: 3
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4

Inherited Methods

Properties

public PdfContentBuilder Content { get; } #

PdfDocument.Meta.cs:90

Gets the content builder for ordinary incremental authoring. It uses the same document flow as PdfDocument.Compose and cannot add generated content to a loaded PDF.

public PdfDocumentPages Pages { get; } #

PdfDocument.Meta.cs:172

Page editing and extraction operations for this PDF.

public PdfDocumentRenderer Render { get; } #

PdfDocument.Meta.cs:190

Managed page rendering, drawing projection, and renderer diagnostics.

public PdfDocumentResources Resources { get; } #

PdfDocument.Meta.cs:194

Bounded font and raw object-resource inspection.

public PdfDocumentTextEditor Text { get; } #

PdfDocument.Meta.cs:198

Existing-page text search and editing operations.

public PdfDocumentImageEditor Images { get; } #

PdfDocument.Meta.cs:202

Existing-page image placement discovery and editing operations.

public PdfDocumentAttachments Attachments { get; } #

PdfDocument.Meta.cs:206

Existing-document embedded and associated file editing operations.

public PdfDocumentBookmarks Bookmarks { get; } #

PdfDocument.Meta.cs:210

Existing-document bookmark editing operations.

public PdfDocumentAnnotations Annotations { get; } #

PdfDocument.Meta.cs:214

Existing-document annotation editing operations.

public PdfDocumentJavaScript JavaScript { get; } #

PdfDocument.Meta.cs:218

Explicit active-content operations for named document-level JavaScript.

public PdfDocumentSecurity Security { get; } #

PdfDocument.Meta.cs:222

Password encryption and digital-signature operations for this PDF.

public PdfDocumentRedactions Redactions { get; } #

PdfDocument.Meta.cs:226

Search, planning, application, and verification operations for permanent redaction.

public PdfDocumentOptimization Optimization { get; } #

PdfDocument.Meta.cs:230

Lossless optimization analysis and rewrite operations for this PDF.

public PdfDocumentProof Proof { get; } #

PdfDocument.Meta.cs:234

Visual and structural preservation proof operations for this PDF.

public PdfPipelineReport Pipeline { get; } #

PdfDocument.Meta.cs:241

Immutable create/open and mutation history accumulated by this document. Save and byte-generation results append their own exact output stage.

public PdfDocumentStamper Stamp { get; } #

PdfDocument.Meta.cs:246

Text and image stamping operations for this PDF.

public PdfDocumentForms Forms { get; } #

PdfDocument.Meta.cs:252

Simple AcroForm operations for this PDF.

Extension Methods

public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfDocument document, OfficeImageExportFormat format, PdfImageExportOptions? options = null, PdfPageSelection? selection = null, CancellationToken cancellationToken = default)

PdfImageExportBuilder.cs:212

Returns: IReadOnlyList<OfficeImageExportResult>

Exports pages from an authored or opened PDF document using the shared five-format result contract.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Pdf.PdfImageExportOptions? = null optionalposition: 2
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4

ToImages 2 overloads

public static PdfDocumentImageExportBuilder ToImages(PdfDocument document) #

PdfImageExportBuilder.cs:311

Returns: PdfDocumentImageExportBuilder

Starts fluent image export for all pages in an authored or opened PDF document. The read snapshot is captured on first export so a pre-canceled operation does not materialize the document.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0

public static PdfDocumentImageExportBuilder ToImages(PdfDocument document, PdfImageExportOptions options) #

PdfImageExportBuilder.cs:318

Returns: PdfDocumentImageExportBuilder

Starts fluent image export for an authored or opened PDF document using a cloned options snapshot. The read snapshot is captured on first export.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions requiredposition: 1

Inheritance

Guides & Samples

Usage

Returned or exposed by 121

Accepted by parameters 25

Examples

Methods

Parameters

Parameters

Parameters

Parameters

Returns

Exceptions

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters