API Reference
Class
PdfDocument
Root PDF document container and fluent API for composing basic PDF files. Mirrors the OfficeIMO.Markdown style (H1/H2/H3, paragraph) but targets PDF output.
Inheritance
- Object
- PdfDocument
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
- Method PdfAcroFormEditResult.ToDocument
- Method PdfAnnotationEditResult.ToDocument
- Method PdfAttachmentEditResult.ToDocument
- Method PdfBookmarkEditResult.ToDocument
- Method PdfDestructiveCropResult.ToDocument
- Method PdfDocument.AcroFormDefaultTextAlignment
- Method PdfDocument.AppendMetadataRevision
- Method PdfDocument.ApplyRedactions
- Method PdfDocument.ApplyRedactions
- Method PdfDocument.AttachFacturXInvoiceXml
- Method PdfDocument.AttachFacturXInvoiceXmlFile
- Method PdfDocument.AttachFile
- Method PdfDocument.AttachFile
- Method PdfDocument.Background
- Method PdfDocument.BackgroundBottomBand
- Method PdfDocument.BackgroundEllipse
- Method PdfDocument.BackgroundImage
- Method PdfDocument.BackgroundImage
- Method PdfDocument.BackgroundLeftBand
- Method PdfDocument.BackgroundRectangle
- Method PdfDocument.BackgroundRightBand
- Method PdfDocument.BackgroundRoundedRectangle
- Method PdfDocument.BackgroundShape
- Method PdfDocument.BackgroundShapes
- Method PdfDocument.BackgroundTopBand
- Method PdfDocument.Bookmark
- Method PdfDocument.Bullets
- Method PdfDocument.Canvas
- Method PdfDocument.CatalogPageLayout
- Method PdfDocument.CatalogPageMode
- Method PdfDocument.CatalogUriBase
- Method PdfDocument.CatalogView
- Method PdfDocument.CheckBox
- Method PdfDocument.ChoiceField
- Method PdfDocument.ClearBackgroundShapes
- Method PdfDocument.Columns
- Method PdfDocument.CompleteExternalSignature
- Method PdfDocument.Compliance
- Method PdfDocument.Component
- Method PdfDocument.Component
- Method PdfDocument.Compose
- Method PdfDocument.ConfigureElectronicInvoiceGroundwork
- Method PdfDocument.ConfigureElectronicInvoiceGroundworkFile
- Method PdfDocument.ConfigureFacturXGroundwork
- Method PdfDocument.ConfigureFacturXGroundworkFile
- Method PdfDocument.ConfigurePdfAGroundwork
- Method PdfDocument.ConfigurePdfUaGroundwork
- Method PdfDocument.ConfigurePdfUaGroundwork
- Method PdfDocument.Container
- Method PdfDocument.Create
- Method PdfDocument.DefaultDrawingStyle
- Method PdfDocument.DefaultHeadingStyle
- Method PdfDocument.DefaultHorizontalRuleStyle
- Method PdfDocument.DefaultImageStyle
- Method PdfDocument.DefaultListStyle
- Method PdfDocument.DefaultPanelStyle
- Method PdfDocument.DefaultParagraphStyle
- Method PdfDocument.DefaultRowStyle
- Method PdfDocument.DefaultTableStyle
- Method PdfDocument.DefaultTableStyle
- Method PdfDocument.DefaultTextStyle
- Method PdfDocument.DefaultTextStyle
- Method PdfDocument.Deferred
- Method PdfDocument.Drawing
- Method PdfDocument.ElectronicInvoiceMetadata
- Method PdfDocument.ElectronicInvoiceMetadata
- Method PdfDocument.Ellipse
- Method PdfDocument.EmbedStandardFont
- Method PdfDocument.EmbedStandardFont
- Method PdfDocument.Encryption
- Method PdfDocument.Encryption
- Method PdfDocument.FileVersion
- Method PdfDocument.FlattenVisualAnnotations
- Method PdfDocument.Flow
- Method PdfDocument.Footer
- Method PdfDocument.FreeTextAnnotation
- Method PdfDocument.H1
- Method PdfDocument.H2
- Method PdfDocument.H3
- Method PdfDocument.Header
- Method PdfDocument.HighlightAnnotation
- Method PdfDocument.HR
- Method PdfDocument.Image
- Method PdfDocument.Image
- Method PdfDocument.Image
- Method PdfDocument.ImageWatermark
- Method PdfDocument.ImageWatermark
- Method PdfDocument.KeyValueTable
- Method PdfDocument.KeyValueTable
- Method PdfDocument.Landscape
- Method PdfDocument.Language
- Method PdfDocument.Layer
- Method PdfDocument.Line
- Method PdfDocument.Margin
- Method PdfDocument.Margin
- Method PdfDocument.Margin
- Method PdfDocument.Merge
- Method PdfDocument.Merge
- Method PdfDocument.MergeWith
- Method PdfDocument.MergeWith
- Method PdfDocument.MergeWith
- Method PdfDocument.MergeWith
- Method PdfDocument.MergeWith
- Method PdfDocument.Meta
- Method PdfDocument.MultiSelectChoiceField
- Method PdfDocument.Numbered
- Method PdfDocument.Open
- Method PdfDocument.Open
- Method PdfDocument.Open
- Method PdfDocument.OpenAction
- Method PdfDocument.OpenAsync
- Method PdfDocument.OpenAsync
- Method PdfDocument.Orientation
- Method PdfDocument.OutputIntent
- Method PdfDocument.OutputIntent
- Method PdfDocument.OutputIntent
- Method PdfDocument.OutputIntent
- Method PdfDocument.OutputIntent
- Method PdfDocument.Page
- Method PdfDocument.PageBorder
- Method PdfDocument.PageBorder
- Method PdfDocument.PageBreak
- Method PdfDocument.PageLabelRange
- Method PdfDocument.PageLabels
- Method PdfDocument.PageLabels
- Method PdfDocument.PageNumberStart
- Method PdfDocument.PageNumberStyle
- Method PdfDocument.Panel
- Method PdfDocument.PanelParagraph
- Method PdfDocument.Paragraph
- Method PdfDocument.Path
- Method PdfDocument.PdfAIdentification
- Method PdfDocument.PdfAIdentification
- Method PdfDocument.PdfUaIdentification
- Method PdfDocument.PdfUaIdentification
- Method PdfDocument.Polygon
- Method PdfDocument.Portrait
- Method PdfDocument.RadioButtonGroup
- Method PdfDocument.Rectangle
- Method PdfDocument.RegisterEmbeddedFontFallbacks
- Method PdfDocument.ReplaceMetadata
- Method PdfDocument.RichBullets
- Method PdfDocument.RichNumbered
- Method PdfDocument.RoundedRectangle
- Method PdfDocument.Row
- Method PdfDocument.Section
- Method PdfDocument.Section
- Method PdfDocument.Shape
- Method PdfDocument.Size
- Method PdfDocument.Size
- Method PdfDocument.Spacer
- Method PdfDocument.SrgbOutputIntent
- Method PdfDocument.SynchronizeMetadata
- Method PdfDocument.Table
- Method PdfDocument.Table
- Method PdfDocument.TableDeferred
- Method PdfDocument.TableDeferred
- Method PdfDocument.TableOfContents
- Method PdfDocument.TableWithLinks
- Method PdfDocument.TaggedPdfCatalogMarkers
- Method PdfDocument.TaggedStructure
- Method PdfDocument.TextAnnotation
- Method PdfDocument.TextField
- Method PdfDocument.TextHyphenation
- Method PdfDocument.TextHyphenationDictionary
- Method PdfDocument.TextLineBreaks
- Method PdfDocument.Theme
- Method PdfDocument.TryAppendMetadataRevision
- Method PdfDocument.TryApplyRedactions
- Method PdfDocument.TryFlattenVisualAnnotations
- Method PdfDocument.TryMergeWith
- Method PdfDocument.TryMergeWith
- Method PdfDocument.TryMergeWith
- Method PdfDocument.TryMergeWith
- Method PdfDocument.TryReplaceMetadata
- Method PdfDocument.TrySynchronizeMetadata
- Method PdfDocument.TryUpdateMetadata
- Method PdfDocument.UpdateMetadata
- Method PdfDocument.UseEmbeddedFontFallbacksFromSystem
- Method PdfDocument.UseFontFamily
- Method PdfDocument.UseFontFamily
- Method PdfDocument.UseFontFamily
- Method PdfDocument.UseTextFallbacks
- Method PdfDocument.UseTextShaping
- Method PdfDocument.ViewerPreferences
- Method PdfDocument.ViewerPreferences
- Method PdfDocument.Watermark
- Method PdfDocument.Watermark
- Method PdfDocumentConversionResult.RequireNoLoss
- Method PdfDocumentConversionResult.RequireValue
- Property PdfDocumentConversionResult.Value
- Method PdfDocumentForms.AppendRevision
- Method PdfDocumentForms.AppendRevision
- Method PdfDocumentForms.AppendRevision
- Method PdfDocumentForms.AppendRevision
- Method PdfDocumentForms.Fill
- Method PdfDocumentForms.Fill
- Method PdfDocumentForms.Fill
- Method PdfDocumentForms.Fill
- Method PdfDocumentForms.FillAndFlatten
- Method PdfDocumentForms.FillAndFlatten
- Method PdfDocumentForms.FillAndFlatten
- Method PdfDocumentForms.FillAndFlatten
- Method PdfDocumentForms.Flatten
- Method PdfDocumentForms.Flatten
- Method PdfDocumentForms.Flatten
- Method PdfDocumentForms.Flatten
- Method PdfDocumentForms.ImportData
- Method PdfDocumentForms.ImportXfdf
- Method PdfDocumentForms.TryAppendRevision
- Method PdfDocumentForms.TryAppendRevision
- Method PdfDocumentForms.TryAppendRevision
- Method PdfDocumentForms.TryAppendRevision
- Method PdfDocumentForms.TryFill
- Method PdfDocumentForms.TryFill
- Method PdfDocumentForms.TryFill
- Method PdfDocumentForms.TryFill
- Method PdfDocumentForms.TryFillAndFlatten
- Method PdfDocumentForms.TryFillAndFlatten
- Method PdfDocumentForms.TryFillAndFlatten
- Method PdfDocumentForms.TryFillAndFlatten
- Method PdfDocumentForms.TryFlatten
- Method PdfDocumentForms.TryFlatten
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.CropAndTranslate
- Method PdfDocumentPages.Delete
- Method PdfDocumentPages.Delete
- Method PdfDocumentPages.Delete
- Method PdfDocumentPages.Delete
- Method PdfDocumentPages.Delete
- Method PdfDocumentPages.Duplicate
- Method PdfDocumentPages.Duplicate
- Method PdfDocumentPages.Duplicate
- Method PdfDocumentPages.Duplicate
- Method PdfDocumentPages.Duplicate
- Method PdfDocumentPages.Extract
- Method PdfDocumentPages.Extract
- Method PdfDocumentPages.Extract
- Method PdfDocumentPages.Extract
- Method PdfDocumentPages.Extract
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Move
- Method PdfDocumentPages.Move
- Method PdfDocumentPages.Move
- Method PdfDocumentPages.Move
- Method PdfDocumentPages.Move
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Reorder
- Method PdfDocumentPages.Reorder
- Method PdfDocumentPages.Reorder
- Method PdfDocumentPages.Reorder
- Method PdfDocumentPages.Resize
- Method PdfDocumentPages.Resize
- Method PdfDocumentPages.Rotate
- Method PdfDocumentPages.Rotate
- Method PdfDocumentPages.Rotate
- Method PdfDocumentPages.Rotate
- Method PdfDocumentPages.Rotate
- Method PdfDocumentPages.SetArtBox
- Method PdfDocumentPages.SetBleedBox
- Method PdfDocumentPages.SetCropBox
- Method PdfDocumentPages.SetMediaBox
- Method PdfDocumentPages.SetPageBox
- Method PdfDocumentPages.SetTrimBox
- Method PdfDocumentPages.Split
- Method PdfDocumentPages.Split
- Method PdfDocumentPages.Split
- Method PdfDocumentPages.Split
- Method PdfDocumentPages.Split
- Method PdfDocumentPages.SplitByBookmarks
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryDelete
- Method PdfDocumentPages.TryDelete
- Method PdfDocumentPages.TryDelete
- Method PdfDocumentPages.TryDuplicate
- Method PdfDocumentPages.TryDuplicate
- Method PdfDocumentPages.TryDuplicate
- Method PdfDocumentPages.TryExtract
- Method PdfDocumentPages.TryExtract
- Method PdfDocumentPages.TryExtract
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryMove
- Method PdfDocumentPages.TryMove
- Method PdfDocumentPages.TryMove
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryReorder
- Method PdfDocumentPages.TryReorder
- Method PdfDocumentPages.TryReorder
- Method PdfDocumentPages.TryRotate
- Method PdfDocumentPages.TryRotate
- Method PdfDocumentPages.TryRotate
- Method PdfDocumentPages.TrySplit
- Method PdfDocumentPages.TrySplit
- Method PdfDocumentPages.TrySplit
- Method PdfDocumentPages.TrySplit
- Method PdfDocumentPages.TrySplit
- Method PdfDocumentPages.TrySplitByBookmarks
- Method PdfDocumentStamper.Content
- Method PdfDocumentStamper.Content
- Method PdfDocumentStamper.Image
- Method PdfDocumentStamper.Image
- Method PdfDocumentStamper.Image
- Method PdfDocumentStamper.Image
- Method PdfDocumentStamper.ImageWatermark
- Method PdfDocumentStamper.ImageWatermark
- Method PdfDocumentStamper.ImageWatermark
- Method PdfDocumentStamper.ImageWatermark
- Method PdfDocumentStamper.OverlayPage
- Method PdfDocumentStamper.OverlayPage
- Method PdfDocumentStamper.OverlayPage
- Method PdfDocumentStamper.OverlayPage
- Method PdfDocumentStamper.OverlayPage
- Method PdfDocumentStamper.OverlayPage
- Method PdfDocumentStamper.Text
- Method PdfDocumentStamper.Text
- Method PdfDocumentStamper.TextWatermark
- Method PdfDocumentStamper.TextWatermark
- Method PdfDocumentStamper.TryContent
- Method PdfDocumentStamper.TryImage
- Method PdfDocumentStamper.TryImage
- Method PdfDocumentStamper.TryImageWatermark
- Method PdfDocumentStamper.TryImageWatermark
- Method PdfDocumentStamper.TryOverlayPage
- Method PdfDocumentStamper.TryOverlayPage
- Method PdfDocumentStamper.TryOverlayPage
- Method PdfDocumentStamper.TryText
- Method PdfDocumentStamper.TryTextWatermark
- Method PdfDocumentStamper.TryUnderlayPage
- Method PdfDocumentStamper.TryUnderlayPage
- Method PdfDocumentStamper.TryUnderlayPage
- Method PdfDocumentStamper.UnderlayPage
- Method PdfDocumentStamper.UnderlayPage
- Method PdfDocumentStamper.UnderlayPage
- Method PdfDocumentStamper.UnderlayPage
- Method PdfDocumentStamper.UnderlayPage
- Method PdfDocumentStamper.UnderlayPage
- Method PdfExternalSignatureCompletion.ToDocument
- Method PdfExternalSignaturePreparation.Complete
- Method PdfMergeResult.ToDocument
- Method PdfOptimizationActionResult.ToDocument
- Method PdfSanitizationResult.ToDocument
- Method PdfSecurityMutationResult.ToDocument
Accepted by parameters
- Extension method PdfDocument.ExportImages
- Extension method PdfDocument.ToImages
- Extension method PdfDocument.ToImages
- Method PdfDocument.AssertRewritePreservationMatrix
- Method PdfDocument.AssertRewritePreservationMatrix
- Method PdfDocument.AssertRewritePreservationMatrix
- Method PdfDocument.AssertRewritePreserved
- Method PdfDocument.AssessRewritePreservation
- Method PdfDocument.AssessRewritePreservationMatrix
- Method PdfDocument.AssessRewritePreservationMatrix
- Method PdfDocument.AssessRewritePreservationMatrix
- Method PdfDocument.CompareVisual
- Method PdfDocument.Merge
- Method PdfDocument.Merge
- Method PdfDocument.MergeWith
- Method PdfDocument.MergeWith
- Method PdfDocument.MergeWithReport
- Method PdfDocument.MergeWithReport
- Method PdfDocument.TryMergeWith
- Constructor PdfDocumentConversionResult.PdfDocumentConversionResult
- Method PdfDocumentConversionResult.Process
- Method PdfDocumentConversionResult.WithValue
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Append
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Insert
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.Prepend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryAppend
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryInsert
- Method PdfDocumentPages.TryPrepend
- Method PdfDocumentPages.TryPrepend
- Method PdfImageExportExtensions.ExportImages
- Method PdfImageExportExtensions.ToImages
- Method PdfImageExportExtensions.ToImages
Methods
public PdfDocument AcroFormDefaultTextAlignment(Nullable<PdfFormFieldTextAlignment> alignment) #Returns:
PdfDocumentSets or clears the generated AcroForm default text alignment emitted through /Q.
Parameters
- alignment System.Nullable{OfficeIMO.Pdf.PdfFormFieldTextAlignment}
public PdfAnalysisReport Analyze(PdfComplianceProfile complianceProfile = None) #Returns:
PdfAnalysisReportProduces one consolidated health and capability report. Supply a compliance profile to include artifact readback readiness.
Parameters
- complianceProfile OfficeIMO.Pdf.PdfComplianceProfile = None
public PdfAppendOnlyMutationReport AnalyzeAppendOnlyMutation(PdfReadOptions options = null) #Returns:
PdfAppendOnlyMutationReportAnalyzes which append-only mutation actions OfficeIMO.Pdf can safely attempt for this PDF.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOptimizationReport AnalyzeOptimization(PdfReadOptions options = null) #Returns:
PdfOptimizationReportBuilds an optimization opportunity report for this document without modifying it.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
public IReadOnlyList<PdfTextEncodingDiagnostic> AnalyzeTextEncoding() #Returns:
IReadOnlyList<PdfTextEncodingDiagnostic>Analyzes generated document text against the configured PDF text encoding before rendering.
public PdfDocument AppendMetadataRevision(String title = null, String author = null, String subject = null, String keywords = null, Boolean createXmpMetadata = false) #Returns:
PdfDocumentAppends a metadata-only incremental revision without rewriting the existing PDF bytes.
Parameters
- title System.String = null
- author System.String = null
- subject System.String = null
- keywords System.String = null
- createXmpMetadata System.Boolean = false
ApplyRedactions 2 overloads
public PdfDocument ApplyRedactions(IEnumerable<PdfRedactionArea> areas, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfDocumentCreates a new PDF with matching text objects and annotations removed from the supplied redaction areas.
Parameters
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument ApplyRedactions(PdfRedactionPlan plan, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfDocumentApplies a reviewed redaction plan, including exact field removal for field-derived areas.
Parameters
- plan OfficeIMO.Pdf.PdfRedactionPlan
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfRedactionVerificationReport AssertRedactionsVerified(PdfRedactionVerificationOptions options) #Returns:
PdfRedactionVerificationReportVerifies configured redaction markers and throws when removed content remains or retained content disappeared.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
AssertRewritePreservationMatrix 3 overloads
public PdfRewritePreservationMatrixReport AssertRewritePreservationMatrix(String id, String operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationMatrixReportRuns a one-row rewrite-preservation matrix scenario and throws when the observed outcome differs from the expected outcome.
Parameters
- id System.String
- operation System.String
- rewrite System.Func{OfficeIMO.Pdf.PdfDocument,OfficeIMO.Pdf.PdfDocument}
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationMatrixReport AssertRewritePreservationMatrix(String id, String operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions options, IEnumerable<String> sourceFeatures) #Returns:
PdfRewritePreservationMatrixReportRuns a one-row rewrite-preservation matrix scenario with source feature labels and throws when preservation failed.
Parameters
- id System.String
- operation System.String
- rewrite System.Func{OfficeIMO.Pdf.PdfDocument,OfficeIMO.Pdf.PdfDocument}
- options OfficeIMO.Pdf.PdfRewritePreservationOptions
- sourceFeatures System.Collections.Generic.IEnumerable{System.String}
public PdfRewritePreservationMatrixReport AssertRewritePreservationMatrix(String id, String operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationMatrixClassification expectedClassification, PdfRewritePreservationOptions options = null, IEnumerable<String> sourceFeatures = null) #Returns:
PdfRewritePreservationMatrixReportRuns a one-row rewrite-preservation matrix scenario and throws when the observed outcome differs from the expected outcome.
Parameters
- id System.String
- operation System.String
- rewrite System.Func{OfficeIMO.Pdf.PdfDocument,OfficeIMO.Pdf.PdfDocument}
- expectedClassification OfficeIMO.Pdf.PdfRewritePreservationMatrixClassification
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
- sourceFeatures System.Collections.Generic.IEnumerable{System.String} = null
AssertRewritePreserved 4 overloads
public PdfRewritePreservationReport AssertRewritePreserved(PdfDocument rewrittenDocument, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with a rewritten PDF and throws when important document signals were not preserved.
Parameters
- rewrittenDocument OfficeIMO.Pdf.PdfDocument
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationReport AssertRewritePreserved(Byte[] rewrittenPdf, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with rewritten PDF bytes and throws when important document signals were not preserved.
Parameters
- rewrittenPdf System.Byte[]
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationReport AssertRewritePreserved(Stream rewrittenStream, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with a rewritten PDF stream and throws when important document signals were not preserved.
Parameters
- rewrittenStream System.IO.Stream
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationReport AssertRewritePreserved(String rewrittenPath, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with a rewritten PDF file and throws when important document signals were not preserved.
Parameters
- rewrittenPath System.String
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
AssessCompliance 2 overloads
public PdfComplianceReadinessReport AssessCompliance() #Returns:
PdfComplianceReadinessReportAnalyzes this generated document against its configured compliance profile using the same layout path as PDF output.
public PdfComplianceReadinessReport AssessCompliance(PdfComplianceProfile profile) #Returns:
PdfComplianceReadinessReportAnalyzes this document against a formal compliance profile. Generated documents use layout evidence; opened documents use artifact readback evidence.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
- Compliance profile to assess without enabling formal profile generation.
AssessComplianceProof 2 overloads
public PdfComplianceProofReport AssessComplianceProof(IEnumerable<PdfExternalValidationResult> externalValidations = null) #Returns:
PdfComplianceProofReportCombines generated-document compliance readiness for the configured profile with external validator evidence.
Parameters
- externalValidations System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfExternalValidationResult} = null
public PdfComplianceProofReport AssessComplianceProof(PdfComplianceProfile profile, IEnumerable<PdfExternalValidationResult> externalValidations = null) #Returns:
PdfComplianceProofReportCombines generated-document compliance readiness for a formal profile with external validator evidence.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
- Compliance profile to assess without enabling formal profile generation.
- externalValidations System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfExternalValidationResult} = null
- Optional external validator results to combine with OfficeIMO.Pdf readiness evidence.
public PdfMutationPortfolioReport AssessMutations(IEnumerable<PdfMutationOperation> operations = null, IEnumerable<String> fieldNames = null, PdfReadOptions options = null, PdfMutationExecutionPreference executionPreference = Automatic) #Returns:
PdfMutationPortfolioReportAssesses several mutation families against one shared preflight snapshot.
Parameters
- operations System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfMutationOperation} = null
- fieldNames System.Collections.Generic.IEnumerable{System.String} = null
- options OfficeIMO.Pdf.PdfReadOptions = null
- executionPreference OfficeIMO.Pdf.PdfMutationExecutionPreference = Automatic
public PdfRenderCompatibilityReport AssessRenderCompatibility(PdfReadOptions options = null) #Returns:
PdfRenderCompatibilityReportAssesses managed page-render fidelity without rasterizing or writing image artifacts.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
AssessRewritePreservation 4 overloads
public PdfRewritePreservationReport AssessRewritePreservation(PdfDocument rewrittenDocument, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with a rewritten PDF and reports whether important document signals were preserved.
Parameters
- rewrittenDocument OfficeIMO.Pdf.PdfDocument
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationReport AssessRewritePreservation(Byte[] rewrittenPdf, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with rewritten PDF bytes and reports whether important document signals were preserved.
Parameters
- rewrittenPdf System.Byte[]
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationReport AssessRewritePreservation(Stream rewrittenStream, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with a rewritten PDF stream and reports whether important document signals were preserved.
Parameters
- rewrittenStream System.IO.Stream
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationReport AssessRewritePreservation(String rewrittenPath, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationReportCompares this PDF with a rewritten PDF file and reports whether important document signals were preserved.
Parameters
- rewrittenPath System.String
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
AssessRewritePreservationMatrix 3 overloads
public PdfRewritePreservationMatrixReport AssessRewritePreservationMatrix(String id, String operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions options = null) #Returns:
PdfRewritePreservationMatrixReportRuns a one-row rewrite-preservation matrix scenario from this PDF using a normal PdfDocument rewrite operation.
Parameters
- id System.String
- operation System.String
- rewrite System.Func{OfficeIMO.Pdf.PdfDocument,OfficeIMO.Pdf.PdfDocument}
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
public PdfRewritePreservationMatrixReport AssessRewritePreservationMatrix(String id, String operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationOptions options, IEnumerable<String> sourceFeatures) #Returns:
PdfRewritePreservationMatrixReportRuns a one-row rewrite-preservation matrix scenario from this PDF with source feature labels.
Parameters
- id System.String
- operation System.String
- rewrite System.Func{OfficeIMO.Pdf.PdfDocument,OfficeIMO.Pdf.PdfDocument}
- options OfficeIMO.Pdf.PdfRewritePreservationOptions
- sourceFeatures System.Collections.Generic.IEnumerable{System.String}
public PdfRewritePreservationMatrixReport AssessRewritePreservationMatrix(String id, String operation, Func<PdfDocument, PdfDocument> rewrite, PdfRewritePreservationMatrixClassification expectedClassification, PdfRewritePreservationOptions options = null, IEnumerable<String> sourceFeatures = null) #Returns:
PdfRewritePreservationMatrixReportRuns a one-row rewrite-preservation matrix scenario from this PDF using a normal PdfDocument rewrite operation and expected outcome.
Parameters
- id System.String
- operation System.String
- rewrite System.Func{OfficeIMO.Pdf.PdfDocument,OfficeIMO.Pdf.PdfDocument}
- expectedClassification OfficeIMO.Pdf.PdfRewritePreservationMatrixClassification
- options OfficeIMO.Pdf.PdfRewritePreservationOptions = null
- sourceFeatures System.Collections.Generic.IEnumerable{System.String} = null
public PdfDocument AttachFacturXInvoiceXml(Byte[] ciiXml, String conformanceLevel = "EN 16931", String version = "1.0", PdfAssociatedFileRelationship relationship = Data, String description = "Factur-X/ZUGFeRD invoice XML") #Returns:
PdfDocumentAdds the canonical Factur-X/ZUGFeRD CrossIndustryInvoice XML payload and matching XMP extension metadata.
Parameters
- ciiXml System.Byte[]
- conformanceLevel System.String = "EN 16931"
- version System.String = "1.0"
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data
- description System.String = "Factur-X/ZUGFeRD invoice XML"
public PdfDocument AttachFacturXInvoiceXmlFile(String ciiXmlPath, String conformanceLevel = "EN 16931", String version = "1.0", PdfAssociatedFileRelationship relationship = Data, String description = "Factur-X/ZUGFeRD invoice XML") #Returns:
PdfDocumentAdds the canonical Factur-X/ZUGFeRD CrossIndustryInvoice XML file and matching XMP extension metadata.
Parameters
- ciiXmlPath System.String
- conformanceLevel System.String = "EN 16931"
- version System.String = "1.0"
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data
- description System.String = "Factur-X/ZUGFeRD invoice XML"
AttachFile 2 overloads
public PdfDocument AttachFile(PdfEmbeddedFile file) #Returns:
PdfDocumentAdds an embedded file associated with the generated PDF catalog.
Parameters
- file OfficeIMO.Pdf.PdfEmbeddedFile
public PdfDocument AttachFile(String fileName, Byte[] data, String mimeType = null, PdfAssociatedFileRelationship relationship = Unspecified, String description = null) #Returns:
PdfDocumentAdds an embedded file associated with the generated PDF catalog.
Parameters
- fileName System.String
- data System.Byte[]
- mimeType System.String = null
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Unspecified
- description System.String = null
public PdfDocument Background(Nullable<PdfColor> color) #Returns:
PdfDocumentSets or clears the document-wide default page background color.
Parameters
- color System.Nullable{OfficeIMO.Pdf.PdfColor}
public PdfDocument BackgroundBottomBand(Double height, Nullable<PdfColor> fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #Returns:
PdfDocumentAdds a document-wide default bottom page background band using the current page size.
Parameters
- height System.Double
- fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- insetX System.Double = 0
- offsetY System.Double = 0
- cornerRadius System.Double = 0
- stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 0
- fillOpacity System.Nullable{System.Double} = null
- strokeOpacity System.Nullable{System.Double} = null
- fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null
public PdfDocument BackgroundEllipse(Double x, Double y, Double width, Double height, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #Returns:
PdfDocumentAdds a document-wide default ellipse page background shape.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 0
- fillOpacity System.Nullable{System.Double} = null
- strokeOpacity System.Nullable{System.Double} = null
- fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null
BackgroundImage 2 overloads
public PdfDocument BackgroundImage(PdfPageBackgroundImage image) #Returns:
PdfDocumentSets or clears the document-wide default page background image.
Parameters
- image OfficeIMO.Pdf.PdfPageBackgroundImage
public PdfDocument BackgroundImage(Byte[] imageBytes, OfficeImageFit fit = Cover, Nullable<Double> opacity = null) #Returns:
PdfDocumentSets a document-wide default page background image.
Parameters
- imageBytes System.Byte[]
- fit OfficeIMO.Drawing.OfficeImageFit = Cover
- opacity System.Nullable{System.Double} = null
public PdfDocument BackgroundLeftBand(Double width, Nullable<PdfColor> fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #Returns:
PdfDocumentAdds a document-wide default left page background band using the current page size.
Parameters
- width System.Double
- fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- insetY System.Double = 0
- offsetX System.Double = 0
- cornerRadius System.Double = 0
- stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 0
- fillOpacity System.Nullable{System.Double} = null
- strokeOpacity System.Nullable{System.Double} = null
- fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null
public PdfDocument BackgroundRectangle(Double x, Double y, Double width, Double height, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #Returns:
PdfDocumentAdds a document-wide default rectangle page background shape.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 0
- fillOpacity System.Nullable{System.Double} = null
- strokeOpacity System.Nullable{System.Double} = null
- fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null
public PdfDocument BackgroundRightBand(Double width, Nullable<PdfColor> fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #Returns:
PdfDocumentAdds a document-wide default right page background band using the current page size.
Parameters
- width System.Double
- fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- insetY System.Double = 0
- offsetX System.Double = 0
- cornerRadius System.Double = 0
- stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 0
- fillOpacity System.Nullable{System.Double} = null
- strokeOpacity System.Nullable{System.Double} = null
- fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null
public PdfDocument BackgroundRoundedRectangle(Double x, Double y, Double width, Double height, Double cornerRadius, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #Returns:
PdfDocumentAdds a document-wide default rounded rectangle page background shape.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- cornerRadius System.Double
- fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 0
- fillOpacity System.Nullable{System.Double} = null
- strokeOpacity System.Nullable{System.Double} = null
- fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null
public PdfDocument BackgroundShape(PdfPageBackgroundShape shape) #Returns:
PdfDocumentAdds a document-wide default page background shape rendered behind page content.
Parameters
- shape OfficeIMO.Pdf.PdfPageBackgroundShape
public PdfDocument BackgroundShapes(IEnumerable<PdfPageBackgroundShape> shapes) #Returns:
PdfDocumentReplaces or clears document-wide default page background shapes.
Parameters
- shapes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfPageBackgroundShape}
public PdfDocument BackgroundTopBand(Double height, Nullable<PdfColor> fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #Returns:
PdfDocumentAdds a document-wide default top page background band using the current page size.
Parameters
- height System.Double
- fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- insetX System.Double = 0
- offsetY System.Double = 0
- cornerRadius System.Double = 0
- stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 0
- fillOpacity System.Nullable{System.Double} = null
- strokeOpacity System.Nullable{System.Double} = null
- fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null
public PdfDocument Bookmark(String name) #Returns:
PdfDocumentAdds a named bookmark at the current flow position.
Parameters
- name System.String
public PdfDocument Bullets(IEnumerable<String> items, PdfAlign align = Left, Nullable<PdfColor> color = null, PdfListStyle style = null) #Returns:
PdfDocumentAdds a simple bullet list.
Parameters
- items System.Collections.Generic.IEnumerable{System.String}
- align OfficeIMO.Pdf.PdfAlign = Left
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- style OfficeIMO.Pdf.PdfListStyle = null
public PdfDocument Canvas(Action<PdfPageCanvas> build) #Returns:
PdfDocumentAdds foreground page content at absolute top-left page coordinates.
Parameters
- build System.Action{OfficeIMO.Pdf.PdfPageCanvas}
public PdfDocument CatalogPageLayout(Nullable<PdfCatalogPageLayout> pageLayout) #Returns:
PdfDocumentSets or clears the generated catalog page layout.
Parameters
- pageLayout System.Nullable{OfficeIMO.Pdf.PdfCatalogPageLayout}
public PdfDocument CatalogPageMode(Nullable<PdfCatalogPageMode> pageMode) #Returns:
PdfDocumentSets or clears the generated catalog page mode.
Parameters
- pageMode System.Nullable{OfficeIMO.Pdf.PdfCatalogPageMode}
public PdfDocument CatalogUriBase(String uriBase) #Returns:
PdfDocumentSets or clears the generated catalog URI base used by viewers to resolve relative URI actions.
Parameters
- uriBase System.String
public PdfDocument CatalogView(Nullable<PdfCatalogPageMode> pageMode = null, Nullable<PdfCatalogPageLayout> pageLayout = null) #Returns:
PdfDocumentSets generated catalog page mode and page layout viewer hints.
Parameters
- pageMode System.Nullable{OfficeIMO.Pdf.PdfCatalogPageMode} = null
- pageLayout System.Nullable{OfficeIMO.Pdf.PdfCatalogPageLayout} = null
public PdfDocument CheckBox(String name, Boolean isChecked = false, Double size = 14, PdfAlign align = Left, Double spacingBefore = 0, Double spacingAfter = 6, String checkedValueName = "Yes", PdfFormFieldStyle style = null) #Returns:
PdfDocumentAdds a simple AcroForm check box at the current flow position.
Parameters
- name System.String
- isChecked System.Boolean = false
- size System.Double = 14
- align OfficeIMO.Pdf.PdfAlign = Left
- spacingBefore System.Double = 0
- spacingAfter System.Double = 6
- checkedValueName System.String = "Yes"
- style OfficeIMO.Pdf.PdfFormFieldStyle = null
public PdfDocument ChoiceField(String name, IEnumerable<String> options, String value = null, Double width = 180, Double height = 22, PdfAlign align = Left, Double fontSize = 10, Double spacingBefore = 0, Double spacingAfter = 6, Boolean isComboBox = true, PdfFormFieldStyle style = null) #Returns:
PdfDocumentAdds a simple AcroForm choice field at the current flow position.
Parameters
- name System.String
- options System.Collections.Generic.IEnumerable{System.String}
- value System.String = null
- width System.Double = 180
- height System.Double = 22
- align OfficeIMO.Pdf.PdfAlign = Left
- fontSize System.Double = 10
- spacingBefore System.Double = 0
- spacingAfter System.Double = 6
- isComboBox System.Boolean = true
- style OfficeIMO.Pdf.PdfFormFieldStyle = null
public PdfDocument ClearBackgroundShapes() #Returns:
PdfDocumentClears document-wide default page background shapes.
public PdfDocument Columns(Action<PdfItemCompose> compose, PdfMultiColumnOptions options = null) #Returns:
PdfDocumentFlows common block content across equal-width columns in reading order.
Parameters
- compose System.Action{OfficeIMO.Pdf.PdfItemCompose}
- options OfficeIMO.Pdf.PdfMultiColumnOptions = null
CompareVisual 2 overloads
public PdfVisualComparisonReport CompareVisual(Byte[] actualPdf, PdfPageSelection selection = null, PdfVisualComparisonOptions options = null, PdfReadOptions actualReadOptions = null) #Returns:
PdfVisualComparisonReportCompares this document with another PDF through the managed renderer and returns review artifacts.
Parameters
- actualPdf System.Byte[]
- selection OfficeIMO.Pdf.PdfPageSelection = null
- options OfficeIMO.Pdf.PdfVisualComparisonOptions = null
- actualReadOptions OfficeIMO.Pdf.PdfReadOptions = null
public PdfVisualComparisonReport CompareVisual(PdfDocument actualDocument, PdfPageSelection selection = null, PdfVisualComparisonOptions options = null) #Returns:
PdfVisualComparisonReportCompares this document with another fluent PDF through the managed renderer.
Parameters
- actualDocument OfficeIMO.Pdf.PdfDocument
- selection OfficeIMO.Pdf.PdfPageSelection = null
- options OfficeIMO.Pdf.PdfVisualComparisonOptions = null
public PdfDocument CompleteExternalSignature(Byte[] signatureContents) #Returns:
PdfDocumentCompletes a persisted external-signature placeholder with detached CMS or timestamp bytes.
Parameters
- signatureContents System.Byte[]
public PdfDocument Compliance(PdfComplianceProfile profile) #Returns:
PdfDocumentRequests a generated-PDF compliance profile for this document.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
Component 2 overloads
public PdfDocument Component(IPdfComponent component, PdfFlowOptions options = null, PdfLayoutPositionCapture capture = null) #Returns:
PdfDocumentAdds a reusable typed component through the canonical flow engine, with optional layout constraints and position capture.
Parameters
- component OfficeIMO.Pdf.IPdfComponent
- options OfficeIMO.Pdf.PdfFlowOptions = null
- capture OfficeIMO.Pdf.PdfLayoutPositionCapture = null
public PdfDocument Component(IPdfContextComponent component, PdfFlowOptions options = null, PdfLayoutPositionCapture capture = null) #Returns:
PdfDocumentAdds a reusable page-aware component through the existing deferred-flow replay path.
Parameters
- component OfficeIMO.Pdf.IPdfContextComponent
- options OfficeIMO.Pdf.PdfFlowOptions = null
- capture OfficeIMO.Pdf.PdfLayoutPositionCapture = null
public PdfDocument Compose(Action<PdfCompose> compose) #Returns:
PdfDocumentHigher-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.PdfCompose}
public PdfDocument ConfigureElectronicInvoiceGroundwork(PdfComplianceProfile profile, Byte[] ciiXml, String conformanceLevel = "EN 16931", String version = "1.0", PdfAssociatedFileRelationship relationship = Data, String description = "Factur-X/ZUGFeRD invoice XML") #Returns:
PdfDocumentConfigures common PDF/A-3 e-invoice groundwork for Factur-X or ZUGFeRD without enabling formal compliance profile generation.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
- ciiXml System.Byte[]
- conformanceLevel System.String = "EN 16931"
- version System.String = "1.0"
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data
- description System.String = "Factur-X/ZUGFeRD invoice XML"
public PdfDocument ConfigureElectronicInvoiceGroundworkFile(PdfComplianceProfile profile, String ciiXmlPath, String conformanceLevel = "EN 16931", String version = "1.0", PdfAssociatedFileRelationship relationship = Data, String description = "Factur-X/ZUGFeRD invoice XML") #Returns:
PdfDocumentConfigures common PDF/A-3 e-invoice groundwork for Factur-X or ZUGFeRD from a CrossIndustryInvoice XML file.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
- ciiXmlPath System.String
- conformanceLevel System.String = "EN 16931"
- version System.String = "1.0"
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data
- description System.String = "Factur-X/ZUGFeRD invoice XML"
public PdfDocument ConfigureFacturXGroundwork(Byte[] ciiXml, String conformanceLevel = "EN 16931", String version = "1.0", PdfAssociatedFileRelationship relationship = Data, String description = "Factur-X/ZUGFeRD invoice XML") #Returns:
PdfDocumentConfigures common PDF/A-3 Factur-X/ZUGFeRD groundwork without enabling formal compliance profile generation.
Parameters
- ciiXml System.Byte[]
- conformanceLevel System.String = "EN 16931"
- version System.String = "1.0"
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data
- description System.String = "Factur-X/ZUGFeRD invoice XML"
public PdfDocument ConfigureFacturXGroundworkFile(String ciiXmlPath, String conformanceLevel = "EN 16931", String version = "1.0", PdfAssociatedFileRelationship relationship = Data, String description = "Factur-X/ZUGFeRD invoice XML") #Returns:
PdfDocumentConfigures common PDF/A-3 Factur-X/ZUGFeRD groundwork from a CrossIndustryInvoice XML file.
Parameters
- ciiXmlPath System.String
- conformanceLevel System.String = "EN 16931"
- version System.String = "1.0"
- relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data
- description System.String = "Factur-X/ZUGFeRD invoice XML"
public PdfDocument ConfigurePdfAGroundwork(PdfComplianceProfile profile, String language = "en-US") #Returns:
PdfDocumentConfigures common PDF/A-2, PDF/A-3, or PDF/A-4 groundwork without enabling formal compliance profile generation.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
- language System.String = "en-US"
ConfigurePdfUaGroundwork 2 overloads
public PdfDocument ConfigurePdfUaGroundwork(String language = "en-US") #Returns:
PdfDocumentConfigures common PDF/UA-1 groundwork without enabling formal compliance profile generation.
Parameters
- language System.String = "en-US"
public PdfDocument ConfigurePdfUaGroundwork(PdfComplianceProfile profile, String language = "en-US") #Returns:
PdfDocumentConfigures common PDF/UA-1 or PDF/UA-2 groundwork without enabling formal compliance profile generation.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
- language System.String = "en-US"
public PdfDocument Container(Action<PdfItemCompose> compose, PanelStyle style = null) #Returns:
PdfDocumentGroups common flow blocks inside a padded, styled, one-page container.
Parameters
- compose System.Action{OfficeIMO.Pdf.PdfItemCompose}
- style OfficeIMO.Pdf.PanelStyle = null
public static PdfDocument Create(PdfOptions options = null) #Returns:
PdfDocumentCreates a new, empty PDF document with optional options.
Parameters
- options OfficeIMO.Pdf.PdfOptions = null
- Page size, margins and default font options. When null, sensible defaults are used.
Returns
New PdfDocument instance.
CreateComplianceArtifact 2 overloads
public PdfComplianceArtifact CreateComplianceArtifact() #Returns:
PdfComplianceArtifactAtomically renders or snapshots this document with readiness evidence for its configured compliance profile.
public PdfComplianceArtifact CreateComplianceArtifact(PdfComplianceProfile profile) #Returns:
PdfComplianceArtifactAtomically renders or snapshots this document with readiness evidence for profile. Use the returned artifact's bytes for external validation, then call its PdfExternalValidationResult>) method with those validator results.
Parameters
- profile OfficeIMO.Pdf.PdfComplianceProfile
public PdfDebuggerReport Debug(PdfDebuggerOptions options = null, PdfReadOptions readOptions = null) #Returns:
PdfDebuggerReportCreates a bounded debugger projection of objects, revisions, pages, resources, and content operators.
Parameters
- options OfficeIMO.Pdf.PdfDebuggerOptions = null
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
public PdfSecurityMutationResult Decrypt(String ownerPassword) #Returns:
PdfSecurityMutationResultRemoves Standard password security using the current owner password and returns preservation proof.
Parameters
- ownerPassword System.String
public PdfDocument DefaultDrawingStyle(PdfDrawingStyle style) #Returns:
PdfDocumentSets the document-wide default placement style for OfficeIMO.Drawing-backed flow objects.
Parameters
- style OfficeIMO.Pdf.PdfDrawingStyle
public PdfDocument DefaultHeadingStyle(Int32 level, PdfHeadingStyle style) #Returns:
PdfDocumentSets the document-wide default style for a built-in heading level.
Parameters
- level System.Int32
- style OfficeIMO.Pdf.PdfHeadingStyle
public PdfDocument DefaultHorizontalRuleStyle(PdfHorizontalRuleStyle style) #Returns:
PdfDocumentSets the document-wide default style for horizontal rules.
Parameters
- style OfficeIMO.Pdf.PdfHorizontalRuleStyle
public PdfDocument DefaultImageStyle(PdfImageStyle style) #Returns:
PdfDocumentSets the document-wide default image placement style.
Parameters
- style OfficeIMO.Pdf.PdfImageStyle
public PdfDocument DefaultListStyle(PdfListStyle style) #Returns:
PdfDocumentSets the document-wide default style for bullet and numbered lists.
Parameters
- style OfficeIMO.Pdf.PdfListStyle
public PdfDocument DefaultPanelStyle(PanelStyle style) #Returns:
PdfDocumentSets the document-wide default style for panel paragraphs.
Parameters
- style OfficeIMO.Pdf.PanelStyle
public PdfDocument DefaultParagraphStyle(PdfParagraphStyle style) #Returns:
PdfDocumentSets the document-wide default paragraph style used by paragraphs that do not provide an explicit style.
Parameters
- style OfficeIMO.Pdf.PdfParagraphStyle
public PdfDocument DefaultRowStyle(PdfRowStyle style) #Returns:
PdfDocumentSets the document-wide default row/column layout style.
Parameters
- style OfficeIMO.Pdf.PdfRowStyle
DefaultTableStyle 2 overloads
public PdfDocument DefaultTableStyle(PdfTableStyle style) #Returns:
PdfDocumentSets the document-wide default table style used by tables that do not provide an explicit style.
Parameters
- style OfficeIMO.Pdf.PdfTableStyle
public PdfDocument DefaultTableStyle(String wordTableStyleName) #Returns:
PdfDocumentSets the document-wide default table style from a supported Word table style name.
Parameters
- wordTableStyleName System.String
DefaultTextStyle 2 overloads
public PdfDocument DefaultTextStyle(Action<PdfTextStyleCompose> style) #Returns:
PdfDocumentSets document-wide default text styling used by following page-flow content.
Parameters
- style System.Action{OfficeIMO.Pdf.PdfTextStyleCompose}
public PdfDocument DefaultTextStyle(PdfTextStyle style) #Returns:
PdfDocumentSets document-wide default text styling from a reusable text style object.
Parameters
- style OfficeIMO.Pdf.PdfTextStyle
public PdfDocument Deferred(Func<PdfFlowContext, Action<PdfItemCompose>> composeFactory, PdfFlowOptions options = null, PdfLayoutPositionCapture capture = null) #Returns:
PdfDocumentAdds replayable content materialized from the live page context. Identical contexts are reused across layout stabilization passes.
Parameters
- composeFactory System.Func{OfficeIMO.Pdf.PdfFlowContext,System.Action{OfficeIMO.Pdf.PdfItemCompose}}
- options OfficeIMO.Pdf.PdfFlowOptions = null
- capture OfficeIMO.Pdf.PdfLayoutPositionCapture = null
public PdfDiagnosticReport Diagnostics(PdfReadOptions options = null) #Returns:
PdfDiagnosticReportBuilds a combined PDF diagnostic report for this document.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument Drawing(OfficeDrawing drawing, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a shared OfficeIMO.Drawing scene at the current flow position.
Parameters
- drawing OfficeIMO.Drawing.OfficeDrawing
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
ElectronicInvoiceMetadata 2 overloads
public PdfDocument ElectronicInvoiceMetadata(PdfElectronicInvoiceMetadata metadata) #Returns:
PdfDocumentSets Factur-X/ZUGFeRD XMP extension metadata. This does not by itself certify e-invoice conformance.
Parameters
- metadata OfficeIMO.Pdf.PdfElectronicInvoiceMetadata
public PdfDocument ElectronicInvoiceMetadata(String conformanceLevel, String version = "1.0") #Returns:
PdfDocumentSets Factur-X/ZUGFeRD XMP extension metadata. This does not by itself certify e-invoice conformance.
Parameters
- conformanceLevel System.String
- version System.String = "1.0"
public PdfDocument Ellipse(Double width, Double height, Nullable<PdfColor> strokeColor = null, Double strokeWidth = 1, Nullable<PdfColor> fillColor = null, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, Nullable<OfficeStrokeLineCap> strokeLineCap = null, Nullable<OfficeStrokeLineJoin> strokeLineJoin = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a flow ellipse using the shared OfficeIMO.Drawing shape descriptor.
Parameters
- width System.Double
- height System.Double
- strokeColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 1
- fillColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid
- strokeLineCap System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineCap} = null
- strokeLineJoin System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineJoin} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
EmbedStandardFont 2 overloads
public PdfDocument EmbedStandardFont(PdfStandardFont font, Byte[] data, String fontName = null) #Returns:
PdfDocumentEmbeds a TrueType font file for a generated standard-font slot in this document.
Parameters
- font OfficeIMO.Pdf.PdfStandardFont
- data System.Byte[]
- fontName System.String = null
public PdfDocument EmbedStandardFont(PdfStandardFont font, String path, String fontName = null) #Returns:
PdfDocumentEmbeds a TrueType font file from disk for a generated standard-font slot in this document.
Parameters
- font OfficeIMO.Pdf.PdfStandardFont
- path System.String
- fontName System.String = null
public PdfSecurityMutationResult Encrypt(PdfStandardEncryptionOptions encryption) #Returns:
PdfSecurityMutationResultEncrypts this unencrypted PDF and returns the rewritten document with preservation proof.
Parameters
- encryption OfficeIMO.Pdf.PdfStandardEncryptionOptions
Encryption 2 overloads
public PdfDocument Encryption(PdfStandardEncryptionOptions encryption) #Returns:
PdfDocumentSets or clears Standard password security for generated PDF output.
Parameters
- encryption OfficeIMO.Pdf.PdfStandardEncryptionOptions
public PdfDocument Encryption(String userPassword, String ownerPassword = null, Int32 permissions = -4) #Returns:
PdfDocumentSets Standard password security for generated PDF output.
Parameters
- userPassword System.String
- ownerPassword System.String = null
- permissions System.Int32 = -4
public PdfDocument FileVersion(PdfFileVersion version) #Returns:
PdfDocumentSets the generated PDF file header version.
Parameters
- version OfficeIMO.Pdf.PdfFileVersion
public PdfDocument FlattenVisualAnnotations() #Returns:
PdfDocumentCreates a new PDF with visual annotation appearance streams painted into page content where supported.
public PdfDocument Flow(Action<PdfItemCompose> compose, PdfFlowOptions options = null, PdfLayoutPositionCapture capture = null) #Returns:
PdfDocumentAdds a nested flow group with optional constraints and position capture.
Parameters
- compose System.Action{OfficeIMO.Pdf.PdfItemCompose}
- options OfficeIMO.Pdf.PdfFlowOptions = null
- capture OfficeIMO.Pdf.PdfLayoutPositionCapture = null
public PdfDocument FreeTextAnnotation(String contents, Double width, Double height, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, Double fontSize = 10, Nullable<PdfColor> textColor = null, Nullable<PdfColor> borderColor = null, Double borderWidth = 1, Nullable<PdfColor> fillColor = null, PdfAlign textAlign = Left, Double padding = 3, Nullable<Double> lineHeight = null) #Returns:
PdfDocumentAdds a PDF free-text annotation at the current flow position.
Parameters
- contents System.String
- width System.Double
- height System.Double
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- fontSize System.Double = 10
- textColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- borderColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- borderWidth System.Double = 1
- fillColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- textAlign OfficeIMO.Pdf.PdfAlign = Left
- padding System.Double = 3
- lineHeight System.Nullable{System.Double} = null
public PdfDocument H1(String text, PdfAlign align = Left, Nullable<PdfColor> color = null, String linkUri = null, PdfHeadingStyle style = null, String linkContents = null, String linkDestinationName = null) #Returns:
PdfDocumentAdds a level-1 heading.
Parameters
- text System.String
- align OfficeIMO.Pdf.PdfAlign = Left
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- linkUri System.String = null
- style OfficeIMO.Pdf.PdfHeadingStyle = null
- linkContents System.String = null
- linkDestinationName System.String = null
public PdfDocument H2(String text, PdfAlign align = Left, Nullable<PdfColor> color = null, String linkUri = null, PdfHeadingStyle style = null, String linkContents = null, String linkDestinationName = null) #Returns:
PdfDocumentAdds a level-2 heading.
Parameters
- text System.String
- align OfficeIMO.Pdf.PdfAlign = Left
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- linkUri System.String = null
- style OfficeIMO.Pdf.PdfHeadingStyle = null
- linkContents System.String = null
- linkDestinationName System.String = null
public PdfDocument H3(String text, PdfAlign align = Left, Nullable<PdfColor> color = null, String linkUri = null, PdfHeadingStyle style = null, String linkContents = null, String linkDestinationName = null) #Returns:
PdfDocumentAdds a level-3 heading.
Parameters
- text System.String
- align OfficeIMO.Pdf.PdfAlign = Left
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- linkUri System.String = null
- style OfficeIMO.Pdf.PdfHeadingStyle = null
- linkContents System.String = null
- linkDestinationName System.String = null
public PdfDocument Header(Action<PdfHeaderCompose> build) #Returns:
PdfDocumentDefines the document-wide default header layout and content.
Parameters
- build System.Action{OfficeIMO.Pdf.PdfHeaderCompose}
public PdfDocument HighlightAnnotation(String contents, Double width, Double height, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, Nullable<PdfColor> color = null) #Returns:
PdfDocumentAdds a PDF highlight annotation rectangle at the current flow position.
Parameters
- contents System.String
- width System.Double
- height System.Double
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
public PdfDocument HR(Nullable<Double> thickness = null, Nullable<PdfColor> color = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, PdfHorizontalRuleStyle style = null) #Returns:
PdfDocumentAdds a horizontal rule (line) spanning the content width.
Parameters
- thickness System.Nullable{System.Double} = null
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- style OfficeIMO.Pdf.PdfHorizontalRuleStyle = null
Image 3 overloads
public PdfDocument Image(Byte[] jpegBytes, Double width, Double height, Nullable<PdfAlign> align = null, OfficeClipPath clipPath = null, Nullable<OfficeImageFit> fit = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, PdfImageStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a raster image supported by OfficeIMO.Drawing at the current flow position.
Parameters
- jpegBytes System.Byte[]
- width System.Double
- height System.Double
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- clipPath OfficeIMO.Drawing.OfficeClipPath = null
- fit System.Nullable{OfficeIMO.Drawing.OfficeImageFit} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- style OfficeIMO.Pdf.PdfImageStyle = null
- linkUri System.String = null
- linkContents System.String = null
public PdfDocument Image(Byte[] jpegBytes, Double width, Double height, String alternativeText) #Returns:
PdfDocumentAdds a supported meaningful image at the current flow position with alternate text.
Parameters
- jpegBytes System.Byte[]
- width System.Double
- height System.Double
- alternativeText System.String
public PdfDocument Image(Byte[] jpegBytes, Double width, Double height, Nullable<PdfAlign> align, OfficeClipPath clipPath, Nullable<OfficeImageFit> fit, Nullable<Double> spacingBefore, Nullable<Double> spacingAfter, PdfImageStyle style, String linkUri, String linkContents, String alternativeText) #Returns:
PdfDocumentAdds a raster image supported by OfficeIMO.Drawing at the current flow position.
Parameters
- jpegBytes System.Byte[]
- width System.Double
- height System.Double
- align System.Nullable{OfficeIMO.Pdf.PdfAlign}
- clipPath OfficeIMO.Drawing.OfficeClipPath
- fit System.Nullable{OfficeIMO.Drawing.OfficeImageFit}
- spacingBefore System.Nullable{System.Double}
- spacingAfter System.Nullable{System.Double}
- style OfficeIMO.Pdf.PdfImageStyle
- linkUri System.String
- linkContents System.String
- alternativeText System.String
ImageWatermark 2 overloads
public PdfDocument ImageWatermark(PdfImageWatermark watermark) #Returns:
PdfDocumentSets or clears the document-wide default image watermark rendered behind page content.
Parameters
- watermark OfficeIMO.Pdf.PdfImageWatermark
public PdfDocument ImageWatermark(Byte[] imageBytes, Double width, Double height, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null) #Returns:
PdfDocumentSets a document-wide default image watermark rendered behind page content.
Parameters
- imageBytes System.Byte[]
- width System.Double
- height System.Double
- opacity System.Nullable{System.Double} = null
- rotationAngle System.Nullable{System.Double} = null
public PdfDocumentInfo Inspect(PdfReadOptions options = null) #Returns:
PdfDocumentInfoInspects metadata, pages, annotations, fields, and catalog-level state.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
KeyValueTable 2 overloads
public PdfDocument KeyValueTable(IEnumerable<KeyValuePair<String, String>> rows, PdfAlign align = Left, PdfTableStyle style = null, Boolean includeHeader = false, String keyHeader = "Key", String valueHeader = "Value") #Returns:
PdfDocumentAdds a two-column label/value table for document metadata, invoice facts, definition lists, and similar report sections.
Parameters
- rows System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}}
- Plain text label/value rows.
- align OfficeIMO.Pdf.PdfAlign = Left
- Table alignment in the document flow.
- style OfficeIMO.Pdf.PdfTableStyle = null
- Optional table style. The style is cloned before header-row settings are applied.
- includeHeader System.Boolean = false
- When true, emits a header row before the supplied values.
- keyHeader System.String = "Key"
- Header text for the label column.
- valueHeader System.String = "Value"
- Header text for the value column.
public PdfDocument KeyValueTable(IEnumerable<PdfKeyValueRow> rows, PdfAlign align = Left, PdfTableStyle style = null, Boolean includeHeader = false, String keyHeader = "Key", String valueHeader = "Value") #Returns:
PdfDocumentAdds a two-column rich label/value table for document metadata, invoice facts, definition lists, and similar report sections.
Parameters
- rows System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfKeyValueRow}
- Rich text label/value rows.
- align OfficeIMO.Pdf.PdfAlign = Left
- Table alignment in the document flow.
- style OfficeIMO.Pdf.PdfTableStyle = null
- Optional table style. The style is cloned before header-row settings are applied.
- includeHeader System.Boolean = false
- When true, emits a header row before the supplied values.
- keyHeader System.String = "Key"
- Header text for the label column.
- valueHeader System.String = "Value"
- Header text for the value column.
public PdfDocument Landscape() #Returns:
PdfDocumentSets the document-wide default page orientation to landscape.
public PdfDocument Language(String language) #Returns:
PdfDocumentSets or clears the generated catalog document language, for example "en-US".
Parameters
- language System.String
public PdfDocument Layer(String name, Action<PdfItemCompose> compose, PdfLayerOptions options = null) #Returns:
PdfDocumentAdds flow content controlled by a generated PDF optional-content layer.
Parameters
- name System.String
- compose System.Action{OfficeIMO.Pdf.PdfItemCompose}
- options OfficeIMO.Pdf.PdfLayerOptions = null
public PdfDocument Line(Double x1, Double y1, Double x2, Double y2, Nullable<PdfColor> strokeColor = null, Double strokeWidth = 1, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, Nullable<OfficeStrokeLineCap> strokeLineCap = null, Nullable<OfficeStrokeLineJoin> strokeLineJoin = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a flow line using the shared OfficeIMO.Drawing shape descriptor.
Parameters
- x1 System.Double
- y1 System.Double
- x2 System.Double
- y2 System.Double
- strokeColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 1
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid
- strokeLineCap System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineCap} = null
- strokeLineJoin System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineJoin} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
Margin 3 overloads
public PdfDocument Margin(Double all) #Returns:
PdfDocumentSets uniform document-wide default page margins in points.
Parameters
- all System.Double
public PdfDocument Margin(PageMargins margins) #Returns:
PdfDocumentSets document-wide default page margins from a reusable margin value.
Parameters
- margins OfficeIMO.Pdf.PageMargins
public PdfDocument Margin(Double left, Double top, Double right, Double bottom) #Returns:
PdfDocumentSets document-wide default page margins in points.
Parameters
- left System.Double
- top System.Double
- right System.Double
- bottom System.Double
Merge 2 overloads
public static PdfDocument Merge(params PdfDocument[] documents) #Returns:
PdfDocumentCreates one PDF by merging all supplied documents in order through a single merge pass.
Parameters
- documents OfficeIMO.Pdf.PdfDocument[]
public static PdfDocument Merge(IEnumerable<PdfDocument> documents) #Returns:
PdfDocumentCreates one PDF by merging all supplied documents in order through a single merge pass.
Parameters
- documents System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfDocument}
MergeWith 5 overloads
public PdfDocument MergeWith(PdfDocument document, PdfMergeOptions options) #Returns:
PdfDocumentMerges this PDF with another loaded or generated PDF using an explicit structure policy.
Parameters
- document OfficeIMO.Pdf.PdfDocument
- options OfficeIMO.Pdf.PdfMergeOptions
public PdfDocument MergeWith(PdfDocument document) #Returns:
PdfDocumentCreates a new PDF by merging this PDF with another loaded or generated PDF.
Parameters
- document OfficeIMO.Pdf.PdfDocument
public PdfDocument MergeWith(Byte[] pdf) #Returns:
PdfDocumentCreates a new PDF by merging this PDF with another PDF byte payload.
Parameters
- pdf System.Byte[]
public PdfDocument MergeWith(String path) #Returns:
PdfDocumentCreates a new PDF by merging this PDF with another PDF file.
Parameters
- path System.String
public PdfDocument MergeWith(Stream stream) #Returns:
PdfDocumentCreates a new PDF by merging this PDF with another readable PDF stream.
Parameters
- stream System.IO.Stream
MergeWithReport 2 overloads
public static PdfMergeResult MergeWithReport(PdfMergeOptions options, params PdfDocument[] documents) #Returns:
PdfMergeResultMerges loaded or generated documents with an explicit structure policy and returns readback evidence.
Parameters
- options OfficeIMO.Pdf.PdfMergeOptions
- documents OfficeIMO.Pdf.PdfDocument[]
public static PdfMergeResult MergeWithReport(PdfMergeOptions options, IEnumerable<PdfDocument> documents) #Returns:
PdfMergeResultMerges loaded or generated documents with an explicit structure policy and returns readback evidence.
Parameters
- options OfficeIMO.Pdf.PdfMergeOptions
- documents System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfDocument}
public PdfDocument Meta(String title = null, String author = null, String subject = null, String keywords = null) #Returns:
PdfDocumentSets 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
- Document title metadata.
- author System.String = null
- Document author metadata.
- subject System.String = null
- Document subject metadata.
- keywords System.String = null
- Document keywords metadata.
Returns
This PdfDocument for chaining.
public PdfDocument MultiSelectChoiceField(String name, IEnumerable<String> options, IEnumerable<String> values = null, Double width = 180, Double height = 72, PdfAlign align = Left, Double fontSize = 10, Double spacingBefore = 0, Double spacingAfter = 6, PdfFormFieldStyle style = null) #Returns:
PdfDocumentAdds a simple AcroForm multi-select choice field at the current flow position.
Parameters
- name System.String
- options System.Collections.Generic.IEnumerable{System.String}
- values System.Collections.Generic.IEnumerable{System.String} = null
- width System.Double = 180
- height System.Double = 72
- align OfficeIMO.Pdf.PdfAlign = Left
- fontSize System.Double = 10
- spacingBefore System.Double = 0
- spacingAfter System.Double = 6
- style OfficeIMO.Pdf.PdfFormFieldStyle = null
public PdfDocument Numbered(IEnumerable<String> items, PdfAlign align = Left, Nullable<PdfColor> color = null, Int32 startNumber = 1, PdfListStyle style = null) #Returns:
PdfDocumentAdds a simple numbered list.
Parameters
- items System.Collections.Generic.IEnumerable{System.String}
- align OfficeIMO.Pdf.PdfAlign = Left
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- startNumber System.Int32 = 1
- style OfficeIMO.Pdf.PdfListStyle = null
Open 3 overloads
public static PdfDocument Open(Byte[] pdf, PdfReadOptions readOptions = null) #Returns:
PdfDocumentOpens an existing PDF from bytes and snapshots the caller-owned input once.
Parameters
- pdf System.Byte[]
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
public static PdfDocument Open(String path, PdfReadOptions readOptions = null) #Returns:
PdfDocumentOpens an existing PDF from a bounded file snapshot.
Parameters
- path System.String
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
public static PdfDocument Open(Stream stream, PdfReadOptions readOptions = null) #Returns:
PdfDocumentOpens a complete PDF from a readable stream. Seekable streams are read from the beginning and restored.
Parameters
- stream System.IO.Stream
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument OpenAction(Int32 pageNumber = 1, Nullable<Double> destinationTop = null, PdfOpenActionDestinationMode destinationMode = Xyz, Nullable<Double> destinationLeft = null, Nullable<Double> destinationBottom = null, Nullable<Double> destinationRight = null) #Returns:
PdfDocumentSets the generated catalog open action to a page destination.
Parameters
- pageNumber System.Int32 = 1
- destinationTop System.Nullable{System.Double} = null
- destinationMode OfficeIMO.Pdf.PdfOpenActionDestinationMode = Xyz
- destinationLeft System.Nullable{System.Double} = null
- destinationBottom System.Nullable{System.Double} = null
- destinationRight System.Nullable{System.Double} = null
OpenAsync 2 overloads
public static async Task<PdfDocument> OpenAsync(String path, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #Returns:
Task<PdfDocument>Asynchronously opens an existing PDF from a bounded file snapshot.
Parameters
- path System.String
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task<PdfDocument> OpenAsync(Stream stream, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #Returns:
Task<PdfDocument>Asynchronously opens a complete PDF from a readable caller-owned stream.
Parameters
- stream System.IO.Stream
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
- cancellationToken System.Threading.CancellationToken = null
Optimize 2 overloads
public PdfOptimizationActionResult Optimize(PdfOptimizationOptions options = null) #Returns:
PdfOptimizationActionResultApplies dependency-free lossless optimization and returns the candidate with action and preservation reports.
Parameters
- options OfficeIMO.Pdf.PdfOptimizationOptions = null
public PdfOptimizationActionResult Optimize(PdfOptimizationProfile profile) #Returns:
PdfOptimizationActionResultApplies a named deterministic lossless optimization profile.
Parameters
- profile OfficeIMO.Pdf.PdfOptimizationProfile
public PdfDocument Orientation(PdfPageOrientation orientation) #Returns:
PdfDocumentSets the document-wide default page orientation while preserving the current page size dimensions.
Parameters
- orientation OfficeIMO.Pdf.PdfPageOrientation
OutputIntent 5 overloads
public PdfDocument OutputIntent(PdfOutputIntent outputIntent) #Returns:
PdfDocumentSets or clears the generated catalog output intent.
Parameters
- outputIntent OfficeIMO.Pdf.PdfOutputIntent
public PdfDocument OutputIntent(Byte[] iccProfile) #Returns:
PdfDocumentSets a generated catalog output intent from ICC profile bytes using the default sRGB output condition identifier.
Parameters
- iccProfile System.Byte[]
public PdfDocument OutputIntent(Byte[] iccProfile, String outputConditionIdentifier) #Returns:
PdfDocumentSets a generated catalog output intent from ICC profile bytes.
Parameters
- iccProfile System.Byte[]
- outputConditionIdentifier System.String
public PdfDocument OutputIntent(Byte[] iccProfile, PdfOutputIntentPolicy policy) #Returns:
PdfDocumentSets a generated catalog output intent from ICC profile bytes using the default sRGB output condition identifier.
Parameters
- iccProfile System.Byte[]
- policy OfficeIMO.Pdf.PdfOutputIntentPolicy
public PdfDocument OutputIntent(Byte[] iccProfile, String outputConditionIdentifier, PdfOutputIntentPolicy policy) #Returns:
PdfDocumentSets a generated catalog output intent from ICC profile bytes.
Parameters
- iccProfile System.Byte[]
- outputConditionIdentifier System.String
- policy OfficeIMO.Pdf.PdfOutputIntentPolicy
public PdfDocument Page(Action<PdfPageCompose> configure) #Returns:
PdfDocumentConfigures a page-scoped flow with its own page setup and default styles.
Parameters
- configure System.Action{OfficeIMO.Pdf.PdfPageCompose}
PageBorder 2 overloads
public PdfDocument PageBorder(PdfPageBorder border) #Returns:
PdfDocumentSets or clears the document-wide default page border.
Parameters
- border OfficeIMO.Pdf.PdfPageBorder
public PdfDocument PageBorder(Nullable<PdfColor> color = null, Nullable<Double> width = null, Nullable<Double> inset = null, Nullable<Double> opacity = null, OfficeStrokeDashStyle dashStyle = Solid) #Returns:
PdfDocumentSets a document-wide default page border.
Parameters
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- width System.Nullable{System.Double} = null
- inset System.Nullable{System.Double} = null
- opacity System.Nullable{System.Double} = null
- dashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid
public PdfDocument PageLabelRange(Int32 startPageNumber, PdfPageNumberStyle style, Int32 startNumber = 1, String prefix = null) #Returns:
PdfDocumentAdds a generated catalog page-label rule beginning at the specified one-based document page.
Parameters
- startPageNumber System.Int32
- style OfficeIMO.Pdf.PdfPageNumberStyle
- startNumber System.Int32 = 1
- prefix System.String = null
PageLabels 2 overloads
public PdfDocument PageLabels(String prefix = null) #Returns:
PdfDocumentEnables generated catalog page labels that match the configured page-number style and start number.
Parameters
- prefix System.String = null
public PdfDocument PageLabels(Boolean include, String prefix = null) #Returns:
PdfDocumentEnables or disables generated catalog page labels.
Parameters
- include System.Boolean
- prefix System.String = null
public PdfDocument PageNumberStart(Int32 start) #Returns:
PdfDocumentSets the first visible page number for the document-wide flow.
Parameters
- start System.Int32
public PdfDocument PageNumberStyle(PdfPageNumberStyle style) #Returns:
PdfDocumentSets the document-wide visible page-number style for header/footer tokens.
Parameters
- style OfficeIMO.Pdf.PdfPageNumberStyle
public PdfDocument Panel(Action<PdfItemCompose> compose, PanelStyle style = null, PdfAlign align = Left, Nullable<PdfColor> defaultColor = null) #Returns:
PdfDocumentAdds a styled panel from common flow blocks such as paragraphs, headings, lists, simple tables, rules, and nested panel paragraphs.
Parameters
- compose System.Action{OfficeIMO.Pdf.PdfItemCompose}
- style OfficeIMO.Pdf.PanelStyle = null
- align OfficeIMO.Pdf.PdfAlign = Left
- defaultColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
public PdfDocument PanelParagraph(Action<PdfParagraphBuilder> compose, PanelStyle style = null, PdfAlign align = Left, Nullable<PdfColor> defaultColor = null) #Returns:
PdfDocumentAdds a paragraph inside a simple panel (background + optional border).
Parameters
- compose System.Action{OfficeIMO.Pdf.PdfParagraphBuilder}
- style OfficeIMO.Pdf.PanelStyle = null
- align OfficeIMO.Pdf.PdfAlign = Left
- defaultColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
public PdfDocument Paragraph(Action<PdfParagraphBuilder> compose, PdfAlign align = Left, Nullable<PdfColor> defaultColor = null, PdfParagraphStyle style = null) #Returns:
PdfDocumentFluent paragraph builder in the style of OfficeIMO.Word. Example: Paragraph(p => p.Color(PdfColor.Gray).Text("You can ").Bold("mix ").Italic("styles"));
Parameters
- compose System.Action{OfficeIMO.Pdf.PdfParagraphBuilder}
- align OfficeIMO.Pdf.PdfAlign = Left
- defaultColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- style OfficeIMO.Pdf.PdfParagraphStyle = null
public PdfDocument Path(IEnumerable<OfficePathCommand> commands, Nullable<PdfColor> strokeColor = null, Double strokeWidth = 1, Nullable<PdfColor> fillColor = null, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, Nullable<OfficeStrokeLineCap> strokeLineCap = null, Nullable<OfficeStrokeLineJoin> strokeLineJoin = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a flow path using the shared OfficeIMO.Drawing shape descriptor.
Parameters
- commands System.Collections.Generic.IEnumerable{OfficeIMO.Drawing.OfficePathCommand}
- strokeColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 1
- fillColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid
- strokeLineCap System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineCap} = null
- strokeLineJoin System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineJoin} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
PdfAIdentification 2 overloads
public PdfDocument PdfAIdentification(PdfAIdentification identification) #Returns:
PdfDocumentSets PDF/A XMP identification metadata. This does not by itself certify PDF/A conformance.
Parameters
- identification OfficeIMO.Pdf.PdfAIdentification
public PdfDocument PdfAIdentification(Int32 part, String conformance) #Returns:
PdfDocumentSets PDF/A XMP identification metadata. This does not by itself certify PDF/A conformance.
Parameters
- part System.Int32
- conformance System.String
PdfUaIdentification 2 overloads
public PdfDocument PdfUaIdentification(PdfUaIdentification identification) #Returns:
PdfDocumentSets PDF/UA XMP identification metadata. This does not by itself certify PDF/UA conformance.
Parameters
- identification OfficeIMO.Pdf.PdfUaIdentification
public PdfDocument PdfUaIdentification(Int32 part = 1) #Returns:
PdfDocumentSets PDF/UA XMP identification metadata. This does not by itself certify PDF/UA conformance.
Parameters
- part System.Int32 = 1
public PdfMutationPlan PlanMutation(PdfMutationOperation operation, IEnumerable<String> fieldNames = null, PdfReadOptions options = null, PdfMutationExecutionPreference executionPreference = Automatic) #Returns:
PdfMutationPlanChooses a full-rewrite, append-only, or blocked path for an existing-document mutation.
Parameters
- operation OfficeIMO.Pdf.PdfMutationOperation
- fieldNames System.Collections.Generic.IEnumerable{System.String} = null
- options OfficeIMO.Pdf.PdfReadOptions = null
- executionPreference OfficeIMO.Pdf.PdfMutationExecutionPreference = Automatic
public PdfRedactionPlan PlanRedactions(IEnumerable<PdfRedactionArea> areas, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfRedactionPlanPlans rectangle-based redaction impact without modifying the PDF.
Parameters
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument Polygon(IEnumerable<OfficePoint> points, Nullable<PdfColor> strokeColor = null, Double strokeWidth = 1, Nullable<PdfColor> fillColor = null, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, Nullable<OfficeStrokeLineCap> strokeLineCap = null, Nullable<OfficeStrokeLineJoin> strokeLineJoin = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a flow polygon using the shared OfficeIMO.Drawing shape descriptor.
Parameters
- points System.Collections.Generic.IEnumerable{OfficeIMO.Drawing.OfficePoint}
- strokeColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 1
- fillColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid
- strokeLineCap System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineCap} = null
- strokeLineJoin System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineJoin} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
public PdfDocument Portrait() #Returns:
PdfDocumentSets the document-wide default page orientation to portrait.
Preflight 4 overloads
public static PdfDocumentPreflight Preflight(Byte[] pdf, PdfReadOptions options = null) #Returns:
PdfDocumentPreflightReports 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[]
- options OfficeIMO.Pdf.PdfReadOptions = null
public static PdfDocumentPreflight Preflight(String path, PdfReadOptions options = null) #Returns:
PdfDocumentPreflightReports 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
- options OfficeIMO.Pdf.PdfReadOptions = null
public static PdfDocumentPreflight Preflight(Stream stream, PdfReadOptions options = null) #Returns:
PdfDocumentPreflightReports 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
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocumentPreflight Preflight(PdfReadOptions options = null) #Returns:
PdfDocumentPreflightReports read and rewrite capabilities for this PDF.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfExternalSignaturePreparation PrepareExternalSignature(PdfExternalSignatureOptions signatureOptions = null) #Returns:
PdfExternalSignaturePreparationAppends an external-signature placeholder as an incremental revision for a later CMS, CAdES, or timestamp signature.
Parameters
- signatureOptions OfficeIMO.Pdf.PdfExternalSignatureOptions = null
public PdfDocument RadioButtonGroup(String name, IEnumerable<String> options, String value = null, Double size = 14, Double gap = 6, PdfAlign align = Left, Double spacingBefore = 0, Double spacingAfter = 6, PdfFormFieldStyle style = null) #Returns:
PdfDocumentAdds a simple AcroForm radio button group at the current flow position.
Parameters
- name System.String
- options System.Collections.Generic.IEnumerable{System.String}
- value System.String = null
- size System.Double = 14
- gap System.Double = 6
- align OfficeIMO.Pdf.PdfAlign = Left
- spacingBefore System.Double = 0
- spacingAfter System.Double = 6
- style OfficeIMO.Pdf.PdfFormFieldStyle = null
public PdfDocument Rectangle(Double width, Double height, Nullable<PdfColor> strokeColor = null, Double strokeWidth = 1, Nullable<PdfColor> fillColor = null, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, Nullable<OfficeStrokeLineCap> strokeLineCap = null, Nullable<OfficeStrokeLineJoin> strokeLineJoin = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a flow rectangle using the shared OfficeIMO.Drawing shape descriptor.
Parameters
- width System.Double
- height System.Double
- strokeColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 1
- fillColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid
- strokeLineCap System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineCap} = null
- strokeLineJoin System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineJoin} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
public PdfSecurityMutationResult Reencrypt(String currentOwnerPassword, PdfStandardEncryptionOptions newEncryption) #Returns:
PdfSecurityMutationResultReplaces Standard password security using the current owner password and returns preservation proof.
Parameters
- currentOwnerPassword System.String
- newEncryption OfficeIMO.Pdf.PdfStandardEncryptionOptions
public PdfDocument RegisterEmbeddedFontFallbacks(PdfEmbeddedFontFallbackSet fallbackSet) #Returns:
PdfDocumentRegisters a planned embedded-font fallback set for generated rich text runs.
Parameters
- fallbackSet OfficeIMO.Pdf.PdfEmbeddedFontFallbackSet
public PdfDocument ReplaceMetadata(PdfMetadata metadata) #Returns:
PdfDocumentCreates a new PDF with exactly the supplied metadata.
Parameters
- metadata OfficeIMO.Pdf.PdfMetadata
public PdfDocument RichBullets(IEnumerable<PdfListItem> items, PdfAlign align = Left, Nullable<PdfColor> color = null, PdfListStyle style = null) #Returns:
PdfDocumentAdds a bullet list whose items can contain rich inline text runs.
Parameters
- items System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfListItem}
- align OfficeIMO.Pdf.PdfAlign = Left
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- style OfficeIMO.Pdf.PdfListStyle = null
public PdfDocument RichNumbered(IEnumerable<PdfListItem> items, PdfAlign align = Left, Nullable<PdfColor> color = null, Int32 startNumber = 1, PdfListStyle style = null) #Returns:
PdfDocumentAdds a numbered list whose items can contain rich inline text runs.
Parameters
- items System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfListItem}
- align OfficeIMO.Pdf.PdfAlign = Left
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- startNumber System.Int32 = 1
- style OfficeIMO.Pdf.PdfListStyle = null
public PdfDocument RoundedRectangle(Double width, Double height, Double cornerRadius, Nullable<PdfColor> strokeColor = null, Double strokeWidth = 1, Nullable<PdfColor> fillColor = null, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, Nullable<OfficeStrokeLineCap> strokeLineCap = null, Nullable<OfficeStrokeLineJoin> strokeLineJoin = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a flow rounded rectangle using the shared OfficeIMO.Drawing shape descriptor.
Parameters
- width System.Double
- height System.Double
- cornerRadius System.Double
- strokeColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- strokeWidth System.Double = 1
- fillColor System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid
- strokeLineCap System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineCap} = null
- strokeLineJoin System.Nullable{OfficeIMO.Drawing.OfficeStrokeLineJoin} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
public PdfDocument Row(Action<PdfRowCompose> build) #Returns:
PdfDocumentAdds a row with percentage-based columns to the current document flow.
Parameters
- build System.Action{OfficeIMO.Pdf.PdfRowCompose}
- Row builder that defines column widths, layout rhythm, and column content.
Returns
This PdfDocument for chaining.
Examples
PdfDocument.Create()
.Row(row => row
.Gap(16)
.Column(35, column => column.H2("Signals").Bullets(new[] { "Healthy", "Watch", "Needs action" }))
.Column(65, column => column.Panel("Right-side report callout.")))
.Save("report.pdf");
public PdfSanitizationResult Sanitize(PdfSanitizationOptions options = null) #Returns:
PdfSanitizationResultRemoves or quarantines active content and embedded payloads through a proven full rewrite.
Parameters
- options OfficeIMO.Pdf.PdfSanitizationOptions = null
Save 2 overloads
public PdfSaveResult Save(Stream stream) #Returns:
PdfSaveResultWrites the complete document to stream. Seekable streams are overwritten and rewound.
Parameters
- stream System.IO.Stream
- Writable destination stream.
public PdfSaveResult Save(String path) #Returns:
PdfSaveResultSaves the document to path. Creates the directory if needed.
Parameters
- path System.String
- Destination file path, e.g. "C:\\Docs\\Report.pdf".
SaveAsync 2 overloads
public async Task<PdfSaveResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<PdfSaveResult>Asynchronously writes the complete document to stream. Seekable streams are overwritten and rewound.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public async Task<PdfSaveResult> SaveAsync(String path, CancellationToken cancellationToken = null) #Returns:
Task<PdfSaveResult>Asynchronously saves the document to path.
Parameters
- path System.String
- cancellationToken System.Threading.CancellationToken = null
public PdfRedactionPlan SearchRedactions(PdfRedactionSearchOptions search, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfRedactionPlanDerives a reviewable redaction plan from literal text, regex, logical kinds, and form-field names.
Parameters
- search OfficeIMO.Pdf.PdfRedactionSearchOptions
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
Section 2 overloads
public PdfDocument Section(String title, Action<PdfItemCompose> compose, PdfSectionOptions options = null) #Returns:
PdfDocumentAdds a semantic section backed by an outline entry and named destination.
Parameters
- title System.String
- compose System.Action{OfficeIMO.Pdf.PdfItemCompose}
- options OfficeIMO.Pdf.PdfSectionOptions = null
public PdfDocument Section(Action<PdfPageCompose> configure) #Returns:
PdfDocumentConfigures a section-scoped flow with its own page setup and default styles.
Parameters
- configure System.Action{OfficeIMO.Pdf.PdfPageCompose}
public PdfDocument Shape(OfficeShape shape, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, PdfDrawingStyle style = null, String linkUri = null, String linkContents = null) #Returns:
PdfDocumentAdds a shared OfficeIMO.Drawing shape at the current flow position.
Parameters
- shape OfficeIMO.Drawing.OfficeShape
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- style OfficeIMO.Pdf.PdfDrawingStyle = null
- linkUri System.String = null
- linkContents System.String = null
public PdfExternalSignatureCompletion SignExternal(IPdfExternalSigner signer, PdfExternalSignatureOptions signatureOptions = null) #Returns:
PdfExternalSignatureCompletionPrepares, externally signs, and applies a PDF signature without placing key-storage logic in OfficeIMO.Pdf.
Parameters
- signer OfficeIMO.Pdf.IPdfExternalSigner
- signatureOptions OfficeIMO.Pdf.PdfExternalSignatureOptions = null
Size 2 overloads
public PdfDocument Size(PageSize size) #Returns:
PdfDocumentSets the document-wide default page size used by top-level flow and composed pages.
Parameters
- size OfficeIMO.Pdf.PageSize
public PdfDocument Size(Double width, Double height) #Returns:
PdfDocumentSets the document-wide default page size in points.
Parameters
- width System.Double
- height System.Double
public PdfDocument Spacer(Double height) #Returns:
PdfDocumentAdds invisible vertical space to the current document flow.
Parameters
- height System.Double
public PdfDocument SrgbOutputIntent() #Returns:
PdfDocumentSets the generated catalog output intent to OfficeIMO's built-in sRGB IEC61966-2.1 ICC profile.
public PdfDocument SynchronizeMetadata(String title = null, String author = null, String subject = null, String keywords = null, Boolean createXmpMetadata = true) #Returns:
PdfDocumentCreates 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
- author System.String = null
- subject System.String = null
- keywords System.String = null
- createXmpMetadata System.Boolean = true
Table 2 overloads
public PdfDocument Table(IEnumerable<String[]> rows, PdfAlign align = Left, PdfTableStyle style = null) #Returns:
PdfDocumentAdds a simple table from rows of string arrays.
Parameters
- rows System.Collections.Generic.IEnumerable{System.String[]}
- align OfficeIMO.Pdf.PdfAlign = Left
- style OfficeIMO.Pdf.PdfTableStyle = null
public PdfDocument Table(IEnumerable<PdfTableCell[]> rows, PdfAlign align = Left, PdfTableStyle style = null) #Returns:
PdfDocumentAdds a table from explicit cells, including optional column spans.
Parameters
- rows System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCell[]}
- align OfficeIMO.Pdf.PdfAlign = Left
- style OfficeIMO.Pdf.PdfTableStyle = null
TableDeferred 2 overloads
public PdfDocument TableDeferred(Func<IEnumerable<String[]>> rowFactory, Int32 batchSize = 256, PdfAlign align = Left, PdfTableStyle style = null) #Returns:
PdfDocumentAdds a replayable plain-text table whose rows are enumerated and laid out in bounded batches.
Parameters
- rowFactory System.Func{System.Collections.Generic.IEnumerable{System.String[]}}
- Factory that returns a fresh sequence of table rows for each render pass.
- batchSize System.Int32 = 256
- Maximum number of body rows materialized for one layout batch.
- align OfficeIMO.Pdf.PdfAlign = Left
- Table alignment in the document flow.
- style OfficeIMO.Pdf.PdfTableStyle = null
- Optional table style.
public PdfDocument TableDeferred(Func<IEnumerable<PdfTableCell[]>> rowFactory, Int32 batchSize = 256, PdfAlign align = Left, PdfTableStyle style = null) #Returns:
PdfDocumentAdds a replayable rich-cell table whose rows are enumerated and laid out in bounded batches.
Parameters
- rowFactory System.Func{System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCell[]}}
- Factory that returns a fresh sequence of rich table rows for each render pass.
- batchSize System.Int32 = 256
- Maximum number of body rows materialized for one layout batch.
- align OfficeIMO.Pdf.PdfAlign = Left
- Table alignment in the document flow.
- style OfficeIMO.Pdf.PdfTableStyle = null
- Optional table style.
public PdfDocument TableOfContents(PdfTableOfContentsOptions options = null) #Returns:
PdfDocumentAdds an automatically generated, internally linked table of contents.
Parameters
- options OfficeIMO.Pdf.PdfTableOfContentsOptions = null
public PdfDocument TableWithLinks(IEnumerable<String[]> rows, Dictionary<ValueTuple<Int32, Int32>, String> links, PdfAlign align = Left, PdfTableStyle style = null) #Returns:
PdfDocumentAdds a table and attaches link URIs to specific cells.
Parameters
- rows System.Collections.Generic.IEnumerable{System.String[]}
- links System.Collections.Generic.Dictionary{System.ValueTuple{System.Int32,System.Int32},System.String}
- align OfficeIMO.Pdf.PdfAlign = Left
- style OfficeIMO.Pdf.PdfTableStyle = null
public PdfDocument TaggedPdfCatalogMarkers() #Returns:
PdfDocumentEmits catalog-level tagged-PDF markers without claiming full tagged-content generation.
public PdfDocument TaggedStructure(PdfTaggedStructureMode mode) #Returns:
PdfDocumentSets the generated tagged-PDF groundwork mode.
Parameters
- mode OfficeIMO.Pdf.PdfTaggedStructureMode
public PdfDocument TextAnnotation(String contents, Double width = 18, Double height = 18, Nullable<PdfAlign> align = null, Nullable<Double> spacingBefore = null, Nullable<Double> spacingAfter = null, PdfTextAnnotationIcon icon = Comment, Nullable<PdfColor> color = null, Boolean open = false) #Returns:
PdfDocumentAdds a PDF text annotation at the current flow position.
Parameters
- contents System.String
- width System.Double = 18
- height System.Double = 18
- align System.Nullable{OfficeIMO.Pdf.PdfAlign} = null
- spacingBefore System.Nullable{System.Double} = null
- spacingAfter System.Nullable{System.Double} = null
- icon OfficeIMO.Pdf.PdfTextAnnotationIcon = Comment
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- open System.Boolean = false
public PdfDocument TextField(String name, Double width = 180, Double height = 22, String value = "", PdfAlign align = Left, Double fontSize = 10, Double spacingBefore = 0, Double spacingAfter = 6, PdfFormFieldStyle style = null) #Returns:
PdfDocumentAdds a simple AcroForm text field at the current flow position.
Parameters
- name System.String
- width System.Double = 180
- height System.Double = 22
- value System.String = ""
- align OfficeIMO.Pdf.PdfAlign = Left
- fontSize System.Double = 10
- spacingBefore System.Double = 0
- spacingAfter System.Double = 6
- style OfficeIMO.Pdf.PdfFormFieldStyle = null
public PdfDocument TextHyphenation(PdfTextHyphenationCallback callback) #Returns:
PdfDocumentSets or clears the generated text hyphenation callback used for long unspaced tokens.
Parameters
- callback OfficeIMO.Pdf.PdfTextHyphenationCallback
public PdfDocument TextHyphenationDictionary(PdfHyphenationLexicon dictionary) #Returns:
PdfDocumentUses or clears an immutable first-party word hyphenation dictionary.
Parameters
- dictionary OfficeIMO.Pdf.PdfHyphenationLexicon
public PdfDocument TextLineBreaks(Func<String, IReadOnlyList<Int32>> callback) #Returns:
PdfDocumentSets or clears the generated text line-break callback used for long unspaced tokens.
Parameters
- callback System.Func{System.String,System.Collections.Generic.IReadOnlyList{System.Int32}}
public PdfDocument Theme(PdfTheme theme) #Returns:
PdfDocumentApplies reusable document-wide default styles.
Parameters
- theme OfficeIMO.Pdf.PdfTheme
public MemoryStream ToStream() #Returns:
MemoryStreamRenders the document into a new writable memory stream positioned at the beginning.
public PdfOperationResult<PdfDocument> TryAppendMetadataRevision(String title = null, String author = null, String subject = null, String keywords = null, PdfReadOptions options = null, Boolean createXmpMetadata = false) #Returns:
PdfOperationResult<PdfDocument>Attempts to append a metadata-only incremental revision, returning diagnostics when blocked or failed.
Parameters
- title System.String = null
- author System.String = null
- subject System.String = null
- keywords System.String = null
- options OfficeIMO.Pdf.PdfReadOptions = null
- createXmpMetadata System.Boolean = false
public PdfOperationResult<PdfDocument> TryApplyRedactions(IEnumerable<PdfRedactionArea> areas, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts to apply rectangle-based redactions, returning diagnostics when blocked or failed.
Parameters
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfSecurityMutationResult> TryDecrypt(String ownerPassword) #Returns:
PdfOperationResult<PdfSecurityMutationResult>Attempts to remove Standard password security using the current owner password.
Parameters
- ownerPassword System.String
public PdfOperationResult<PdfSecurityMutationResult> TryEncrypt(PdfStandardEncryptionOptions encryption) #Returns:
PdfOperationResult<PdfSecurityMutationResult>Attempts to encrypt this unencrypted PDF through the shared mutation planner.
Parameters
- encryption OfficeIMO.Pdf.PdfStandardEncryptionOptions
public PdfOperationResult<PdfDocument> TryFlattenVisualAnnotations(PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts to flatten visual annotation appearance streams, returning diagnostics when blocked or failed.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
TryMergeWith 4 overloads
public PdfOperationResult<PdfDocument> TryMergeWith(PdfDocument document, PdfReadOptions options = null) #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
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryMergeWith(Byte[] pdf, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts to merge this PDF with another PDF byte payload, returning diagnostics when blocked or failed.
Parameters
- pdf System.Byte[]
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryMergeWith(String path, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts to merge this PDF with another PDF file, returning diagnostics when blocked or failed.
Parameters
- path System.String
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryMergeWith(Stream stream, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts to merge this PDF with another readable PDF stream, returning diagnostics when blocked or failed.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfExternalSignaturePreparation> TryPrepareExternalSignature(PdfExternalSignatureOptions signatureOptions = null, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfExternalSignaturePreparation>Attempts to append an external-signature placeholder revision, returning diagnostics when blocked or failed.
Parameters
- signatureOptions OfficeIMO.Pdf.PdfExternalSignatureOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public static Boolean TryPrepareImageBytes(Byte[] data, out Byte[] preparedBytes, out OfficeImageInfo imageInfo, out Boolean wasTranscoded, out String unsupportedReason) #Returns:
BooleanPrepares source image bytes for first-party PDF embedding. Writer-safe JPEG and PNG data is retained; other raster formats supported by OfficeRasterImageDecoder are normalized to PNG.
Parameters
- data System.Byte[]
- preparedBytes System.Byte[]@
- imageInfo OfficeIMO.Drawing.OfficeImageInfo@
- wasTranscoded System.Boolean@
- unsupportedReason System.String@
public PdfOperationResult<PdfSecurityMutationResult> TryReencrypt(String currentOwnerPassword, PdfStandardEncryptionOptions newEncryption) #Returns:
PdfOperationResult<PdfSecurityMutationResult>Attempts to replace Standard password security using the current owner password.
Parameters
- currentOwnerPassword System.String
- newEncryption OfficeIMO.Pdf.PdfStandardEncryptionOptions
public PdfOperationResult<PdfDocument> TryReplaceMetadata(PdfMetadata metadata, PdfReadOptions options = null) #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
- options OfficeIMO.Pdf.PdfReadOptions = null
TrySave 2 overloads
public PdfSaveResult TrySave(Stream stream) #Returns:
PdfSaveResultAttempts to write the document to stream and returns output diagnostics instead of throwing.
Parameters
- stream System.IO.Stream
public PdfSaveResult TrySave(String path) #Returns:
PdfSaveResultAttempts to save the document to path and returns output diagnostics instead of throwing.
Parameters
- path System.String
TrySaveAsync 2 overloads
public async Task<PdfSaveResult> TrySaveAsync(Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<PdfSaveResult>Attempts to asynchronously write the document to stream and returns output diagnostics instead of throwing.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public async Task<PdfSaveResult> TrySaveAsync(String path, CancellationToken cancellationToken = null) #Returns:
Task<PdfSaveResult>Attempts to asynchronously save the document to path and returns output diagnostics instead of throwing.
Parameters
- path System.String
- cancellationToken System.Threading.CancellationToken = null
public PdfOperationResult<PdfDocument> TrySynchronizeMetadata(String title = null, String author = null, String subject = null, String keywords = null, Boolean createXmpMetadata = true, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts a full-rewrite Info/XMP synchronization and returns planner diagnostics when blocked.
Parameters
- title System.String = null
- author System.String = null
- subject System.String = null
- keywords System.String = null
- createXmpMetadata System.Boolean = true
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfBytesResult TryToBytes() #Returns:
PdfBytesResultAttempts to render the document into a PDF byte array and returns diagnostics instead of throwing.
public PdfOperationResult<PdfDocument> TryUpdateMetadata(String title = null, String author = null, String subject = null, String keywords = null, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts to create a new PDF with updated metadata, returning diagnostics when blocked or failed.
Parameters
- title System.String = null
- author System.String = null
- subject System.String = null
- keywords System.String = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public static Boolean TryValidateImageBytes(Byte[] data, out OfficeImageInfo imageInfo, out String unsupportedReason) #Returns:
BooleanChecks whether image bytes can be embedded by the first-party PDF writer.
Parameters
- data System.Byte[]
- imageInfo OfficeIMO.Drawing.OfficeImageInfo@
- unsupportedReason System.String@
public PdfDocument UpdateMetadata(String title = null, String author = null, String subject = null, String keywords = null) #Returns:
PdfDocumentCreates a new PDF with updated metadata. Null values preserve existing fields; empty strings clear fields.
Parameters
- title System.String = null
- author System.String = null
- subject System.String = null
- keywords System.String = null
public PdfDocument UseEmbeddedFontFallbacksFromSystem(String familyNames, Int32 maxFallbackFonts = 2) #Returns:
PdfDocumentRegisters generated-text fallback fonts from installed system font families without requiring callers to choose PDF font slots.
Parameters
- familyNames System.String
- maxFallbackFonts System.Int32 = 2
UseFontFamily 3 overloads
public PdfDocument UseFontFamily(String familyName, Byte[] regular, Byte[] bold = null, Byte[] italic = null, Byte[] boldItalic = null) #Returns:
PdfDocumentUses a caller-supplied TrueType font family as the generated document's default font family.
Parameters
- familyName System.String
- regular System.Byte[]
- bold System.Byte[] = null
- italic System.Byte[] = null
- boldItalic System.Byte[] = null
public PdfDocument UseFontFamily(PdfEmbeddedFontFamily fontFamily) #Returns:
PdfDocumentUses a reusable caller-supplied TrueType font family as the generated document's default font family.
Parameters
- fontFamily OfficeIMO.Pdf.PdfEmbeddedFontFamily
public PdfDocument UseFontFamily(String familyName, String regularPath, String boldPath = null, String italicPath = null, String boldItalicPath = null) #Returns:
PdfDocumentUses caller-supplied TrueType font files as the generated document's default font family.
Parameters
- familyName System.String
- regularPath System.String
- boldPath System.String = null
- italicPath System.String = null
- boldItalicPath System.String = null
public PdfDocument UseTextFallbacks(PdfTextFallbackFeatures features = Default) #Returns:
PdfDocumentApplies OfficeIMO's built-in generated-text fallback groups.
Parameters
- features OfficeIMO.Pdf.PdfTextFallbackFeatures = Default
public PdfDocument UseTextShaping(PdfTextShapingMode mode, IOfficeTextShapingProvider provider = null) #Returns:
PdfDocumentConfigures dependency-free generated-text shaping and an optional host-provided shaping seam.
Parameters
- mode OfficeIMO.Pdf.PdfTextShapingMode
- provider OfficeIMO.Drawing.IOfficeTextShapingProvider = null
ValidateSignatures 2 overloads
public PdfSignatureValidationReport ValidateSignatures(PdfReadOptions options = null) #Returns:
PdfSignatureValidationReportValidates signature structure, byte ranges, and preservation markers for this PDF.
Parameters
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfSignatureValidationReport ValidateSignatures(IPdfSignatureCryptographyProvider cryptographyProvider, PdfReadOptions options = null) #Returns:
PdfSignatureValidationReportValidates signature structure and delegates CMS, trust, timestamp, and revocation policy to an optional provider.
Parameters
- cryptographyProvider OfficeIMO.Pdf.IPdfSignatureCryptographyProvider
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfRedactionVerificationReport VerifyRedactions(PdfRedactionVerificationOptions options) #Returns:
PdfRedactionVerificationReportVerifies that configured redaction markers were removed and retained markers remain readable in this PDF.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
ViewerPreferences 2 overloads
public PdfDocument ViewerPreferences(PdfViewerPreferencesOptions preferences) #Returns:
PdfDocumentSets or clears generated catalog viewer preferences.
Parameters
- preferences OfficeIMO.Pdf.PdfViewerPreferencesOptions
public PdfDocument ViewerPreferences(Action<PdfViewerPreferencesOptions> configure) #Returns:
PdfDocumentConfigures generated catalog viewer preferences.
Parameters
- configure System.Action{OfficeIMO.Pdf.PdfViewerPreferencesOptions}
Watermark 2 overloads
public PdfDocument Watermark(PdfTextWatermark watermark) #Returns:
PdfDocumentSets or clears the document-wide default text watermark rendered behind page content.
Parameters
- watermark OfficeIMO.Pdf.PdfTextWatermark
public PdfDocument Watermark(String text, Nullable<Double> fontSize = null, Nullable<PdfColor> color = null, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null, Nullable<PdfStandardFont> font = null, Boolean bold = true, Boolean italic = false) #Returns:
PdfDocumentSets a document-wide default text watermark rendered behind page content.
Parameters
- text System.String
- fontSize System.Nullable{System.Double} = null
- color System.Nullable{OfficeIMO.Pdf.PdfColor} = null
- opacity System.Nullable{System.Double} = null
- rotationAngle System.Nullable{System.Double} = null
- font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null
- bold System.Boolean = true
- italic System.Boolean = false
Inherited Methods
Properties
public PdfDocumentPages Pages { get; } #Page editing and extraction operations for this PDF.
public PdfDocumentReader Read { get; } #Readback operations for this PDF.
public PdfDocumentAttachments Attachments { get; } #Existing-document embedded and associated file editing operations.
public PdfDocumentBookmarks Bookmarks { get; } #Existing-document bookmark editing operations.
public PdfDocumentAnnotations Annotations { get; } #Existing-document annotation editing operations.
public PdfPipelineReport Pipeline { get; } #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; } #Text and image stamping operations for this PDF.
public PdfDocumentForms Forms { get; } #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 = null) #Returns:
IReadOnlyList<OfficeImageExportResult>Exports pages from an authored or opened PDF document using the shared five-format result contract.
Parameters
- arg1 OfficeIMO.Pdf.PdfDocument
- arg2 OfficeIMO.Drawing.OfficeImageExportFormat
- arg3 OfficeIMO.Pdf.PdfImageExportOptions = null
- arg4 OfficeIMO.Pdf.PdfPageSelection = null
- arg5 System.Threading.CancellationToken = null
ToImages 2 overloads
public static PdfDocumentImageExportBuilder ToImages(PdfDocument document) #Returns:
PdfDocumentImageExportBuilderStarts 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
public static PdfDocumentImageExportBuilder ToImages(PdfDocument document, PdfImageExportOptions options) #Returns:
PdfDocumentImageExportBuilderStarts 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
- options OfficeIMO.Pdf.PdfImageExportOptions