PdfCreateOptions

Adds the canonical Factur-X/ZUGFeRD CrossIndustryInvoice XML payload and matching XMP extension metadata.

Parameters

ciiXml byte[] required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

Adds the canonical Factur-X/ZUGFeRD CrossIndustryInvoice XML file and matching XMP extension metadata.

Parameters

ciiXmlPath string required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

Adds a generated catalog page-label rule beginning at the specified one-based document page.

Parameters

startPageNumber int required

style OfficeIMO.Pdf.PdfPageNumberStyle required

startNumber int = 1 optional

prefix string? = null optional

Applies reusable default styles to this options object.

Parameters

theme OfficeIMO.Pdf.PdfTheme required

Clears the generated AcroForm default text alignment.

Clears the generated catalog URI base.

Clears generated catalog page mode and page layout viewer hints.

Removes all embedded files associated with the generated PDF catalog.

Removes all embedded standard-font mappings.

Clears generated PDF password security.

Removes every embedded named family and its parsed program cache.

Clears the generated catalog open action.

Clears generated catalog page-label ranges while leaving simple page-label options unchanged.

Clears the generated document portfolio configuration without removing embedded files.

Creates a deep copy of the options.

Configures common PDF/A-3 e-invoice groundwork for Factur-X or ZUGFeRD without enabling formal compliance profile generation.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile required

ciiXml byte[] required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

useDocumentFontFallback bool = true optional

Configures common PDF/A-3 e-invoice groundwork for Factur-X or ZUGFeRD from a CrossIndustryInvoice XML file.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile required

ciiXmlPath string required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

useDocumentFontFallback bool = true optional

Configures common PDF/A-3 Factur-X/ZUGFeRD groundwork from a CrossIndustryInvoice XML file.

Parameters

ciiXmlPath string required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

useDocumentFontFallback bool = true optional

Configures common PDF/A-2, PDF/A-3, or PDF/A-4 groundwork without enabling formal compliance profile generation.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile required

language string = "en-US" optional

Configures fail-closed PDF/X generation using a caller-supplied CMYK print-condition ICC profile.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile required

cmykIccProfile byte[] required

outputConditionIdentifier string required

trappingStatus OfficeIMO.Pdf.PdfTrappingStatus = False optional

Configures PDF/X metadata, print-condition color conversion, and production-page groundwork without selecting a formal compliance profile.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile required

cmykIccProfile byte[] required

outputConditionIdentifier string required

trappingStatus OfficeIMO.Pdf.PdfTrappingStatus = Unknown optional

Configures generated catalog viewer preferences.

Parameters

configure System.Action<OfficeIMO.Pdf.PdfViewerPreferencesOptions> required

Emits catalog-level tagged-PDF markers without claiming full tagged-content generation.

Reports whether a generated standard-font family slot currently has an embedded font mapping.

Parameters

font OfficeIMO.Pdf.PdfStandardFont required

Generated PDF font slot or variant.

Reports whether an embedded named family is registered.

Parameters

familyName string? required

Registers a planned embedded-font fallback set while preserving existing compatibility-slot font families. Occupied compatibility slots are resolved when fallback runs are rendered.

Parameters

fallbackSet OfficeIMO.Pdf.PdfEmbeddedFontFallbackSet required

Fallback set that pairs prioritized embedded font candidates with generated font slots.

Registers a caller-supplied TrueType font family for one semantic PDF font family slot without changing the document default font. Use this for private, licensed, or packaged fonts that should back a specific generated Helvetica, Times, or Courier family.

Parameters

baseFontFamily OfficeIMO.Pdf.PdfStandardFont required

The semantic standard family slot to back: Helvetica, Times-Roman, or Courier.

fontFamily OfficeIMO.Pdf.PdfEmbeddedFontFamily required

Reusable TrueType font family to embed into that semantic slot.

Registers a source document family as a planned substitute for an embedded named PDF family.

Parameters

sourceFontFamily string required

Source family declared by the input document.

targetFontFamily string required

Registered embedded family used in generated PDF text.

impact OfficeIMO.Pdf.PdfFontFamilySubstitutionImpact = LayoutSensitive optional

Expected layout impact of the substitution.

Registers a reusable embedded family under its authored family name. Named families do not consume Helvetica, Times, or Courier compatibility slots and may be used together on one page.

Parameters

fontFamily OfficeIMO.Pdf.PdfEmbeddedFontFamily required

