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

    Interface CPDFGlobalConfig

    CPDFGlobalConfig

    interface CPDFGlobalConfig {
        themeMode?: string;
        fileSaveExtraFontSubset?: boolean;
        useSaveIncremental?: boolean;
        watermark?: CPDFWatermarkConfig;
        signatureType?: CPDFSignatureType;
        enableExitSaveTips?: boolean;
        enableErrorTips?: boolean;
        thumbnail?: {
            title?: string;
            backgroundColor?: string | null;
            editMode?: boolean;
        };
        bota?: {
            tabs?: CPDFBotaTabs[];
            menus?: {
                annotations?: {
                    global?: CPDFBotaMenuItem<
                        | "importAnnotation"
                        | "exportAnnotation"
                        | "removeAllAnnotation"
                        | "removeAllReply",
                    >[];
                    item?: CPDFBotaMenuItem<"reviewStatus" | "markedStatus" | "more">[];
                };
            };
        };
        search?: {
            normalKeyword?: {
                borderColor?: `#${string}`;
                fillColor?: `#${string}`;
            };
            focusKeyword?: { borderColor?: `#${string}`; fillColor?: `#${string}` };
        };
        pageEditor?: {
            menus?: (
                | "insertPage"
                | "replacePage"
                | "extractPage"
                | "copyPage"
                | "rotatePage"
                | "deletePage"
            )[];
        };
        pencilMenus?: ("save" | "touch" | "discard")[];
    }
    Index

    Properties

    themeMode? fileSaveExtraFontSubset? useSaveIncremental? watermark? signatureType? enableExitSaveTips? enableErrorTips? thumbnail? bota? search? pageEditor? pencilMenus?

    Properties

    themeMode?: string
    fileSaveExtraFontSubset?: boolean

    Whether to save extra font subsets when saving the PDF file. Default: true

    useSaveIncremental?: boolean

    Whether to use incremental saving when saving the PDF file. Default: true

    watermark?: CPDFWatermarkConfig
    signatureType?: CPDFSignatureType

    set the signature type for the signature picker dialog when clicking on a signature form field Default Value: CPDFSignatureType.MANUAL

    enableExitSaveTips?: boolean

    Whether to enable exit save tips when closing the PDF document. Default: true

    enableErrorTips?: boolean
    thumbnail?: {
        title?: string;
        backgroundColor?: string | null;
        editMode?: boolean;
    }
    bota?: {
        tabs?: CPDFBotaTabs[];
        menus?: {
            annotations?: {
                global?: CPDFBotaMenuItem<
                    | "importAnnotation"
                    | "exportAnnotation"
                    | "removeAllAnnotation"
                    | "removeAllReply",
                >[];
                item?: CPDFBotaMenuItem<"reviewStatus" | "markedStatus" | "more">[];
            };
        };
    }
    search?: {
        normalKeyword?: { borderColor?: `#${string}`; fillColor?: `#${string}` };
        focusKeyword?: { borderColor?: `#${string}`; fillColor?: `#${string}` };
    }
    pageEditor?: {
        menus?: (
            | "insertPage"
            | "replacePage"
            | "extractPage"
            | "copyPage"
            | "rotatePage"
            | "deletePage"
        )[];
    }
    pencilMenus?: ("save" | "touch" | "discard")[]

    set ios platform pencil tool menus in annotation mode default value: ['touch', 'discard', 'save']

    Settings

    Member Visibility

    On This Page

    Properties