Interface ITemplateField

interface ITemplateField {
    default?: string;
    document_id: string;
    group?: string;
    height: number;
    label?: string;
    name: string;
    page_sequence: number;
    placeholder?: string;
    required: boolean;
    role_name: string;
    setting: ITemplateFieldSetting;
    tabindex: number;
    template_id: string;
    type: "attachment" | "textarea" | "signature" | "initial" | "checkbox_group" | "radio_button_group" | "textbox" | "timestamp" | "date" | "dropdown" | "payment";
    validator?: string;
    width: number;
    x: number;
    y: number;
}

Properties

default? document_id group? height label? name page_sequence placeholder? required role_name setting tabindex template_id type validator? width x y

Properties

Optional default

default?: string

The default value for the field.

document_id

document_id: string

The ID of the document the field is for.

Optional group

group?: string

For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name.

height

height: number

The height of the field.

Optional label

label?: string

name

name: string

The machine name of the field, e.g. checkbox_groupP1-18

page_sequence

page_sequence: number

Optional placeholder

placeholder?: string

The placeholder to show in the field.

required

required: boolean

role_name

role_name: string

The ID of the role in the recipients list, e.g. Recipient 2

setting

setting: ITemplateFieldSetting

tabindex

tabindex: number

If set, the tab index for the field.

template_id

template_id: string

The ID of the template the field is for.

type

type: "attachment" | "textarea" | "signature" | "initial" | "checkbox_group" | "radio_button_group" | "textbox" | "timestamp" | "date" | "dropdown" | "payment"

Optional validator

validator?: string

width

width: number

The width of the field.

x

x: number

The X position of the field.

y

y: number

The Y position of the field.

Settings

Member Visibility

Theme

On This Page

defaultdocument_idgroupheightlabelnamepage_sequenceplaceholderrequiredrole_namesettingtabindextemplate_idtypevalidatorwidthxy