Registers an Office-style font family for one semantic PDF font family slot without changing the document default font. This is used by converters for run-level and cell-level fonts.

Parameters

familyName string? required

Office, CSS, or system font family name such as Aptos, Georgia, or Consolas.

baseFontFamily OfficeIMO.Pdf.PdfStandardFont required

The semantic standard family slot to back: Helvetica, Times-Roman, or Courier.

embedSystemFont bool = true optional

When true, installed TrueType faces are embedded into the selected semantic slot when available.

Records generated text and layout diagnostics encountered while writing PDF content.

Parameters

report OfficeIMO.Pdf.PdfConversionReport required

Mutable conversion report that receives text encoding, missing-glyph, shaping, embedded-font, and layout diagnostics.

converter string = "OfficeIMO.Pdf" optional

Converter or adapter name to place on recorded warnings.

Requests a generated-PDF compliance profile for this document.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile required

Sets or clears the generated AcroForm default text alignment emitted through /Q.

Parameters

alignment OfficeIMO.Pdf.PdfFormFieldTextAlignment? required

Sets or clears the generated catalog page layout.

Parameters

pageLayout OfficeIMO.Pdf.PdfCatalogPageLayout? required

Sets or clears the generated catalog page mode.

Parameters

pageMode OfficeIMO.Pdf.PdfCatalogPageMode? required

Sets or clears the generated catalog URI base used by viewers to resolve relative URI actions.

Parameters

uriBase string? required

Sets generated catalog page mode and page layout viewer hints.

Parameters

pageMode OfficeIMO.Pdf.PdfCatalogPageMode? = null optional

pageLayout OfficeIMO.Pdf.PdfCatalogPageLayout? = null optional

Sets the default style for a built-in heading level.

Parameters

level int required

style OfficeIMO.Pdf.PdfHeadingStyle required

Sets the modification date emitted in the embedded-file stream parameters for an existing attachment.

Parameters

fileName string required

modificationDate System.DateTimeOffset required

Sets the PDF file header version emitted for generated documents.

Parameters

version OfficeIMO.Pdf.PdfFileVersion required

Enables or disables flattening generated FreeText and Highlight annotations into page content.

Parameters

flatten bool = true optional

Sets or clears the generated catalog document language.

Parameters

language string? required

Sets the generated catalog open action to a page destination.

Parameters

pageNumber int = 1 optional

destinationTop double? = null optional

destinationMode OfficeIMO.Pdf.PdfOpenActionDestinationMode = Xyz optional

destinationLeft double? = null optional

destinationBottom double? = null optional

destinationRight double? = null optional

Enables or disables generated catalog page labels.

Parameters

include bool = true optional

prefix string? = null optional

Sets PDF/X identification metadata.

Parameters

identification OfficeIMO.Pdf.PdfXIdentification? required

Sets a PDF/X output intent from a caller-supplied CMYK print-condition ICC profile.

Parameters

iccProfile byte[] required

outputConditionIdentifier string required

Sets explicit PDF/X production timestamps and identity for reproducible generation.

Parameters

metadata OfficeIMO.Pdf.PdfXProductionMetadata? required

Configures the generated embedded files as a document portfolio.

Parameters

portfolio OfficeIMO.Pdf.PdfPortfolioOptions required

Sets the generated catalog output intent to OfficeIMO's built-in sRGB IEC61966-2.1 ICC profile.

Sets the generated tagged-PDF groundwork mode.

Parameters

mode OfficeIMO.Pdf.PdfTaggedStructureMode required

Sets or clears the callback used to provide preferred break positions for long unspaced tokens.

Parameters

callback OfficeIMO.Pdf.PdfTextHyphenationCallback? required

Callback returning UTF-16 break indexes for a token, or null to disable the hook.

Sets or clears the callback used to provide preferred non-hyphenating break positions for long unspaced tokens.

Parameters

callback System.Func<string, System.Collections.Generic.IReadOnlyList<int>>? required

Callback returning UTF-16 break indexes for a token, or null to disable the hook.

Sets the dependency-free generated text shaping mode used by embedded font output.

Parameters

mode OfficeIMO.Pdf.PdfTextShapingMode required

Shaping mode to apply when writing generated text with embedded fonts.

Sets or clears the host-provided shaping engine used for generated text written with embedded fonts.

Parameters

provider OfficeIMO.Drawing.IOfficeTextShapingProvider? required

