Table of Contents

Class AcroTextField

Namespace
UglyToad.PdfPig.AcroForms.Fields
Assembly
UglyToad.PdfPig.dll

A text field is a box or space in which the user can enter text from the keyboard. The text may be restricted to a single line or may be permitted to span multiple lines.

public class AcroTextField : AcroFieldBase
Inheritance
AcroTextField
Inherited Members
Extension Methods

Constructors

AcroTextField(DictionaryToken, string, AcroTextFieldFlags, AcroFieldCommonInformation, string, int?, int?, PdfRectangle?)

Create a new AcroTextField.

public AcroTextField(DictionaryToken dictionary, string fieldType, AcroTextFieldFlags fieldFlags, AcroFieldCommonInformation information, string value, int? maxLength, int? pageNumber, PdfRectangle? bounds)

Parameters

dictionary DictionaryToken

The dictionary for this field.

fieldType string

The type of this field, must be Ch.

fieldFlags AcroTextFieldFlags

The flags specifying behaviour for this field.

information AcroFieldCommonInformation

Additional information for this field.

value string

The text value.

maxLength int?

The maximum length.

pageNumber int?

The number of the page this field appears on.

bounds PdfRectangle?

The location of this field on the page.

Properties

Flags

The flags specifying the behaviour of this field.

public AcroTextFieldFlags Flags { get; }

Property Value

AcroTextFieldFlags

IsMultiline

Whether the field allows multiline text.

public bool IsMultiline { get; }

Property Value

bool

IsRichText

Whether the field supports rich text content.

public bool IsRichText { get; }

Property Value

bool

MaxLength

The optional maximum length of the text field.

public int? MaxLength { get; }

Property Value

int?

Value

The value of the text in this text field. This can be null if no value has been set.

public string Value { get; }

Property Value

string

Methods

ToString() 

public override string ToString()

Returns

string