ComPDF React Native - v3.0.0
    Preparing search index...

    Class CPDFCheckboxWidget

    Class representing a checkbox form widget, storing basic information about the checkbox form.

    CPDFCheckboxWidget

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    update fromJson fromJsonArray parseType toJSON

    Properties

    isChecked checkColor checkStyle type title page uuid createDate rect borderColor fillColor borderWidth

    Constructors

    Methods

    • Update radiobutton widget properties with type safety

      Parameters

      • updates: Partial<
            Pick<
                CPDFRadiobuttonWidget,
                | "title"
                | "isChecked"
                | "checkColor"
                | "checkStyle"
                | "borderColor"
                | "fillColor"
                | "borderWidth",
            >,
        >

        Partial object containing properties to update

      Returns this

      this instance for chaining

      radiobuttonWidget.update({
        title: 'Updated Title',
        isChecked: true,
        checkColor: '#FF0000',
        checkStyle: CPDFCheckStyle.CIRCLE
      });
      await document.updateWidget(radiobuttonWidget);

    • Returns Omit<CPDFCheckboxWidget, "createDate" | "update" | "toJSON"> & {
          createDate?: number;
          borderColor: string;
          fillColor: string;
          borderWidth: number;
      }

    Properties

    isChecked: boolean

    The state of the radiobutton form widget.

    checkColor: string

    The checked state color of a radio button form widget.

    checkStyle: string

    The style of the radiobutton form widget.

    type: CPDFWidgetType

    The type of the form widget.

    title: string

    The title of the form widget (default: empty string).

    Readonlypage

    page: number

    The page number where the form widget appears (default: 0).

    uuid: string

    The unique identifier for the form widget (default: empty string).

    createDate: Date | null = null

    The date when the form widget was created (default: null).

    rect: CPDFRectF | null = null

    The rectangular coordinates of the form widget (default: null).

    borderColor: string

    The border color of the form widget (default: '#000000').

    fillColor: string

    The fill color of the form widget (default: '#000000').

    borderWidth: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties