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

    Definition: TextFieldResponse

    interface TextFieldResponse {
        align?: string;
        border_color?: string;
        color?: string;
        dimensions?: FieldDimenssionResponse;
        display_order: number;
        embedded: boolean;
        field_name?: string;
        field_rotation: number;
        font?: FontResponse;
        format?: string;
        format_type?: string;
        max_length: number;
        multiline: boolean;
        order: number;
        page_no: number;
        placeholder?: string;
        read_only: boolean;
        required: boolean;
        tab_order: number;
        tooltip?: string;
        type?: string;
        validation?: FieldValidationValue;
        validation_rule?: string;
        value?: string;
        visible: boolean;
    }
    Index
    align?: string

    Text alignment for the form field. Possible values are "RIGHT", "LEFT", "CENTER" or "JUSTIFY"

    border_color?: string

    Border color of the form field.

    color?: string

    Color of the text in the form fields.

    display_order: number

    Display order according to the SigningHub viewer.

    embedded: boolean

    True, if field is part of the PDF document.

    field_name?: string

    Unique identifier of the field.

    field_rotation: number

    Field Rotation

    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
    format_type?: string

    If field is a textbox it can follow different input types. Possible values are ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME or DATE.

    max_length: number

    Maximum content length allowed to be filled in the field.

    multiline: boolean

    True, if the field is multi line in the PDF document.

    order: number

    Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

    page_no: number

    Page number of the document on which the field exists.

    placeholder?: string

    Placeholder text for the textbox field.

    read_only: boolean

    True, if the field is marked read only in the PDF document.

    required: boolean

    True if field required in pdf

    tab_order: number

    Tab order in the PDF document

    tooltip?: string

    tooltip of the form field.

    type?: string

    Type of the text field, possible values are "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".

    validation_rule?: string

    One or more rules for validation of the fields, possible values are "MANDATORY" or "OPTIONAL".

    value?: string

    Value of the field. For type = DATE or format_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.

    visible: boolean

    True, if the field is not hidden in the PDF document.