PdfTextBoxField class
Represents text box field in the PDF form.
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.
getter/setter pair
- borderColor ↔ PdfColor
-
Gets or sets the color of the border.
getter/setter pair
- borderStyle ↔ PdfBorderStyle
-
Gets or sets the border style.
getter/setter pair
- borderWidth ↔ int
-
Gets or sets the width of the border.
getter/setter pair
- bounds ↔ Rect
-
Gets or sets the bounds.
getter/setter pairinherited
- canExport ↔ bool
-
Gets or sets a value indicating whether the PdfField is exportable or not.
getter/setter pairinherited
- defaultValue ↔ String
-
Gets or sets the default value.
getter/setter pair
- font ↔ PdfFont
-
Gets or sets the font.
getter/setter pair
- foreColor ↔ PdfColor
-
Gets or sets the color of the text.
getter/setter pair
- form → PdfForm?
-
Gets the form of the PdfField.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- highlightMode ↔ PdfHighlightMode
-
Gets or sets the highlighting mode.
getter/setter pair
- insertSpaces ↔ bool
-
Meaningful only if the maxLength property is set and the multiline, isPassword properties are false.
getter/setter pair
- isPassword ↔ bool
-
Gets or sets a value indicating whether this PdfTextBoxField is password field.
getter/setter pair
- items → PdfFieldItemCollection?
-
Gets the collection of text box field items.
no setter
- mappingName ↔ String
-
Gets or sets the mapping name to be used when exporting interactive form
field data from the document.
getter/setter pairinherited
- maxLength ↔ int
-
Gets or sets the maximum number of characters that can be entered in the text box.
getter/setter pair
- multiline ↔ bool
-
Gets or sets a value indicating whether this PdfTextBoxField is multiline.
getter/setter pair
- name ↔ String?
-
Gets or sets the name of the PdfField.
getter/setter pairinherited
- page → PdfPage?
-
Gets the page of the field.
no setterinherited
- readOnly ↔ bool
-
Gets or sets a value indicating whether this PdfField field is read-only.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollable ↔ bool
-
Gets or sets a value indicating whether this PdfTextBoxField is scrollable.
getter/setter pair
- spellCheck ↔ bool
-
Gets or sets a value indicating whether to check spelling.
getter/setter pair
- tabIndex ↔ int
-
Gets or sets the tab index for form fields.
getter/setter pairinherited
- text ↔ String
-
Gets or sets the text in the text box.
getter/setter pair
- textAlignment ↔ PdfTextAlignment
-
Gets or sets the text alignment.
getter/setter pair
- tooltip ↔ String
-
Gets or sets the tool tip.
getter/setter pairinherited
Methods
-
flatten(
) → void -
Flattens the field.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited