Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

PdfDocumentForms

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Source PdfDocumentForms.cs:18
Modifiers sealed

Fluent simple AcroForm operations for a PdfDocument.

Inheritance

  • Object
  • PdfDocumentForms

Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 6

Methods

AppendRevision 4 overloads
public PdfDocument AppendRevision(IReadOnlyDictionary<String, String> fieldValues, Boolean keepNeedAppearances = true) #
PdfDocumentForms.cs:125
Returns: PdfDocument

Appends a simple AcroForm field-value revision without rewriting the existing PDF bytes.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
keepNeedAppearances System.Boolean = true optionalposition: 1
public PdfDocument AppendRevision(IReadOnlyDictionary<String, String> fieldValues, PdfIncrementalFormFieldUpdateOptions? formOptions) #
PdfDocumentForms.cs:132
Returns: PdfDocument

Appends a simple AcroForm field-value revision without rewriting the existing PDF bytes.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions? requiredposition: 1
public PdfDocument AppendRevision(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, Boolean keepNeedAppearances = true) #
PdfDocumentForms.cs:169
Returns: PdfDocument

Appends a simple AcroForm field-value revision, including multi-value fields, without rewriting the existing PDF bytes.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
keepNeedAppearances System.Boolean = true optionalposition: 1
public PdfDocument AppendRevision(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfIncrementalFormFieldUpdateOptions? formOptions) #
PdfDocumentForms.cs:176
Returns: PdfDocument

Appends a simple AcroForm field-value revision, including multi-value fields, without rewriting the existing PDF bytes.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions? requiredposition: 1
AppendRevisionResult 4 overloads
public PdfOperationResult<PdfDocument> AppendRevisionResult(IReadOnlyDictionary<String, String> fieldValues, Boolean keepNeedAppearances = true, PdfLoadOptions? options = null) #
PdfDocumentForms.cs:139
Returns: PdfOperationResult<PdfDocument>

Attempts to append a simple AcroForm field-value revision, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
keepNeedAppearances System.Boolean = true optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> AppendRevisionResult(IReadOnlyDictionary<String, String> fieldValues, PdfIncrementalFormFieldUpdateOptions? formOptions, PdfLoadOptions? readOptions) #
PdfDocumentForms.cs:154
Returns: PdfOperationResult<PdfDocument>

Attempts to append a simple AcroForm field-value revision, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions? requiredposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 2
public PdfOperationResult<PdfDocument> AppendRevisionResult(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, Boolean keepNeedAppearances = true, PdfLoadOptions? options = null) #
PdfDocumentForms.cs:183
Returns: PdfOperationResult<PdfDocument>

Attempts to append a simple AcroForm field-value revision, including multi-value fields, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
keepNeedAppearances System.Boolean = true optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> AppendRevisionResult(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfIncrementalFormFieldUpdateOptions? formOptions, PdfLoadOptions? readOptions) #
PdfDocumentForms.cs:198
Returns: PdfOperationResult<PdfDocument>

Attempts to append a simple AcroForm field-value revision, including multi-value fields, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions? requiredposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 2
Edit 2 overloads
public PdfAcroFormEditResult Edit(Action<PdfAcroFormEditSession> edit) #
PdfDocumentForms.cs:316
Returns: PdfAcroFormEditResult

Transactionally creates or edits fields, widgets, ordering, and selective flattening.

Parameters

edit System.Action<OfficeIMO.Pdf.PdfAcroFormEditSession> requiredposition: 0
public PdfAcroFormEditResult Edit(Action<PdfAcroFormEditSession> edit, PdfFormFillerOptions appearanceOptions) #
PdfDocumentForms.cs:320
Returns: PdfAcroFormEditResult

Transactionally creates or edits fields using the configured embedded-font policy for generated appearances.

Parameters

edit System.Action<OfficeIMO.Pdf.PdfAcroFormEditSession> requiredposition: 0
appearanceOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
public PdfFormDataSet ExportData() #
PdfDocumentForms.cs:304
Returns: PdfFormDataSet

Exports readable field values as a typed data set.

