Class TextFormField

A text input element, that can either span a single or multiple lines.

Inheritance

System.Object

TextFormField

Implements

IFormField

Namespace: PSPDFKit.Pdf.Form

Assembly: PSPDFKit.dll

Syntax

public sealed class TextFormField : IFormField

Properties

AnnotationIDs

A list of Id.

Declaration

public IList<string> AnnotationIDs { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Comb

If true, every character will have an input element on their own which is evenly distributed inside the bounding box of the widget annotation. When this is set, the form field must have a MaxLength.

Declaration

public bool Comb { get; set; }

Property Value

Type	Description
System.Boolean

DefaultValue

Similar to the Value property. The default values are only used when a form needs to be reset.

Declaration

public string DefaultValue { get; set; }

Property Value

Type	Description
System.String

DoNotScroll

If true, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation’s rectangle. Once the field is full, no further text is accepted. Default value is null.

Declaration

public bool DoNotScroll { get; set; }

Property Value

Type	Description
System.Boolean

DoNotSpellCheck

If true, text entered in the field is not spell-checked. Default value is false.

Declaration

public bool DoNotSpellCheck { get; set; }

Property Value

Type	Description
System.Boolean

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

MaxLength

The maximum length of the field’s text, in characters. If none is set, the size is not limited. Default value is null.

Declaration

public int? MaxLength { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MultiLine

If true, the field can contain multiple lines of text. Otherwise, the field’s text is restricted to a single line. Default value is false.

Declaration

public bool MultiLine { get; set; }

Property Value

Type	Description
System.Boolean

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

Password

If true, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters. This is currently only support for single line text inputs. Default value is false.

Declaration

public bool Password { 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

Value

The selected form option value.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String

Implements

IFormField