pspdfkit/com.pspdfkit.forms/TextFormElement

TextFormElement

open class TextFormElement : FormElement

Represents a text control in a PDF form. Allows the user to enter custom text.

See also

Functions

Link copied to clipboard
@Nullable
open fun getEditingContents(): String
Returns the editing contents of this form element based on rules in the annotation (including JavaScript).
Link copied to clipboard
@Nullable
open fun getFormattedContents(): String
Returns the formatted contents of this form element based on rules in the annotation (including JavaScript)
Link copied to clipboard
@NonNull
open fun getFormField(): TextFormField
Retrieve parent form field.
Link copied to clipboard
@NonNull
open fun getInputFormat(): TextInputFormat
Input format of this text field.
Link copied to clipboard
@Nullable
open fun getInputFormatString(): String
Input format string of this text field, if any.
Link copied to clipboard
open fun getMaxLength(): Int
Maximum length of text allowed in the text field.
Link copied to clipboard
@Nullable
open fun getRichText(): String
Current rich text value.
Link copied to clipboard
@Nullable
open fun getText(): String
Current text value.
Link copied to clipboard
@NonNull
open fun getType(): FormType
Gets form type for TextFormElement.
Link copied to clipboard
open fun isComb(): Boolean
Returns whether the field shall be automatically divided into as many equally space positions, or combs, as the value of getMaxLength, and the text is laid out into those combs.
Link copied to clipboard
open fun isFileSelect(): Boolean
Returns whether text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.
Link copied to clipboard
open fun isMultiLine(): Boolean
Returns whether text is allowed to have multiple lines or not.
Link copied to clipboard
open fun isPassword(): Boolean
Returns whether text is intended for entering a secure password that should not be visible on the screen.
Link copied to clipboard
open fun isRichText(): Boolean
Returns whether the value of this field can be a rich text string.
Link copied to clipboard
open fun isScrollEnabled(): Boolean
Returns whether the text field can be scrolled (horizontally for single-line fields, vertically for multi-line fields).
Link copied to clipboard
open fun isSpellCheckEnabled(): Boolean
Returns whether text entered in the field shall be spell-checked.
Link copied to clipboard
open fun setRichText(@NonNull richText: String)
Sets the current rich text value.
Link copied to clipboard
open fun setText(@NonNull text: String): Boolean
Sets the current text value.