API Reference
PdfDocumentForms
Fluent simple AcroForm operations for a PdfDocument.
Inheritance
- Object
- PdfDocumentForms
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
- Property PdfDocument.Forms
Accepted by parameters
- Extension method PdfDocumentForms.TryFill
- Extension method PdfDocumentForms.TryFill
- Extension method PdfDocumentForms.TryFillAndFlatten
- Extension method PdfDocumentForms.TryFillAndFlatten
- Extension method PdfDocumentForms.TryFlatten
- Method PdfDocumentFormsCompatibilityExtensions.TryFill
- Method PdfDocumentFormsCompatibilityExtensions.TryFill
- Method PdfDocumentFormsCompatibilityExtensions.TryFillAndFlatten
- Method PdfDocumentFormsCompatibilityExtensions.TryFillAndFlatten
- Method PdfDocumentFormsCompatibilityExtensions.TryFlatten
Methods
public PdfDocument AppendRevision(IReadOnlyDictionary<String, String> fieldValues, Boolean keepNeedAppearances = true) #PdfDocumentAppends a simple AcroForm field-value revision without rewriting the existing PDF bytes.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
- keepNeedAppearances System.Boolean = true
public PdfDocument AppendRevision(IReadOnlyDictionary<String, String> fieldValues, PdfIncrementalFormFieldUpdateOptions formOptions) #PdfDocumentAppends a simple AcroForm field-value revision without rewriting the existing PDF bytes.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
- formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions
public PdfDocument AppendRevision(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, Boolean keepNeedAppearances = true) #PdfDocumentAppends 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}
- keepNeedAppearances System.Boolean = true
public PdfDocument AppendRevision(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfIncrementalFormFieldUpdateOptions formOptions) #PdfDocumentAppends 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}
- formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions
public PdfAcroFormEditResult Edit(Action<PdfAcroFormEditSession> edit) #PdfAcroFormEditResultTransactionally creates or edits fields, widgets, ordering, and selective flattening.
Parameters
- edit System.Action{OfficeIMO.Pdf.PdfAcroFormEditSession}
public PdfAcroFormEditResult Edit(Action<PdfAcroFormEditSession> edit, PdfFormFillerOptions appearanceOptions) #PdfAcroFormEditResultTransactionally creates or edits fields using the configured embedded-font policy for generated appearances.
Parameters
- edit System.Action{OfficeIMO.Pdf.PdfAcroFormEditSession}
- appearanceOptions OfficeIMO.Pdf.PdfFormFillerOptions
public PdfFormDataSet ExportData() #PdfFormDataSetExports readable field values as a typed data set.
public PdfDocument Fill(IReadOnlyDictionary<String, String> fieldValues) #PdfDocumentCreates a new PDF with simple form fields filled.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
public PdfDocument Fill(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #PdfDocumentCreates a new PDF with simple form fields filled.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public PdfDocument Fill(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues) #PdfDocumentCreates a new PDF with simple form fields filled, including multi-value fields.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,OfficeIMO.Pdf.PdfFormFieldValue}
public PdfDocument Fill(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #PdfDocumentCreates a new PDF with simple form fields filled, including multi-value fields.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,OfficeIMO.Pdf.PdfFormFieldValue}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, String> fieldValues) #PdfDocumentCreates a new PDF with simple form fields filled and flattened.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #PdfDocumentCreates a new PDF with simple form fields filled and flattened.
Parameters
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues) #PdfDocumentCreates 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}
public PdfDocument FillAndFlatten(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #PdfDocumentCreates 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}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public PdfDocument Flatten() #PdfDocumentCreates a new PDF with simple form fields flattened.
public PdfDocument Flatten(PdfFormFillerOptions formOptions) #PdfDocumentCreates a new PDF with simple form fields flattened.
Parameters
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public PdfDocument Flatten(params String[] fieldNames) #PdfDocumentCreates a new PDF with only the named simple form fields flattened.
Parameters
- fieldNames System.String[]
public PdfDocument Flatten(IReadOnlyCollection<String> fieldNames, PdfFormFillerOptions formOptions) #PdfDocumentCreates a new PDF with only the named simple form fields flattened.
Parameters
- fieldNames System.Collections.Generic.IReadOnlyCollection{System.String}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public PdfDocument ImportData(PdfFormDataSet data, PdfFormFillerOptions options = null) #PdfDocumentImports a typed data set through the validated form filler.
Parameters
- data OfficeIMO.Pdf.PdfFormDataSet
- options OfficeIMO.Pdf.PdfFormFillerOptions = null
public PdfDocument ImportXfdf(String xfdf, PdfFormFillerOptions options = null) #PdfDocumentImports XFDF through the validated form filler.
Parameters
- xfdf System.String
- options OfficeIMO.Pdf.PdfFormFillerOptions = null
public PdfOperationResult<PdfDocument> TryAppendRevision(IReadOnlyDictionary<String, String> fieldValues, Boolean keepNeedAppearances = true, PdfLoadOptions options = null) #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}
- keepNeedAppearances System.Boolean = true
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<PdfDocument> TryAppendRevision(IReadOnlyDictionary<String, String> fieldValues, PdfIncrementalFormFieldUpdateOptions formOptions, PdfLoadOptions readOptions) #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}
- formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions
public PdfOperationResult<PdfDocument> TryAppendRevision(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, Boolean keepNeedAppearances = true, PdfLoadOptions options = null) #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}
- keepNeedAppearances System.Boolean = true
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<PdfDocument> TryAppendRevision(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfIncrementalFormFieldUpdateOptions formOptions, PdfLoadOptions readOptions) #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}
- formOptions OfficeIMO.Pdf.PdfIncrementalFormFieldUpdateOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions
public PdfOperationResult<PdfDocument> TryFill(IReadOnlyDictionary<String, String> fieldValues, PdfLoadOptions options = null) #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}
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<PdfDocument> TryFill(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions readOptions) #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}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions
public PdfOperationResult<PdfDocument> TryFill(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfLoadOptions options = null) #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}
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<PdfDocument> TryFill(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions readOptions) #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}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions
public PdfOperationResult<PdfDocument> TryFillAndFlatten(IReadOnlyDictionary<String, String> fieldValues, PdfLoadOptions options = null) #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}
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<PdfDocument> TryFillAndFlatten(IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions readOptions) #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}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions
public PdfOperationResult<PdfDocument> TryFillAndFlatten(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfLoadOptions options = null) #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}
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<PdfDocument> TryFillAndFlatten(IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions, PdfLoadOptions readOptions) #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}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions
public PdfOperationResult<PdfDocument> TryFlatten(PdfLoadOptions options = null) #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
public PdfOperationResult<PdfDocument> TryFlatten(PdfFormFillerOptions formOptions, PdfLoadOptions readOptions) #PdfOperationResult<PdfDocument>Attempts to create a new PDF with simple form fields flattened, returning diagnostics when blocked or failed.
Parameters
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Extension Methods
public static PdfOperationResult<PdfDocument> TryFill(PdfDocumentForms forms, IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #PdfOperationResult<PdfDocument>Attempts to fill string form values with explicit form options.
Parameters
- forms OfficeIMO.Pdf.PdfDocumentForms
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public static PdfOperationResult<PdfDocument> TryFill(PdfDocumentForms forms, IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #PdfOperationResult<PdfDocument>Attempts to fill typed form values with explicit form options.
Parameters
- forms OfficeIMO.Pdf.PdfDocumentForms
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,OfficeIMO.Pdf.PdfFormFieldValue}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public static PdfOperationResult<PdfDocument> TryFillAndFlatten(PdfDocumentForms forms, IReadOnlyDictionary<String, String> fieldValues, PdfFormFillerOptions formOptions) #PdfOperationResult<PdfDocument>Attempts to fill and flatten string form values with explicit form options.
Parameters
- forms OfficeIMO.Pdf.PdfDocumentForms
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public static PdfOperationResult<PdfDocument> TryFillAndFlatten(PdfDocumentForms forms, IReadOnlyDictionary<String, PdfFormFieldValue> fieldValues, PdfFormFillerOptions formOptions) #PdfOperationResult<PdfDocument>Attempts to fill and flatten typed form values with explicit form options.
Parameters
- forms OfficeIMO.Pdf.PdfDocumentForms
- fieldValues System.Collections.Generic.IReadOnlyDictionary{System.String,OfficeIMO.Pdf.PdfFormFieldValue}
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions
public static PdfOperationResult<PdfDocument> TryFlatten(PdfDocumentForms forms, PdfFormFillerOptions formOptions) #PdfOperationResult<PdfDocument>Attempts to flatten form fields with explicit form options.
Parameters
- forms OfficeIMO.Pdf.PdfDocumentForms
- formOptions OfficeIMO.Pdf.PdfFormFillerOptions