ComPDFKit Web SDK
    Preparing search index...

    Interface WidgetLike

    Minimal shape of a form field (core WidgetAnnotation subclasses).

    interface WidgetLike {
        elementName?: string;
        fieldName?: string;
        getAssociatedSignatureAnnotation?: () => unknown;
        getFieldFlags?: () => WidgetFieldFlags;
        getValue?: () => unknown;
        Hidden?: boolean;
        Invisible?: boolean;
        isDigitallySigned?: () => boolean;
        isSignedByAppearance?: () => boolean;
        NoView?: boolean;
        PageNumber?: number;
        ReadOnly?: boolean;
        X?: number;
        Y?: number;
    }
    Index
    elementName?: string

    Annotation type, for example 'textWidget', 'checkButtonWidget' or 'signatureWidget'.

    fieldName?: string

    Name of the form field the widget belongs to.

    getAssociatedSignatureAnnotation?: () => unknown

    Returns the signature annotation placed on a signature field.

    Type Declaration

      • (): unknown
      • Returns unknown

        The signature annotation, if any.

    getFieldFlags?: () => WidgetFieldFlags

    Returns the flags of the form field.

    Type Declaration

    getValue?: () => unknown

    Returns the value of the form field.

    Type Declaration

      • (): unknown
      • Returns unknown

        The field value.

    Hidden?: boolean

    Whether the widget is hidden.

    Invisible?: boolean

    Whether the widget is invisible.

    isDigitallySigned?: () => boolean

    Tells whether a signature field is digitally signed.

    Type Declaration

      • (): boolean
      • Returns boolean

        Whether it is digitally signed.

    isSignedByAppearance?: () => boolean

    Tells whether a signature field is signed with an appearance only.

    Type Declaration

      • (): boolean
      • Returns boolean

        Whether it is signed with an appearance.

    NoView?: boolean

    Whether the widget is not shown on screen.

    PageNumber?: number

    Page number of the widget, starting at 1.

    ReadOnly?: boolean

    Whether the widget cannot be changed.

    X?: number

    Left edge of the widget in page coordinates.

    Y?: number

    Top edge of the widget in page coordinates.