public String ExportXfdf() #
PdfDocumentForms.cs:307
Returns: String

Exports readable field values as XFDF.

Fill 4 overloads
public PdfDocument Fill(IReadOnlyDictionary<String, String> fieldValues) #
PdfDocumentForms.cs:31
Returns: PdfDocument

Creates a new PDF with simple form fields filled.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
public PdfDocument Fill(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentForms.cs:38
Returns: PdfDocument

Creates a new PDF with simple form fields filled.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
public PdfDocument Fill(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues) #
PdfDocumentForms.cs:78
Returns: PdfDocument

Creates a new PDF with simple form fields filled, including multi-value fields.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
public PdfDocument Fill(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentForms.cs:85
Returns: PdfDocument

Creates a new PDF with simple form fields filled, including multi-value fields.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
FillAndFlatten 4 overloads
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, String> fieldValues) #
PdfDocumentForms.cs:251
Returns: PdfDocument

Creates a new PDF with simple form fields filled and flattened.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentForms.cs:258
Returns: PdfDocument

Creates a new PDF with simple form fields filled and flattened.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues) #
PdfDocumentForms.cs:279
Returns: PdfDocument

Creates a new PDF with simple form fields filled and flattened, including multi-value fields.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentForms.cs:286
Returns: PdfDocument

Creates a new PDF with simple form fields filled and flattened, including multi-value fields.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
FillAndFlattenResult 4 overloads
public PdfOperationResult<PdfDocument> FillAndFlattenResult(IReadOnlyDictionary<String, String> fieldValues, PdfLoadOptions? options = null) #
PdfDocumentForms.cs:265
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled and flattened, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> FillAndFlattenResult(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions? readOptions) #
PdfDocumentForms.cs:272
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled and flattened, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 2
public PdfOperationResult<PdfDocument> FillAndFlattenResult(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfLoadOptions? options = null) #
PdfDocumentForms.cs:293
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled and flattened, including multi-value fields, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> FillAndFlattenResult(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions? readOptions) #
PdfDocumentForms.cs:300
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled and flattened, including multi-value fields, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 2
FillResult 4 overloads
public PdfOperationResult<PdfDocument> FillResult(IReadOnlyDictionary<String, String> fieldValues, PdfLoadOptions? options = null) #
PdfDocumentForms.cs:45
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> FillResult(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions? readOptions) #
PdfDocumentForms.cs:61
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 2
public PdfOperationResult<PdfDocument> FillResult(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfLoadOptions? options = null) #
PdfDocumentForms.cs:92
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled, including multi-value fields, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> FillResult(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions? readOptions) #
PdfDocumentForms.cs:108
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields filled, including multi-value fields, returning diagnostics when blocked or failed.

Parameters

fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
readOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 2
Flatten 4 overloads
public PdfDocument Flatten() #
PdfDocumentForms.cs:213
Returns: PdfDocument

Creates a new PDF with simple form fields flattened.

public PdfDocument Flatten(PdfFormFillerOptions formOptions) #
PdfDocumentForms.cs:220
Returns: PdfDocument

Creates a new PDF with simple form fields flattened.

Parameters

formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 0
public PdfDocument Flatten(params String[] fieldNames) #
PdfDocumentForms.cs:225
Returns: PdfDocument

Creates a new PDF with only the named simple form fields flattened.

Parameters

fieldNames System.String[] requiredposition: 0
public PdfDocument Flatten(IReadOnlyCollection<String> fieldNames, PdfFormFillerOptions formOptions) #
PdfDocumentForms.cs:230
Returns: PdfDocument

Creates a new PDF with only the named simple form fields flattened.

Parameters

fieldNames System.Collections.Generic.IReadOnlyCollection<System.String> requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1
FlattenResult 2 overloads
public PdfOperationResult<PdfDocument> FlattenResult(PdfLoadOptions? options = null) #
PdfDocumentForms.cs:237
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields flattened, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0
public PdfOperationResult<PdfDocument> FlattenResult(PdfFormFillerOptions formOptions, PdfLoadOptions? readOptions) #
PdfDocumentForms.cs:244
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with simple form fields flattened, returning diagnostics when blocked or failed.

Parameters

formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 0
readOptions OfficeIMO.Pdf.PdfLoadOptions? requiredposition: 1
public PdfFormInteractionInfo GetForInteraction() #
PdfDocumentForms.cs:18
Returns: PdfFormInteractionInfo

Reads the fields and widgets needed to display and fill a form, without extracting page content.

public PdfDocument ImportData(PdfFormDataSet data, PdfFormFillerOptions? options = null) #
PdfDocumentForms.cs:310
Returns: PdfDocument

Imports a typed data set through the validated form filler.

Parameters

data OfficeIMO.Pdf.PdfFormDataSet requiredposition: 0
options OfficeIMO.Pdf.PdfFormFillerOptions? = null optionalposition: 1
public PdfDocument ImportXfdf(String xfdf, PdfFormFillerOptions? options = null) #
PdfDocumentForms.cs:313
Returns: PdfDocument

Imports XFDF through the validated form filler.

Parameters

xfdf System.String requiredposition: 0
options OfficeIMO.Pdf.PdfFormFillerOptions? = null optionalposition: 1
public PdfStaticFormRecognitionReport RecognizeStaticLayout(PdfStaticFormRecognitionOptions? options = null, IReadOnlyList<PdfStaticFormTextEvidence>? ocrText = null, CancellationToken cancellationToken = default) #
PdfDocumentForms.cs:329
Returns: PdfStaticFormRecognitionReport

Proposes fields from static page outlines and labels without changing the document.

Parameters

options OfficeIMO.Pdf.PdfStaticFormRecognitionOptions? = null optionalposition: 0
ocrText System.Collections.Generic.IReadOnlyList<OfficeIMO.Pdf.PdfStaticFormTextEvidence>? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2

Extension Methods

FillAndFlattenResult 2 overloads
public static PdfOperationResult<PdfDocument> FillAndFlattenResult(PdfDocumentForms forms, IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentFormsCompatibilityExtensions.cs:39
Returns: PdfOperationResult<PdfDocument>

Attempts to fill and flatten string form values with explicit form options.

Parameters

forms OfficeIMO.Pdf.PdfDocumentForms requiredposition: 0
fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 1
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 2
public static PdfOperationResult<PdfDocument> FillAndFlattenResult(PdfDocumentForms forms, IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentFormsCompatibilityExtensions.cs:48
Returns: PdfOperationResult<PdfDocument>

Attempts to fill and flatten typed form values with explicit form options.

Parameters

forms OfficeIMO.Pdf.PdfDocumentForms requiredposition: 0
fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 1
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 2
FillResult 2 overloads
public static PdfOperationResult<PdfDocument> FillResult(PdfDocumentForms forms, IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentFormsCompatibilityExtensions.cs:13
Returns: PdfOperationResult<PdfDocument>

Attempts to fill string form values with explicit form options.

Parameters

forms OfficeIMO.Pdf.PdfDocumentForms requiredposition: 0
fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, System.String> requiredposition: 1
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 2
public static PdfOperationResult<PdfDocument> FillResult(PdfDocumentForms forms, IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #
PdfDocumentFormsCompatibilityExtensions.cs:22
Returns: PdfOperationResult<PdfDocument>

Attempts to fill typed form values with explicit form options.

Parameters

forms OfficeIMO.Pdf.PdfDocumentForms requiredposition: 0
fieldValues System.Collections.Generic.IReadOnlyDictionary<System.String, OfficeIMO.Pdf.PdfFormFieldValue> requiredposition: 1
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 2
public static PdfOperationResult<PdfDocument> FlattenResult(PdfDocumentForms forms, PdfFormFillerOptions formOptions) #
PdfDocumentFormsCompatibilityExtensions.cs:30
Returns: PdfOperationResult<PdfDocument>

Attempts to flatten form fields with explicit form options.

Parameters

forms OfficeIMO.Pdf.PdfDocumentForms requiredposition: 0
formOptions OfficeIMO.Pdf.PdfFormFillerOptions requiredposition: 1