PdfTextBoxField class Null safety

Represents text box field in the PDF form.

Inheritance

Constructors

PdfTextBoxField(PdfPage page, String name, Rect bounds, {PdfFont? font, String? text, String? defaultValue, int maxLength = 0, bool spellCheck = false, bool insertSpaces = false, bool multiline = false, bool isPassword = false, bool scrollable = false, PdfTextAlignment alignment = PdfTextAlignment.left, PdfColor? borderColor, PdfColor? foreColor, PdfColor? backColor, int? borderWidth, PdfHighlightMode highlightMode = PdfHighlightMode.invert, PdfBorderStyle borderStyle = PdfBorderStyle.solid, String? tooltip})
Initializes a new instance of the PdfTextBoxField class with the provided page and name.

Properties

backColor PdfColor
Gets or sets the color of the background. [...]
read / write
borderColor PdfColor
Gets or sets the color of the border. [...]
read / write
borderStyle PdfBorderStyle
Gets or sets the border style. [...]
read / write
borderWidth int
Gets or sets the width of the border. [...]
read / write
bounds Rect
Gets or sets the bounds.
read / write, inherited
canExport bool
Gets or sets a value indicating whether the PdfField is exportable or not. [...]
read / write, inherited
defaultValue String
Gets or sets the default value.
read / write
font PdfFont
Gets or sets the font.
read / write
foreColor PdfColor
Gets or sets the color of the text. [...]
read / write
form PdfForm?
Gets the form of the PdfField.
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
highlightMode PdfHighlightMode
Gets or sets the highlighting mode. [...]
read / write
insertSpaces bool
Meaningful only if the maxLength property is set and the multiline, isPassword properties are false. [...]
read / write
isPassword bool
Gets or sets a value indicating whether this PdfTextBoxField is password field. [...]
read / write
items PdfFieldItemCollection?
Gets the collection of text box field items.
read-only
mappingName String
Gets or sets the mapping name to be used when exporting interactive form field data from the document.
read / write, inherited
maxLength int
Gets or sets the maximum number of characters that can be entered in the text box. [...]
read / write
multiline bool
Gets or sets a value indicating whether this PdfTextBoxField is multiline. [...]
read / write
name String?
Gets or sets the name of the PdfField.
read / write, inherited
page PdfPage?
Gets the page of the field.
read-only, inherited
readOnly bool
Gets or sets a value indicating whether this PdfField field is read-only. [...]
read / write, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
scrollable bool
Gets or sets a value indicating whether this PdfTextBoxField is scrollable. [...]
read / write
spellCheck bool
Gets or sets a value indicating whether to check spelling. [...]
read / write
tabIndex int
Gets or sets the tab index for form fields. [...]
read / write, inherited
text String
Gets or sets the text in the text box.
read / write
textAlignment PdfTextAlignment
Gets or sets the text alignment. [...]
read / write
tooltip String
Gets or sets the tool tip.
read / write, inherited

Methods

flatten() → void
Flattens the field.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited