Interface FormFieldType

interface FormFieldType {
    checkControl: (
        controlIndex: number,
        checked: boolean,
        notify: boolean,
    ) => Promise<boolean>;
    getAlternateName: () => Promise<string>;
    getControlByIndex: (index: number) => Promise<null | FormControlType>;
    getControlsCount: () => Promise<number>;
    getFieldDict: () => Promise<null | PDFDictionaryType>;
    getFieldFlags: () => Promise<number>;
    getFieldType: () => Promise<number>;
    getFullName: () => Promise<string>;
    getOptionsCount: () => Promise<number>;
    insertOption: (
        optLabel: string,
        index: number,
        notify: boolean,
    ) => Promise<number>;
    options?: Options;
    setAlternateName: (name: string) => Promise<void>;
    setFieldFlags: (flags: number) => Promise<void>;
    setOptionValue: (
        index: number,
        optValue: string,
        notify: boolean,
    ) => Promise<boolean>;
    setValue: (value: string, notify: boolean) => Promise<boolean>;
    getInterForm(): Promise<null | InterFormType>;
}

Implemented by

Properties

checkControl getAlternateName getControlByIndex getControlsCount getFieldDict getFieldFlags getFieldType getFullName getOptionsCount insertOption options? setAlternateName setFieldFlags setOptionValue setValue

Methods

getInterForm

Properties

checkControl

checkControl: (
    controlIndex: number,
    checked: boolean,
    notify: boolean,
) => Promise<boolean>

检查表单字段中某个控件的状态。

Type declaration

    • (controlIndex: number, checked: boolean, notify: boolean): Promise<boolean>

    • Parameters

      • controlIndex: number

        要检查的控件索引。

      • checked: boolean

        控件是否应被选中。

      • notify: boolean

        是否通知变更。

      Returns Promise<boolean>

      • 如果成功检查控件状态则返回 true，否则返回 false。

getAlternateName

getAlternateName: () => Promise<string>

获取备用名称

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      • 返回表单字段的备用名称

getControlByIndex

getControlByIndex: (index: number) => Promise<null | FormControlType>

通过索引获取控件

Type declaration

    • (index: number): Promise<null | FormControlType>

    • Parameters

      • index: number

        要获取的控件索引

      Returns Promise<null | FormControlType>

      • 返回指定索引处的表单控件对象

getControlsCount

getControlsCount: () => Promise<number>

获取控件数量

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 返回控件的数量

getFieldDict

getFieldDict: () => Promise<null | PDFDictionaryType>

获取字段字典

Type declaration

getFieldFlags

getFieldFlags: () => Promise<number>

获取字段标志

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 返回字段标志的数字值

getFieldType

getFieldType: () => Promise<number>

获取字段类型

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 返回字段类型的数字值

getFullName

getFullName: () => Promise<string>

获取全名

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      • 返回表单字段的全名

getOptionsCount

getOptionsCount: () => Promise<number>

获取表单字段中选项的数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 返回表单字段中选项的数量。

insertOption

insertOption: (
    optLabel: string,
    index: number,
    notify: boolean,
) => Promise<number>

在指定索引处向表单字段插入一个选项。

Type declaration

    • (optLabel: string, index: number, notify: boolean): Promise<number>

    • Parameters

      • optLabel: string

        要插入选项的标签。

      • index: number

        插入选项的位置索引。

      • notify: boolean

        是否通知变更。

      Returns Promise<number>

      • 返回插入选项的索引。

Optionaloptions

options?: Options

setAlternateName

setAlternateName: (name: string) => Promise<void>

设置备用名称

Type declaration

    • (name: string): Promise<void>

    • Parameters

      • name: string

        要为表单字段设置的备用名称

      Returns Promise<void>

      • 无返回值

setFieldFlags

setFieldFlags: (flags: number) => Promise<void>

设置字段标志

Type declaration

    • (flags: number): Promise<void>

    • Parameters

      • flags: number

        要为表单字段设置的标志

      Returns Promise<void>

      • 无返回值

setOptionValue

setOptionValue: (
    index: number,
    optValue: string,
    notify: boolean,
) => Promise<boolean>

设置表单字段中指定索引处选项的值。

Type declaration

    • (index: number, optValue: string, notify: boolean): Promise<boolean>

    • Parameters

      • index: number

        要设置的选项索引。

      • optValue: string

        要为该选项设置的值。

      • notify: boolean

        是否通知变更。

      Returns Promise<boolean>

      • 如果选项值设置成功则返回 true，否则返回 false。

setValue

setValue: (value: string, notify: boolean) => Promise<boolean>

设置字段值

Type declaration

    • (value: string, notify: boolean): Promise<boolean>

    • Parameters

      • value: string

        要为表单字段设置的值

      • notify: boolean

        是否通知变更

      Returns Promise<boolean>

      • 如果值设置成功则返回 true，否则返回 false

Methods

getInterForm

Settings

Member Visibility

On This Page

Properties
Methods