Nutrient Web SDK
    Preparing search index...

    Class CheckBoxFormField

    A check box that can either be checked or unchecked. One check box form field can also be associated to multiple single check box widgets. In this case, option contains the value of the associated NutrientViewer.FormOption

    To retrieve a list of all form fields, use NutrientViewer.Instance#getFormFields.

    Hierarchy

    Indexable

    • readonly [key: string]: any
    Index

    Constructors

    constructor

    Properties

    additionalActions annotationIds canSetGroup? defaultValues group? id isDeletable? isEditable? isFillable? label name noExport optionIndexes? options pdfObjectId readOnly required values

    Methods

    [iterator] asImmutable asMutable clear delete deleteIn equals get getIn has hashCode hasIn merge mergeDeep mergeDeepIn mergeDeepWith mergeIn mergeWith remove removeIn set setIn toJS toJSON toObject toSeq update updateIn wasAltered withMutations

    Constructors

    • Parameters

      • Optionalargs: {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }

      Returns NutrientViewer.FormFields.CheckBoxFormField

    Properties

    additionalActions: any

    Optional actions to execute when an event is triggered.

    null

    TODO_RITESH: https://www.nutrient.io/api/web/NutrientViewer.FormFieldAdditionalActions.html
    annotationIds: NutrientViewer.Immutable.List<string>

    Holds an immutable list of NutrientViewer.Annotations.WidgetAnnotation#ids.

    canSetGroup?: boolean

    This property defines whether the user has permission to edit the group of this form field. The value of this field depends on the set of collaboration permissions defined in the JWT token.

    It is only available when collaboration permissions is enabled on Server-Backed deployments.

    defaultValues: NutrientViewer.Immutable.List<string>

    Similar to the value property. The default values are only used when a form needs to be reset.

    group?: null | string

    This property is used to define the permission scope for this form-field, it's corresponding widget-annotations and form field values. If you change the group of a form field, the corresponding widget annotations and form field values will inherit it.

    It is only available when collaboration permissions is enabled on Server-Backed deployments.

    id: string

    A unique identifier to describe the form field record. When a form field is created in the UI, the viewer has to generate a unique ID.

    When changes are saved to the underlying form field provider, we call NutrientViewer.Instance#ensureChangesSaved to make sure the form field has been persisted from the provider.

    isDeletable?: boolean

    This property defines whether this form field can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

    It is only available when collaboration permissions is enabled on Server-Backed deployments.

    isEditable?: boolean

    This property defines whether this form-field can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

    It is only available when collaboration permissions is enabled on Server-Backed deployments.

    isFillable?: boolean

    This property defines whether this form-field can be filled or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

    It is only available when collaboration permissions is enabled on Server-Backed deployments.

    label: string

    Used to identify the form field in the UI or for accessibility.

    name: string

    Unique name of the form field (often referred to as fully qualified name). This name is used to link NutrientViewer.Annotations.WidgetAnnotation and is also used as an identifier for form field values.

    noExport: boolean

    Form fields with the noExport flag won't appear in the serialized payload of a form submission.

    false
    optionIndexes?: NutrientViewer.Immutable.List<number>

    Radio buttons and checkboxes can have multiple widgets with the same form value associated, but can be selected independently. optionIndexes contains the value indexes that should be actually set.

    If set, the value field doesn't get used, and the widget found at the corresponding indexes in the form field's annotationIds property are checked.

    If set on fields other than radio buttons or checkboxes, setting the form value will fail.

    options: NutrientViewer.Immutable.List<NutrientViewer.FormOption>

    A list of NutrientViewer.FormOptions. This is necessary for multiple check boxes in a group.

    See NutrientViewer.FormOption for more information.

    pdfObjectId: number

    The object ID of the form field object in the PDF.

    readOnly: boolean

    Read only form fields can not be filled out (similar to disabled HTML input elements).

    false
    required: boolean

    Required form fields must be filled out in order to submit the form.

    NutrientViewer.FormFields.TextFormField, NutrientViewer.FormFields.ComboBoxFormField and NutrientViewer.FormFields.ListBoxFormField with this flag set will be rendered with the [PSPDFKit-Annotation-Widget-Required]https://www.nutrient.io/api/web/css-Widget-Annotation.html#.PSPDFKit-Annotation-Widget-Required public CSS class and the HTML required attribute set.

    false
    values: NutrientViewer.Immutable.List<string>

    An immutable list of all selected form option values. If no options are defined, a checked check box will have values: List(["Yes"]);.

    If the list is empty, no check box is checked.

    In order to modify it, instance.setFormFieldValues() should be used.

    Methods

    • Returns IterableIterator<
          [
              keyof {
                  additionalActions?: any;
                  annotationIds?: NutrientViewer.Immutable.List<string>;
                  canSetGroup?: boolean;
                  group?: null | string;
                  id?: string;
                  isDeletable?: boolean;
                  isEditable?: boolean;
                  isFillable?: boolean;
                  label?: string;
                  name?: string;
                  noExport?: boolean;
                  pdfObjectId?: null | number;
                  readOnly?: boolean;
                  required?: boolean;
                  [key: string]: any;
              },
              any,
          ],
      >

    • Returns a new instance of this Record type with all values set to their default values.

      Returns this

    • Returns a new instance of this Record type with the value for the specific key set to its default value.

      Type Parameters

      • K extends keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }

      Parameters

      • key: K

      Returns this

      remove

    • Parameters

      • other: any

      Returns boolean

    • Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

      If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

      Type Parameters

      • K extends keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }

      Parameters

      • key: K
      • OptionalnotSetValue: any

      Returns {
          additionalActions?: any;
          annotationIds?: NutrientViewer.Immutable.List<string>;
          canSetGroup?: boolean;
          group?: null | string;
          id?: string;
          isDeletable?: boolean;
          isEditable?: boolean;
          isFillable?: boolean;
          label?: string;
          name?: string;
          noExport?: boolean;
          pdfObjectId?: null | number;
          readOnly?: boolean;
          required?: boolean;
          [key: string]: any;
      }[K]

    • Type Parameters

      • T

      Parameters

      • key: string
      • notSetValue: T

      Returns T

    • Parameters

      • key: string

      Returns key is string

    • Parameters

      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    additionalActions?: any;
                    annotationIds?: NutrientViewer.Immutable.List<string>;
                    canSetGroup?: boolean;
                    group?: null | string;
                    id?: string;
                    isDeletable?: boolean;
                    isEditable?: boolean;
                    isFillable?: boolean;
                    label?: string;
                    name?: string;
                    noExport?: boolean;
                    pdfObjectId?: null | number;
                    readOnly?: boolean;
                    required?: boolean;
                    [key: string]: any;
                },
            >
        )[]

      Returns this

    • Parameters

      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    additionalActions?: any;
                    annotationIds?: NutrientViewer.Immutable.List<string>;
                    canSetGroup?: boolean;
                    group?: null | string;
                    id?: string;
                    isDeletable?: boolean;
                    isEditable?: boolean;
                    isFillable?: boolean;
                    label?: string;
                    name?: string;
                    noExport?: boolean;
                    pdfObjectId?: null | number;
                    readOnly?: boolean;
                    required?: boolean;
                    [key: string]: any;
                },
            >
        )[]

      Returns this

    • Parameters

      • merger: (oldVal: any, newVal: any, key: any) => any
      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    additionalActions?: any;
                    annotationIds?: NutrientViewer.Immutable.List<string>;
                    canSetGroup?: boolean;
                    group?: null | string;
                    id?: string;
                    isDeletable?: boolean;
                    isEditable?: boolean;
                    isFillable?: boolean;
                    label?: string;
                    name?: string;
                    noExport?: boolean;
                    pdfObjectId?: null | number;
                    readOnly?: boolean;
                    required?: boolean;
                    [key: string]: any;
                },
            >
        )[]

      Returns this

    • Parameters

      • merger: (
            oldVal: any,
            newVal: any,
            key: keyof {
                additionalActions?: any;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: null | string;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: null | number;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            },
        ) => any
      • ...collections: (
            | Iterable<[string, any]>
            | Partial<
                {
                    additionalActions?: any;
                    annotationIds?: NutrientViewer.Immutable.List<string>;
                    canSetGroup?: boolean;
                    group?: null | string;
                    id?: string;
                    isDeletable?: boolean;
                    isEditable?: boolean;
                    isFillable?: boolean;
                    label?: string;
                    name?: string;
                    noExport?: boolean;
                    pdfObjectId?: null | number;
                    readOnly?: boolean;
                    required?: boolean;
                    [key: string]: any;
                },
            >
        )[]

      Returns this

    • Type Parameters

      • K extends keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }

      Parameters

      • key: K

      Returns this

    • Type Parameters

      • K extends keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }

      Parameters

      • key: K
      • value: {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }[K]

      Returns this

    • Deeply converts this Record to equivalent native JavaScript Object.

      Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

      Returns {
          additionalActions?: any;
          annotationIds?: any;
          canSetGroup?: any;
          group?: any;
          id?: any;
          isDeletable?: any;
          isEditable?: any;
          isFillable?: any;
          label?: any;
          name?: any;
          noExport?: any;
          pdfObjectId?: any;
          readOnly?: any;
          required?: any;
          [key: string]: any;
      }

    • Shallowly converts this Record to equivalent native JavaScript Object.

      Returns {
          additionalActions?: any;
          annotationIds?: NutrientViewer.Immutable.List<string>;
          canSetGroup?: boolean;
          group?: null | string;
          id?: string;
          isDeletable?: boolean;
          isEditable?: boolean;
          isFillable?: boolean;
          label?: string;
          name?: string;
          noExport?: boolean;
          pdfObjectId?: null | number;
          readOnly?: boolean;
          required?: boolean;
          [key: string]: any;
      }

    • Shallowly converts this Record to equivalent JavaScript Object.

      Returns {
          additionalActions?: any;
          annotationIds?: NutrientViewer.Immutable.List<string>;
          canSetGroup?: boolean;
          group?: null | string;
          id?: string;
          isDeletable?: boolean;
          isEditable?: boolean;
          isFillable?: boolean;
          label?: string;
          name?: string;
          noExport?: boolean;
          pdfObjectId?: null | number;
          readOnly?: boolean;
          required?: boolean;
          [key: string]: any;
      }

    • Returns Keyed<
          keyof {
              additionalActions?: any;
              annotationIds?: NutrientViewer.Immutable.List<string>;
              canSetGroup?: boolean;
              group?: null | string;
              id?: string;
              isDeletable?: boolean;
              isEditable?: boolean;
              isFillable?: boolean;
              label?: string;
              name?: string;
              noExport?: boolean;
              pdfObjectId?: null | number;
              readOnly?: boolean;
              required?: boolean;
              [key: string]: any;
          },
          any,
      >

    • Type Parameters

      • K extends keyof {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }

      Parameters

      • key: K
      • updater: (
            value: {
                additionalActions?: any;
                annotationIds?: NutrientViewer.Immutable.List<string>;
                canSetGroup?: boolean;
                group?: null | string;
                id?: string;
                isDeletable?: boolean;
                isEditable?: boolean;
                isFillable?: boolean;
                label?: string;
                name?: string;
                noExport?: boolean;
                pdfObjectId?: null | number;
                readOnly?: boolean;
                required?: boolean;
                [key: string]: any;
            }[K],
        ) => {
            additionalActions?: any;
            annotationIds?: NutrientViewer.Immutable.List<string>;
            canSetGroup?: boolean;
            group?: null | string;
            id?: string;
            isDeletable?: boolean;
            isEditable?: boolean;
            isFillable?: boolean;
            label?: string;
            name?: string;
            noExport?: boolean;
            pdfObjectId?: null | number;
            readOnly?: boolean;
            required?: boolean;
            [key: string]: any;
        }[K]

      Returns this

    • Parameters

      • keyPath: Iterable<any>
      • updater: (value: any) => any

      Returns this

    • Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.

      Parameters

      • mutator: (mutable: this) => any

      Returns this

      Map#withMutations

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods