boldsign/dist/model/formField.d.ts

NodeJS client for boldsign

import { AttachmentInfo } from './attachmentInfo';
import { CollaborationSettings } from './collaborationSettings';
import { ConditionalRule } from './conditionalRule';
import { EditableDateFieldSettings } from './editableDateFieldSettings';
import { FormulaFieldSettings } from './formulaFieldSettings';
import { ImageInfo } from './imageInfo';
import { Rectangle } from './rectangle';
export declare class FormField {
    'fieldType': FormField.FieldTypeEnum;
    'pageNumber': number;
    'bounds': Rectangle;
    'id'?: string | null;
    'name'?: string | null;
    'isRequired'?: boolean;
    'isReadOnly'?: boolean;
    'value'?: string | null;
    'fontSize'?: number;
    'font'?: FormField.FontEnum;
    'fontHexColor'?: string | null;
    'isBoldFont'?: boolean;
    'isItalicFont'?: boolean;
    'isUnderLineFont'?: boolean;
    'lineHeight'?: number;
    'characterLimit'?: number;
    'groupName'?: string | null;
    'label'?: string | null;
    'placeHolder'?: string | null;
    'validationType'?: FormField.ValidationTypeEnum;
    'validationCustomRegex'?: string | null;
    'validationCustomRegexMessage'?: string | null;
    'dateFormat'?: string | null;
    'timeFormat'?: string | null;
    'imageInfo'?: ImageInfo;
    'attachmentInfo'?: AttachmentInfo;
    'editableDateFieldSettings'?: EditableDateFieldSettings;
    'hyperlinkText'?: string | null;
    'conditionalRules'?: Array<ConditionalRule> | null;
    'dataSyncTag'?: string | null;
    'dropdownOptions'?: Array<string> | null;
    'textAlign'?: FormField.TextAlignEnum;
    'textDirection'?: FormField.TextDirectionEnum;
    'characterSpacing'?: number;
    'backgroundHexColor'?: string | null;
    'tabIndex'?: number | null;
    'formulaFieldSettings'?: FormulaFieldSettings;
    'resizeOption'?: FormField.ResizeOptionEnum;
    'allowEditFormField'?: boolean | null;
    'allowDeleteFormField'?: boolean | null;
    'collaborationSettings'?: CollaborationSettings;
    static discriminator: string | undefined;
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
}
export declare namespace FormField {
    enum FieldTypeEnum {
        Signature,
        Initial,
        CheckBox,
        TextBox,
        Label,
        DateSigned,
        RadioButton,
        Image,
        Attachment,
        EditableDate,
        Hyperlink,
        Dropdown,
        Title,
        Company,
        Formula
    }
    enum FontEnum {
        Helvetica,
        Courier,
        TimesRoman,
        NotoSans,
        Carlito
    }
    enum ValidationTypeEnum {
        None,
        NumbersOnly,
        EmailAddress,
        Currency,
        CustomRegex
    }
    enum TextAlignEnum {
        Left,
        Center,
        Right
    }
    enum TextDirectionEnum {
        Ltr,
        Rtl
    }
    enum ResizeOptionEnum {
        GrowVertically,
        GrowHorizontally,
        GrowBoth,
        Fixed,
        AutoResizeFont
    }
}