Skip to content

# PDFTextBoxField

Namespace: O2S.Components.PDF4NET.Forms

Defines an interactive Acrobat textbox field.

    public class PDFTextBoxField : PDFField

Inheritance Object → PDFField → PDFTextBoxField

## Constructors

### PDFTextBoxField(String)

Initializes a new PDFTextBoxField object.

    public PDFTextBoxField(string name)

Parameters

`name` String
The field name.

## Properties

### AlternateName

Gets or sets the field alternate name.

    public string AlternateName { get; set; }

Property Value

String
An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface.

### CalculateAction

Gets or sets the calculate action.

    public PDFJavaScriptAction CalculateAction { get; set; }

Property Value

PDFJavaScriptAction
A PDFJavaScriptAction that shall be performed to recalculate the value of this field when that of another field changes.

### Comb

Gets or sets a value indicating whether the field is a comb.

    public bool Comb { get; set; }

Property Value

Boolean
If true, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of PDFTextBoxField.MaxLength, and the text is laid out into those combs.

### CosDictionary

Gets the underlying COS object.

    public PDFCosDictionary CosDictionary { get; }

Property Value

PDFCosDictionary
A PDFCosDictionary object that backs this field object.

### DefaultValue

Gets or sets the field default value.

    public object DefaultValue { get; set; }

Property Value

Object
The field's default value.

### Export

Gets or sets a value indicating whether the field can be exported or not.

    public bool Export { get; set; }

Property Value

Boolean
If true, the field shall be exported by a submit-form action.

### FileSelect

Gets or sets a value indicating whether the field acts as a file selector.

    public bool FileSelect { get; set; }

Property Value

Boolean
If true, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.

### Form

Gets the Acrobat form this field belongs to.

    public PDFForm Form { get; internal set; }

Property Value

PDFForm
The parent form of the field.

### FormatAction

Gets or sets the format action.

    public PDFJavaScriptAction FormatAction { get; set; }

Property Value

PDFJavaScriptAction
A PDFJavaScriptAction that shall be performed before the field is formatted to display its value.

### KeyPressAction

Gets or sets the keypress action.

    public PDFJavaScriptAction KeyPressAction { get; set; }

Property Value

PDFJavaScriptAction
A PDFJavaScriptAction that shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box.

### MappingName

Gets or sets the field mapping name.

    public string MappingName { get; set; }

Property Value

String
The mapping name that shall be used when exporting interactive form field data from the document.

### MaxLength

Gets or sets the maximum length of the field text.

    public int MaxLength { get; set; }

Property Value

Int32
The maximum length of the field's text, in characters.

### Multiline

Gets or sets a value indicating whether the field is multiline.

    public bool Multiline { get; set; }

Property Value

Boolean
If true, the field may contain multiple lines of text; if false, the field's text shall be restricted to a single line.

### Name

Gets or sets the field name.

    public string Name { get; set; }

Property Value

String
The name of the field.

Exceptions

ArgumentException
Thrown when the name is not valid (null, empty, unsupported characters).

### Password

Gets or sets a value indicating whether the field is intended for entering a secure password.

    public bool Password { get; set; }

Property Value

Boolean
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 shall instead be echoed in some unreadable form, such as asterisks or bullet characters.

### ReadOnly

Gets or sets a value indicating whether the field is read-only.

    public bool ReadOnly { get; set; }

Property Value

Boolean
If true, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions.

### Required

Gets or sets a value indicating whether the field is required.

    public bool Required { get; set; }

Property Value

Boolean
If true, the field shall have a value at the time it is exported by a submit-form action

### Scroll

Gets or sets a value indicating whether the field text supports scrolling.

    public bool Scroll { get; set; }

Property Value

Boolean
If false, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling; for non-interactive form filling, the filler should take care not to add more character than will visibly fit in the defined area.

### SpellCheck

Gets or sets a value indicating whether the field text shall be spell-checked.

    public bool SpellCheck { get; set; }

Property Value

Boolean
If true, text entered in the field shall be spell-checked.

### Text

Gets or sets the field value.

    public string Text { get; set; }

Property Value

String
A string that represents the field content.

### TextDirection

Gets or sets the text direction.

    public PDFTextDirection TextDirection { get; set; }

Property Value

PDFTextDirection
A PDFTextDirection enum member specifying the direction of the text displayed in the field.

### Type

Gets the field type.

    public PDFFieldType Type { get; internal set; }

Property Value

PDFFieldType
The field type.

### ValidateAction

Gets or sets the validate action.

    public PDFJavaScriptAction ValidateAction { get; set; }

Property Value

PDFJavaScriptAction
A PDFJavaScriptAction that shall be performed when the field's value is changed. This action may check the new value for validity.

### Value

Gets or sets the field value.

    public object Value { get; set; }

Property Value

Object
The field value.

### Widgets

Gets the list of field widgets.

    public PDFFieldWidgetCollection Widgets { get; }

Property Value

PDFFieldWidgetCollection
The list of widgets that represent the field on PDF pages.