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

    Definition: TextBoxFieldRequest

    interface TextBoxFieldRequest {
        dimensions: FieldDimension;
        field_name?: string;
        field_type: FieldType;
        font: Font;
        format?: string;
        max_length: number;
        multiline: boolean;
        order: number;
        page_no: number;
        placeholder?: string;
        type: TextboxType;
        validation?: FieldValidationValue;
        validation_rule: ValidationRule;
        value?: string;
    }
    Index
    dimensions: FieldDimension
    field_name?: string

    Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

    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

    multiline: boolean

    If set to true, text area field would be created

    order: number

    The order of the user in workflow for which the field is being added.

    page_no: number

    Page number on which the field is to be created.

    placeholder?: string

    Placeholder text for the text field. For name, email, company, job title and date, placeholder value can be "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Developers can send their own placeholders to overwrite the default values. For "TEXT" developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.

    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.