ComPDFKit Web SDK
    Preparing search index...

    Function setSettings

    • Changes some navigator settings; settings not in patch keep their values.

      Parameters

      • patch: {
            enabled?: boolean;
            fillMode?: boolean | null;
            includeNoView?: boolean;
            order?: "CREATE" | "DISTANCE";
            preferFocused?: boolean;
            skipNonRequired?: boolean;
            type?: FormFillConsecutive;
        }

        The settings to change.

        • Optionalenabled?: boolean

          Whether fields to fill are outlined and filling a field moves to the next one after 500 ms; true by default.

        • OptionalfillMode?: boolean | null

          Forces fill mode on (true) or off (false) in the forms toolbar group; null (default) follows the form design mode.

        • OptionalincludeNoView?: boolean

          Also visits fields marked as not shown on screen (NoView); false by default.

        • Optionalorder?: "CREATE" | "DISTANCE"

          Order of the fields: 'CREATE' keeps the document order, 'DISTANCE' (default) sorts by page, then from top to bottom.

        • OptionalpreferFocused?: boolean

          The current field follows the field that has focus (or the check box or radio button last changed) instead of the field reached with Previous / Next; false by default.

        • OptionalskipNonRequired?: boolean

          Only required fields are visited and counted.

        • Optionaltype?: FormFillConsecutive

          Which fields the form fill navigator steps through; false turns consecutive filling off.

      • Optionalkey: number

        The document viewer key; defaults to the active viewer.

      Returns void