Get Started

API Reference

Class

PdfFormFillerOptions

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:10
Modifiers sealed

Options used when updating or flattening parsed AcroForm fields.

Inheritance

  • Object
  • PdfFormFillerOptions

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

Accepted by parameters

Constructors

Methods

public PdfFormFillerOptions ReportDiagnosticsTo(PdfConversionReport report, String converter = "OfficeIMO.Pdf") #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:100
Returns: PdfFormFillerOptions

Records structured text diagnostics encountered while synthesizing form appearances.

Parameters

report OfficeIMO.Pdf.PdfConversionReport requiredposition: 0
Mutable conversion report that receives missing-glyph, shaping, and embedded appearance-font diagnostics.
converter System.String = "OfficeIMO.Pdf" optionalposition: 1
Converter or adapter name to place on recorded warnings.

Returns

The current options instance for fluent configuration.

public PdfFormFillerOptions UseAppearanceFont(String familyName, Byte[] regular) #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:113
Returns: PdfFormFillerOptions

Registers a single regular TrueType or OpenType/CFF font face for synthesized text appearances.

Parameters

familyName System.String requiredposition: 0
PDF font family name to expose in synthesized resources.
regular System.Byte[] requiredposition: 1
Regular TrueType or OpenType/CFF font bytes.

Returns

The current options instance for fluent configuration.

public PdfFormFillerOptions UseAppearanceFontFallbacks(PdfEmbeddedFontFallbackSet fallbackSet) #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:87
Returns: PdfFormFillerOptions

Registers prioritized fallback fonts for synthesized text appearances.

Parameters

fallbackSet OfficeIMO.Pdf.PdfEmbeddedFontFallbackSet requiredposition: 0
Fallback set used when the preferred appearance font cannot cover the field value.

Returns

The current options instance for fluent configuration.

public PdfFormFillerOptions UseAppearanceFontFamily(PdfEmbeddedFontFamily fontFamily) #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:76
Returns: PdfFormFillerOptions

Registers a TrueType font family for synthesized text appearances.

Parameters

fontFamily OfficeIMO.Pdf.PdfEmbeddedFontFamily requiredposition: 0
Font family to embed into synthesized appearance streams.

Returns

The current options instance for fluent configuration.

public PdfFormFillerOptions UseAppearanceFontFile(String familyName, String regularPath) #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:124
Returns: PdfFormFillerOptions

Registers a single regular TrueType or OpenType/CFF font file for synthesized text appearances.

Parameters

familyName System.String requiredposition: 0
PDF font family name to expose in synthesized resources.
regularPath System.String requiredposition: 1
Path to a regular TrueType or OpenType/CFF font file.

Returns

The current options instance for fluent configuration.

Properties

public Boolean KeepNeedAppearances { get; set; } #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:16

When true, keeps the AcroForm /NeedAppearances flag set after filling fields for legacy viewers that ignore normal appearance streams.

public PdfEmbeddedFontFamily AppearanceFontFamily { get; set; } #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:22

Optional TrueType font family used to synthesize embedded Unicode text appearances when a parsed PDF does not already provide a reusable embedded appearance font.

public PdfEmbeddedFontFallbackSet AppearanceFontFallbacks { get; set; } #
OfficeIMO.Pdf/Manipulation/PdfFormFillerOptions.cs:30

Optional prioritized fallback set used to synthesize embedded Unicode text appearances when the preferred appearance font cannot cover the field value.