DsPdfJS API - v9.1.0
    Preparing search index...

    Type Alias TextFieldBaseProperties

    TextFieldBaseProperties: FieldBaseProperties & {
        defaultValue?: string;
        maxLen?: number;
        multiline?: boolean;
        password?: boolean;
        rect?: Rect;
        richText?: boolean;
        scrollable?: boolean;
        spellCheck?: boolean;
        value?: string;
        widget?: WidgetAnnotation | WidgetProperties;
    }

    Defines common properties for TextField and CombTextField.

    Type Declaration

    • OptionaldefaultValue?: string

      The default value of the field, applied when the field is reset.

    • OptionalmaxLen?: number

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

    • Optionalmultiline?: boolean

      Indicating whether the field can contain multiple lines of text.

    • Optionalpassword?: boolean

      Indicating whether the field is intended for entering a secure password that should not be echoed visibly to the screen.

    • Optionalrect?: Rect

      Defines the position and dimensions of the field on the page using a bounding rectangle.

      Note: If a widget is specified via the 'widget' property, its 'rect' value takes precedence and will override this rectangle definition.

    • OptionalrichText?: boolean

      Indicating whether the value of this field should be represented as a rich text string.

    • Optionalscrollable?: boolean

      Indicating whether the field is scrollable to accommodate more text than fits within its annotation rectangle.

    • OptionalspellCheck?: boolean

      Indicating whether the text entered in the field is spell-checked.

    • Optionalvalue?: string

      The value of the field.

    • Optionalwidget?: WidgetAnnotation | WidgetProperties

      The widget annotation defining view properties of the checkbox field.