Class FormProvider

Handles all form related operations on the owning document. Retrieve it with GetFormProvider().

Inheritance

System.Object

FormProvider

Namespace: PSPDFKit.Forms

Assembly: PSPDFKit.dll

Syntax

public class FormProvider : object

Methods

GetFormFieldValuesJson()

Returns a JSON object that contains all form fields currently loaded and maps to their values.

Each object of the JSON Object will hold a key which is the unique name of the form field (often referred to as fully qualified name) with the value being of json type null, string, or Array.

{ textBox: "Some value", comboBox: ["Off"], anotherField: null }

Declaration

public JObject GetFormFieldValuesJson()

Returns

Type	Description
JObject	A JSON Object holding the current form field key values pairs.

SetFormFieldValuesJson(JObject)

Updates the values of form fields. It's possible to update multiple form fields at once.

Each object of the JSON Object must hold a key which is the unique name of the form field (often referred to as fully qualified name) with the value being of json type null, string, or Array. A null value will reset the form field to either null, or it's default value if available.

{ textBox: "Some value", comboBox: ["Off"], anotherField: null }

Declaration

public void SetFormFieldValuesJson(JObject formFieldValues)

Parameters

Type	Name	Description
JObject	formFieldValues	A JSON Object holding the form field key values pairs to set.