Azure Connectors Node.js SDK
    Preparing search index...

    Interface UpdateTextBoxFieldRequest

    Definition: UpdateTextBoxFieldRequest

    interface UpdateTextBoxFieldRequest {
        dimensions?: FieldDimension;
        field_name: string;
        field_type: FieldType;
        font?: Font;
        format?: string;
        max_length: number;
        page_no: number;
        placeholder?: string;
        renamed_as?: string;
        validation?: FieldValidationValue;
        validation_rule: ValidationRule;
        value?: string;
    }
    Index
    dimensions?: FieldDimension
    field_name: string

    Current name of the field, that is to be updated.

    field_type: FieldType
    font?: Font
    format?: string

    Text format of the field. Used for the date type field only. Possible values are

    • m/d
    • m/d/yy
    • m/d/yyyy
    • mm/dd/yy
    • mm/dd/yyyy
    • mm/yy
    • mm/yyyy
    • d-mmm
    • d-mmm-yy
    • d-mmm-yyyy
    • dd-mmm-yy
    • dd-mmm-yyyy
    • yy-mm-dd
    • yyyy-mm-dd
    • mmm-yy
    • mmm-yyyy
    • mmmm-yy
    • mmmm-yyyy
    • mmmm d, yyyy
    • dd/mm/yy
    • ddmmmyyyy
    max_length: number

    Maximum length of the value allowed in the field. Must between 1 - 9999

    page_no: number

    Page number on which the field is to be created.

    placeholder?: string

    Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.

    renamed_as?: string

    Updated name of the field if renaming is intended.

    validation_rule: ValidationRule
    value?: string

    Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.