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

    Class CPDFComboboxWidget

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

    CPDFComboboxWidget

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    update fromJson fromJsonArray parseType toJSON

    Properties

    options selectItemAtIndex fontColor fontSize familyName styleName type title page uuid createDate rect borderColor fillColor borderWidth

    Constructors

    Methods

    • Update combobox widget properties with type safety

      Parameters

      • updates: Partial<
            Pick<
                CPDFComboboxWidget,
                | "title"
                | "options"
                | "selectItemAtIndex"
                | "fontColor"
                | "fontSize"
                | "familyName"
                | "styleName"
                | "borderColor"
                | "fillColor"
                | "borderWidth",
            >,
        >

        Partial object containing properties to update

      Returns this

      this instance for chaining

      comboboxWidget.update({
        title: 'Updated Title',
        options: newOptions,
        fontColor: '#00FF00',
        fontSize: 12,
        familyName: 'Times',
        styleName: 'Italic'
      });
      await document.updateWidget(comboboxWidget);

    • Type Parameters

      Parameters

      • this: new (params: Partial<T>) => T
      • json: any

      Returns T

    • Type Parameters

      Parameters

      • this: new (params: Partial<T>) => T
      • jsonArray: any[]

      Returns T[]

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

    Properties

    options: CPDFWidgetItem[]

    The list of options available in the combobox.

    selectItemAtIndex: number

    The index of the selected option in the combobox (default: 0).

    fontColor: string

    The font color of the combobox (default: '#000000').

    fontSize: number

    The font size of the combobox (default: 0).

    familyName: string

    The font family name of the combobox.

    styleName: string

    The font style name of the combobox.

    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