Provider that returns shaped glyph runs, or null to use only built-in shaping.

Sets the print trapping status written to the document information dictionary.

Parameters

status OfficeIMO.Pdf.PdfTrappingStatus? required

Sets or clears generated catalog viewer preferences.

Parameters

preferences OfficeIMO.Pdf.PdfViewerPreferencesOptions? required

Attempts to register the shared document monospace fallback family for generated PDF code/preformatted text.

Parameters

requireEmbeddedFont bool = false optional

When true, returns true only when an installed monospace fallback face was embedded.

Tries to register generated-text fallback fonts from installed system font families without requiring callers to choose PDF font slots. Existing explicit PdfCreateOptions.EmbeddedFontFallbacks are preserved.

Parameters

familyNames string? required

System font family candidates, for example Segoe UI Emoji, Noto Emoji, DejaVu Sans.

maxFallbackFonts int = 2 optional

Maximum number of installed fallback font families to register.

Loads and registers the first installed family in an Office/CSS family list.

Parameters

familyNames string? required

Comma- or semicolon-separated installed family candidates.

registeredFamilyName string? required

The registered installed family name when successful.

Attempts to configure the shared document Unicode font fallback family for generated PDF text.

Parameters

requireEmbeddedFont bool = true optional

When true, returns true only when an installed fallback face was embedded.

Attempts to use an Office-style font family name and reports whether the generated PDF text font state changed.

Parameters

familyName string? required

Office, CSS, or system font family name such as Aptos, Calibri, or Consolas.

embedSystemFont bool = true optional

When true, installed TrueType faces are preferred over dependency-free standard PDF font aliases.

requireEmbeddedFont bool = false optional

When true, returns true only when the selected default generated font family has an embedded font mapping.

Hyphenates words at line ends with the embedded Liang patterns (US English and reformed German).

Parameters

language string? = null optional

A supported tag such as en-US or de-DE; null uses PdfCreateOptions.Language at layout time.

Registers generated-text fallback fonts by resolving an Office-style comma/semicolon-separated system font family list. Callers do not need to choose PDF standard-font slots; OfficeIMO selects available slots and preserves explicit fallback sets.

Parameters

familyNames string? required

System font family candidates, for example Segoe UI Emoji, Noto Emoji, DejaVu Sans.

maxFallbackFonts int = 2 optional

Maximum number of installed fallback font families to register.

Applies Factur-X/ZUGFeRD PDF/A-3 groundwork and attaches the CrossIndustryInvoice XML payload.

Parameters

ciiXml byte[] required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

textFallbacks OfficeIMO.Pdf.PdfTextFallbackFeatures = DocumentFont optional

Attaches a snapshot of an invoice document using the existing Factur-X PDF/A-3 groundwork. This does not render invoice content or certify agreement between visible content and XML. The profile is inferred from the XML unless explicitly supplied; conflicting declarations are rejected. The caller must still validate the resulting PDF and invoice together.

Parameters

invoice OfficeIMO.Pdf.PdfCiiInvoiceDocument required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

textFallbacks OfficeIMO.Pdf.PdfTextFallbackFeatures = DocumentFont optional

Applies Factur-X/ZUGFeRD PDF/A-3 groundwork from a CrossIndustryInvoice XML file.

Parameters

ciiXmlPath string required

conformanceLevel string? = null optional

version string = "1.0" optional

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship = Data optional

description string? = "Factur-X/ZUGFeRD invoice XML" optional

textFallbacks OfficeIMO.Pdf.PdfTextFallbackFeatures = DocumentFont optional

Uses the shared dependency-light Drawing provider for bounded Arabic joining and bidirectional text.

Uses an Office-style font family name for generated text, embedding the installed TrueType family when it is available and otherwise falling back to the nearest PDF standard family.

Parameters

familyName string? required

Office, CSS, or system font family name such as Aptos, Calibri, or Consolas.

embedSystemFont bool = true optional

When true, installed TrueType faces are preferred over dependency-free standard PDF font aliases.

Configures PDF/A generation and enables strict generation and saved-artifact checks. Call ConfigurePdfAGroundwork for metadata-only preparation without the strict gate.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile = PdfA3B optional

language string = "en-US" optional

Configures PDF/UA generation and enables strict generation and saved-artifact checks. Call ConfigurePdfUaGroundwork for metadata-only preparation without the strict gate.

Parameters

profile OfficeIMO.Pdf.PdfComplianceProfile = PdfUa1 optional

language string = "en-US" optional

Applies the text and font resources from a shared OfficeIMO rendering profile.

Parameters

profile OfficeIMO.Drawing.OfficeRenderingProfile required

Shared rendering profile.

mode OfficeIMO.Drawing.OfficeRenderingProfileApplyMode = Replace optional

Whether profile-owned resources replace or overlay existing PDF settings.

Applies OfficeIMO's built-in generated-text fallback groups without requiring callers to manually assign fallback font slots.

Parameters

features OfficeIMO.Pdf.PdfTextFallbackFeatures = Default optional

Fallback groups to enable. The default enables document, monospace, symbol, and emoji fallbacks.

Uses or clears an immutable first-party word hyphenation dictionary.

Parameters

dictionary OfficeIMO.Pdf.PdfHyphenationLexicon? required

Dictionary whose breakpoints should be used, or null to clear hyphenation.

Maximum payload bytes in each catalog attachment admitted or attachment emitted by this generated document. Defaults to 128 MiB.

Maximum aggregate catalog payload bytes admitted and distinct attachment payload bytes emitted by this generated document. Defaults to 256 MiB.

Embedded files associated with the generated document catalog.

Optional maximum number of pages generated during PDF layout.

Optional maximum number of bytes serialized for a generated PDF.

When true (the default), generated page content streams are written with Flate compression.

Controls whether completed indirect objects are buffered or emitted once in forward-only order.

Maximum serialized-object bytes retained in memory while saving. Zero spills every completed object to temporary storage.

Maximum completed page-content bytes retained during layout. Zero spills every completed page and effect stream to temporary storage.

When true, generated standard-font resources include WinAnsi-to-Unicode CMaps for stronger extraction and compliance groundwork.

When true, embedded TrueType font file streams are Flate-compressed while preserving their original /Length1 metadata.

When true, generated PDFs include a catalog XMP metadata stream synchronized with document Info metadata.

When true, generated PDFs include catalog page labels that match the configured page-number style and start number.

When true, generated FreeText and Highlight annotations are painted into page content instead of emitted as interactive annotations.

Optional catalog page-label prefix, for example "A-" or "Appendix ". Requires PdfCreateOptions.IncludePageLabels to be emitted.

Generated catalog page-label rules, ordered by their one-based start page number.

PDF file header version emitted for generated documents.

Requested generated-PDF compliance profile. Non-None profiles are validated strictly and fail until their required primitives are implemented.

Optional PDF/A XMP identification metadata. This does not by itself certify PDF/A conformance.

Optional PDF/UA XMP identification metadata. This does not by itself certify PDF/UA conformance.

Optional Factur-X/ZUGFeRD XMP extension metadata. This does not by itself certify e-invoice conformance.

Optional generated catalog output intent backed by an ICC profile.

Controls catalog-level tagged-PDF groundwork emitted for accessibility-oriented profiles.

Optional document language for the generated catalog /Lang entry, for example "en-US".

Optional catalog page mode emitted for generated PDFs.

Optional catalog page layout emitted for generated PDFs.

Optional generated catalog open action controlling the initial page destination.

Optional simple viewer preferences emitted through the generated catalog.

Optional catalog URI base used by viewers to resolve relative URI actions.

Optional Standard password security for generated PDFs.

Optional AcroForm default text alignment emitted as catalog-level /Q quadding.

Optional document portfolio configuration for the generated embedded files.

Embedded TrueType font mappings keyed by generated standard-font slot.

Page background for new composition. An explicit null keeps the page transparent.

Optional reusable text watermark rendered behind all page content.

Optional first-page text watermark rendered behind page content when first-page variants are enabled.

Optional even-page text watermark rendered behind page content when odd/even variants are enabled.

Optional reusable image watermark rendered behind all page content.

Optional first-page image watermark rendered behind page content when first-page variants are enabled.

Optional even-page image watermark rendered behind page content when odd/even variants are enabled.

Optional reusable page border rendered as a page decoration.

Optional reusable page background image rendered behind all page content.

Optional reusable page background shapes rendered behind all page content.

When true (the default), text set in a standard font slot (Helvetica, Times or Courier) that has no registered font file uses an installed font resolved through the default theme's fallback lists, embedded as a subset: the body font for Helvetica, the serif chain for Times and the monospace chain for Courier. When no font file can be found the standard font is written without embedding and a font-not-embedded diagnostic is reported. Set to false to write the non-embedded standard PDF fonts.

Embedded font fallback set used to split generated rich text runs that cannot be written by their selected font.

Configured source-to-embedded font substitutions ordered by source family.

First visible page number for this document or section flow. Default 1.

Visible numbering style for generated page tokens. Default Arabic.

Optional placement-aware image optimization used while generating image XObjects. The value is snapshotted; optimization is disabled when this option is null or disabled.

Embedded named font families available to run-level text without consuming a standard-font slot.

Supplies defaults for new PDF composition. Null selects OfficeTheme.Default. Explicit option styles, fonts and sizes, and block/run formatting take precedence. Loading a PDF and source-format layout imports do not apply this theme.

Uses the page number continuing the preceding group for start parity. Numbering restarts are applied after padding. Default is false, which uses the physical page index.

Optional start parity for a composed page or section. Uses the physical page index unless PdfCreateOptions.UseContinuingPageNumberForStartParity is enabled. A blank page is inserted before a later section when needed; the first section starts without padding.

Page size, margins, orientation and running headers and footers of these options.

Optional PDF/X identification metadata written to XMP.

Production timestamps and identity reconciled between the PDF Info dictionary and XMP packet.

Optional print trapping status written to the document information dictionary.

Converts generated text and vector RGB color operators through the configured PDF/X CMYK output profile.

Converts supported generated raster images through the configured PDF/X CMYK output profile.

Flattens raster alpha against PdfCreateOptions.PdfXTransparencyBackground during CMYK conversion.

Background used when raster transparency is flattened for PDF/X-1a.

ICC rendering intent used for generated vector and text color conversion.

Black-preservation policy used for generated vector and text color conversion.

Optional TrimBox and BleedBox policy for generated print-production pages.

Default standard font used for paragraphs.

Gets whether the default paragraph font slot was explicitly supplied by the caller or a theme.

Default paragraph font size; new composition inherits the theme body size unless assigned.

Default text color for blocks when none is specified.

Default paragraph style applied when a paragraph does not specify its own style.

Default table style applied when none is provided. When not assigned, the style comes from PdfCreateOptions.Theme.

Gets whether PdfCreateOptions.DefaultTableStyle was explicitly supplied by the caller or a theme.

Default heading styles applied when H1/H2/H3 blocks do not specify their own style. When not assigned, the styles come from PdfCreateOptions.Theme.

Default list style applied when bullet and numbered lists do not specify their own style. When not assigned, the style comes from PdfCreateOptions.Theme.

Default panel style applied when panel paragraphs do not specify their own style.

Default horizontal rule style applied when horizontal rules do not specify their own style.

Default image placement style applied when images do not specify their own style.

Default placement style for OfficeIMO.Drawing-backed flow objects.

Default row/column layout style applied when rows do not specify their own style.

Optional debug overlays (margins, baselines, boxes).

When true, H1/H2/H3 blocks are written as PDF outline/bookmark entries.

Highest outline level expanded when generated heading outlines are opened in a PDF reader. Defaults to all levels. Set to 0 to show only top-level entries with children collapsed.

Applies pair kerning to text without explicit run features: OpenType GPOS/kern pairs for embedded fonts and Adobe AFM pairs for the standard Helvetica and Times fonts. The default is true. Setting false restores nominal glyph advances; runs with explicit features keep their own kern value.

Controls ordinary spaces in flow text. The default is PdfTextWhitespaceMode.Collapse.

Retains leading and repeated spaces. Setting true selects literal PdfTextWhitespaceMode.Preformatted layout; setting false selects PdfTextWhitespaceMode.Collapse.

Dependency-free generated text shaping mode used by embedded TrueType and OpenType/CFF font output.

Optional host-provided shaping engine for embedded-font text runs that need script shaping, bidirectional layout, or glyph substitution beyond the built-in dependency-free modes.

Optional callback used to provide preferred break positions for long unspaced tokens during generated text wrapping.

Optional callback used to provide preferred non-hyphenating break positions for long unspaced tokens during generated text wrapping.

Default installed multilingual family candidates used by document converters for CJK, Arabic, and other non-Latin generated PDF text.

Default installed symbol and emoji family candidates used by document converters for generated PDF text fallback runs.

Default installed sans-serif family candidates used by document converters when they need Unicode-capable generated PDF text.

Default installed monospace family candidates used by document converters for code and preformatted text.