Class SignatureFormField
A filed that contains a ink signature.
Inheritance
System.Object
SignatureFormField
Implements
Namespace: PSPDFKit.Pdf.Form
Assembly: PSPDFKit.dll
Syntax
public sealed class SignatureFormField : IFormField
Properties
AnnotationIDs
A list of Id.
Declaration
public IList<string> AnnotationIDs { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
Label
Used to identify the form field in the UI or for accessibility.
Declaration
public string Label { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Name
Unique name of the form field (often referred to as fully qualified name). This name is used to link Widget annotations and is also used as an identifier for form field values.
Declaration
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
NoExport
Determines if the form field will appear in the serialized payload of a form submission. Defaults to false.
Declaration
public bool NoExport { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
PdfObjectId
The object ID of the form field object in the PDF.
Declaration
public int PdfObjectId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
ReadOnly
Read only form fields can not be filled out. Defaults to false.
Declaration
public bool ReadOnly { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Required
Required form fields must be filled out in order to submit the form. Defaults to false.
Declaration
public bool Required { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |