PDF Generation Template Editor
Open-source visual PDF generation engine with customizable templates and developer-friendly APIs.
Open-source visual PDF generation engine with customizable templates and developer-friendly APIs.
CPDFReaderView is a React component designed to display PDF documents. Below are details about the required document prop.
Specifies the path or URI of the PDF document to be displayed.
string**Usage Examples:
<CPDFReaderView
document={'/storage/emulated/0/Download/PDF_document.pdf'}/><CPDFReaderView
document={'content://...'}/><CPDFReaderView
document={'file:///android_asset/...'}/><CPDFReaderView
document={'pdf_document.pdf'}/>The password to open the document is an optional parameter.
stringUsage Examples:
<CPDFReaderView
document={'pdf_document.pdf'}
password={'password'}/>Used to pass configuration parameters when rendering a PDF file to customize UI features and PDF view properties. ComPDF provides default configuration parameters through ComPDFKit.getDefaultConfig.
stringUsage Examples:
<CPDFReaderView
document={samplePDF}
configuration={ComPDFKit.getDefaultConfig({
})}
style={{flex:1}}
/>Reopens a specified document in the current CPDFReaderView component.
Parameters:
| Name | Type | Description |
|---|---|---|
| document | string | The file path of the PDF document. |
| password | string | The password for the document, which can be null or empty. |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | bool | A promise that resolves to true if the document is successfully opened, otherwise false. |
await pdfReaderRef.current?._pdfDocument.open(document, 'password');Checks whether the document has been modified.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| hasChange | boolean | true: The document has been modified, false: The document has not been modified. |
const hasChange = await pdfReaderRef.current?.hasChange();Save the current document changes.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| result | boolean | true: Save successful, false: Save failed. |
const saveResult = await pdfReaderRef.current.save();function, optional
This function will be called when the document is saved.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | int | the current page number |
<CPDFReaderView
onSaveDocument={()=>{}}
/>Gets the file name of the PDF document.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | string | Gets the file name of the PDF document. |
const fileName = await pdfReaderRef.current?._pdfDocument.getFileName();Checks if the PDF document is an image document. This is a time-consuming operation that depends on the document size.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Return true if the document is a scanned image document, otherwise return false. |
const isImageDoc = await pdfReaderRef.current?._pdfDocument.isImageDoc();Retrieves the path of the current document.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| path | string | Retrieves the path of the current document. |
const documentPath = await pdfReaderRef.current?._pdfDocument.getDocumentPath();Set the current PDF view margin.
Parameters:
| Name | Type | Description |
|---|---|---|
| left | int | margin left |
| top | int | margin top |
| right | int | margin right |
| bottom | int | margin bottom |
await pdfReaderRef.current?.setMargins(10,10,10,10);Sets the spacing between pages. This method is supported only on the Android platform.
iOS platform, use the setMarginsmethod instead.The spacing between pages is equal to the value of CPDFEdgeInsets.top.Parameters:
| Name | Type | Description |
|---|---|---|
| pageSpacing | int | The space between pages, in pixels. |
await pdfReaderRef.current?.setPageSpacing(10);Note: This method only supports the Android platform.
Set the page scale, Value Range: 1.0~5.0
Parameters:
| Name | Type | Description |
|---|---|---|
| scale | number | scale value |
await pdfReaderRef.current?.setScale(2.0);Get the current page scale
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | number | Returns the zoom ratio of the current page. |
const scale = await pdfReaderRef.current?.getScale();Whether allow to scale.
Parameters:
| Name | Type | Description |
|---|---|---|
| canScale | boolean | scale value |
await pdfReaderRef.current?.setCanScale(false);Note: This method only supports the Android platform.
Sets background color of reader.
Parameters:
| Name | Type | Description |
|---|---|---|
| theme | CPDFThemes |
await pdfReaderRef.current?.setReadBackgroundColor(CPDFThemes.LIGHT);Explanation of Themes
| Mode | Description | Option Values |
|---|---|---|
| LIGHT | Uses a white background and black text, suitable for reading in well-lit environments. | CPDFThemes.LIGHT |
| DARK | Uses a dark background and light text, suitable for reading in low-light environments. | CPDFThemes.DARK |
| SEPIA | Use a beige background for users who are used to reading on paper. | CPDFThemes.SEPIA |
| RESEDA | Soft light green background reduces discomfort from high brightness and strong contrast when reading, effectively relieving visual fatigue. | CPDFThemes.RESEDA |
Get background color of reader.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | CPDFThemes |
CPDFThemes theme = await pdfReaderRef.current?.getReadBackgroundColor();Sets whether to display highlight Form Field.
Parameters:
| Name | Type | Description |
|---|---|---|
| isFormFieldHighlight | boolean | true to display highlight Form Field. |
await pdfReaderRef.current?.setFormFieldHighlight(true);Whether to display highlight Form Field.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Whether the form field is currently highlighted |
const isFormFieldHighlight = await pdfReaderRef.current?.isFormFieldHighlight();Sets whether to display highlight Link.
Parameters:
| Name | Type | Description |
|---|---|---|
| isLinkHighlight | boolean | Whether to highlight Link. |
await pdfReaderRef.current?.setLinkHighlight(true);Whether to display highlight Link.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean |
const isLinkHighlight = await pdfReaderRef.current?.isLinkHighlight();Sets whether it is vertical scroll mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| isVerticalMode | boolean | Whether it is vertical scroll mode. |
await pdfReaderRef.current?.setVerticalMode(true);Whether it is vertical scroll mode.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Returns true for vertical scrolling and false for horizontal scrolling |
await pdfReaderRef.current?.isVerticalMode();Sets whether it is continuous scroll mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| isContinueMode | boolean | Whether it is continuous scroll mode. |
await pdfReaderRef.current?.setContinueMode(true);Whether it is continuous scroll mode.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Returns true if the page is scrolled continuously, otherwise returns false |
await pdfReaderRef.current?.isContinueMode();Sets whether it is double page mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| isDoublePageMode | boolean | Whether it is double page mode. |
await pdfReaderRef.current?.setDoublePageMode(true);Whether it is double page mode.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Returns true if double page display is enabled, otherwise returns false |
await pdfReaderRef.current?.isDoublePageMode();await pdfReaderRef.current?.isContinueMode();Sets whether it is cover page mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| isCoverPageMode | boolean | Whether to display the document in cover form |
await pdfReaderRef.current?.setCoverPageMode(true);Whether it is cover page mode.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Returns true if the document cover is displayed, otherwise returns false |
await pdfReaderRef.current?.isCoverPageMode();Sets whether it is crop mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| isCropMode | boolean | Whether it is crop mode. |
await pdfReaderRef.current?.setCropMode(true);Whether it is cover page mode.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Returns true if the current mode is clipping mode, otherwise returns false |
await pdfReaderRef.current?.isCropMode();In the single page mode, set whether all pages keep the same width and the original page keeps the same width as readerView.
Parameters:
| Name | Type | Description |
|---|---|---|
| isPageSameWidth | boolean | true: All pages keep the same width, the original state keeps the same width as readerView; false: Show in the actual width of page |
await pdfReaderRef.current?.setPageSameWidth(true);Note: This method only supports the Android platform.
Gets whether the specified pageIndex is displayed on the screen
Parameters:
| Name | Type | Description |
|---|---|---|
| pageIndex | int | page index |
const isPageInScreen = await pdfReaderRef.current?.isPageInScreen(1);Note: This method only supports the Android platform.
Sets whether to fix the position of the non-swipe direction when zooming in for reading.
Parameters:
| Name | Type | Description |
|---|---|---|
| isFixedScroll | boolean | Whether to fix scrolling |
await pdfReaderRef.current?.setFixedScroll(true);Note: This method only supports the Android platform.
Switch the mode displayed by the current CPDFReaderWidget.
Parameters:
| Name | Type | Description |
|---|---|---|
| viewMode | CPDFViewMode | The view mode to display |
await pdfReaderRef.current?.setPreviewMode(CPDFViewMode.VIEWER);Get the currently displayed mode.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| viewMode | CPDFViewMode | Returns the currently displayed view mode |
const mode = await pdfReaderRef.current?.getPreviewMode();Displays the thumbnail view. When [editMode] is true, the page enters edit mode, allowing operations such as insert, delete, extract, etc.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| editMode | boolean | Whether to enable edit mode |
await pdfReaderRef.current?.showThumbnailView(true);Displays the BOTA view, which includes the document outline, bookmarks, and annotation list.
await pdfReaderRef.current?.showBotaView();Displays the BOTA view, which includes the document outline, bookmarks, and annotation list.
await pdfReaderRef.current?.showAddWatermarkView();Displays the document security settings view, allowing users to configure document security options.
await pdfReaderRef.current?.showSecurityView();Displays the display settings view, where users can configure options such as scroll direction, scroll mode, and themes.
await pdfReaderRef.current?.showDisplaySettingView();Enters snip mode, allowing users to capture screenshots.
await pdfReaderRef.current?.enterSnipMode();Enters snip mode, allowing users to capture screenshots.
await pdfReaderRef.current?.exitSnipMode();Invokes the system's print service to print the current document.
await pdfReaderRef.current?._pdfDocument.printDocument();Jump to the index page.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageIndex | int | Jump to page number |
await pdfReaderRef.current?.setDisplayPageIndex(1);get current page index.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| pageIndex | int | Returns the page index of the current document display |
const pageIndex = await pdfReaderRef.current?.getCurrentPageIndex();function, optional
This function is called when the page number has been changed.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | int | the current page number |
<CPDFReaderView
onPageChanged={(pageIndex:number)=>{
}}
/>Get the total number of pages in the current document
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| count | int | Get the total number of pages in the current document |
const pageCount = await pdfReaderRef.current?._pdfDocument.getPageCount();Imports another PDF document and inserts it at a specified position in the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| filePath | string | The path of the PDF document to import. Must be a valid, accessible path on the device. |
| pages | Array[number] | The collection of pages to import, represented as an array of integers. If null or an empty array is passed, the entire document will be imported. |
| insertPosition | number | The position to insert the external document into the current document. This value must be provided. If not specified, the document will be inserted at the end of the current document. |
| password | string | The password for the document, if it is encrypted. If the document is not encrypted, an empty string '' can be passed. |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | bool | Returns a Promise<boolean> indicating whether the document import was successful.- true indicates success- false or an error indicates failure |
// Define the file path of the document to import
// For local files (e.g., from app cache):
const filePath = '/data/user/0/com.compdfkit.flutter.example/cache/temp/PDF_Document.pdf';
// For Android content URIs (e.g., from media storage):
const filePath = 'content://media/external/file/1000045118';
// Specify the pages to import. An empty array [] imports all pages.
// In this example, only the first page (index 0) is imported.
const pages = [0];
// Define the position to insert the imported pages.
// 0 means inserting at the beginning of the document.
const insertPosition = 0;
// Provide the document password if encrypted. Leave empty if not required.
const password = '';
// Import the document into the PDF reader.
const importResult = await pdfReaderRef.current?._pdfDocument.importDocument(
filePath,
pages,
insertPosition,
password
);Splits the specified pages from the current document and saves them as a new document.
This function extracts the given pages from the current PDF document and saves them as a new document at the provided save path.
Parameters:
| Name | Type | Description |
|---|---|---|
| savePath | string | The path where the new document will be saved. |
| pages | Array[number] | Pages to extract from the current document. |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | bool | A Promise that resolves to true if the operation is successful, or false if it fails. |
const savePath = '/data/user/0/com.compdfkit.flutter.example/cache/temp/PDF_Document.pdf';
// Pages to extract from the current document
const pages = [0, 1, 2];
const result = await pdfReaderRef.current?.splitDocumentPages(savePath, pages);Inserts a blank page at the specified index in the document.
This method allows adding a blank page of a specified size at a specific index within the PDF document. It is useful for document editing scenarios where page insertion is needed.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageIndex | number | The index position where the blank page will be inserted. Must be a valid index within the document. |
| pageSize | CPDFPageSize | The size of the blank page to insert. Defaults to A4 size if not specified. |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | bool | A Promise that resolves to a boolean value indicating the success or failure of the blank page insertion. Resolves to true if the insertion was successful, false otherwise. |
const pageSize = CPDFPageSize.a4;
// Custom page size
// const pageSize = new CPDFPageSize(500, 800);
const result = await pdfRef.current?._pdfDocument.insertBlankPage(0, pageSize);Imports annotations from the specified XFDF file into the current PDF document.
Parameters:
| Name | Type | Description |
|---|---|---|
| xfdfFile | string | Path of the XFDF file to be imported. The Android platform supports the following paths: - assets file:'file:///android_assets/test.xfdf' - file path: '/data/xxx.xfdf' - Uri: 'content://xxxx' |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| result | boolean | true: import successful, false: import failed. |
const result = await pdfReaderRef.current.importAnnotations('xxx.xfdf');Exports annotations from the current PDF document to an XFDF file.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| xfdfPath | string | The path of the XFDF file if export is successful; an empty string if the export fails. |
const exportXfdfFilePath = await pdfReaderRef.current?.exportAnnotations();Delete all comments in the current document.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| result | boolean | true、false |
const removeResult = await pdfReaderRef.current?.removeAllAnnotations();Retrieves all annotations on the current page.
This method fetches all annotations present on the current page of the PDF document and returns a list of corresponding CPDFAnnotation instances.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| annotations | CPDFAnnotation[] | A promise that resolves with all annotations on the current page, or an empty array if retrieval fails. |
// Page index, where 0 represents the first page
const pageIndex = 0;
// Retrieve the page object from the document
const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
// Fetch all annotations on the specified page
const annotations = await page?.getAnnotations();Removes the specified annotation from the PDF document
Parameters:
| Name | Type | Description |
|---|---|---|
| annotation | CPDFAnnotation | The annotation to be removed. |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| result | boolean | true: remove successful, false: remove failed. |
await pdfReaderRef?.current?._pdfDocument.removeAnnotation(annotation);
// or use
const pageIndex = 0;
const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
const widgets = await page?.getWidgets();
const widgetToRemove = widgets[0];
await page?.removeWidget(widgetToRemove);Flatten all pages of the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| savePath | string | The path to save the flattened document. On Android, you can pass a Uri. |
| fontSubset | boolean | Whether to include the font subset when saving. |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Returns 'true' if the flattened document is saved successfully, otherwise 'false'. |
const savePath = 'file:///storage/emulated/0/Download/flatten.pdf';
// or use Uri on the Android Platform.
const savePath = await ComPDFKit.createUri('flatten_test.pdf', 'ComPDF', 'application/pdf');
const fontSubset = true;
const result = await pdfReaderRef.current?._pdfDocument.flattenAllPages(savePath, fontSubset);Get the type of annotation added to the current touch page. This method is only available in CPDFViewMode.ANNOTATIONS mode.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | CPDFAnnotationType | Returns the annotation type currently selected for drawing |
const annotationMode = await pdfReaderRef.current?.getAnnotationMode();Used to add a specified annotation type when touching the page in annotation mode, This method is only available in CPDFViewMode.ANNOTATIONS mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| type | CPDFAnnotationType | type The type of annotation mode to set. |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | void |
await pdfReaderRef.current?.setAnnotationMode(CPDFAnnotationType.HIGHLIGHT);Manages the undo and redo history for PDF annotation actions within a viewer component. including checking if undo/redo actions are available and performing those actions. It also allows registering a listener to monitor changes in the annotation history state.
const historyManager = pdfReaderRef.current?._annotationsHistoryManager;
historyManager?.setOnHistoryStateChangedListener((canUndo, canRedo) => {
// Update UI based on undo/redo availability.
});
await historyManager?.canUndo();
await historyManager?.canRedo();
await historyManager?.undo();
await historyManager?.redo();Imports the form data from the specified XFDF file into the current PDF document.
The API only imports form data and modifies the form content through the corresponding form name.
Parameters:
| Name | Type | Description |
|---|---|---|
| xfdfFile | string | Path of the XFDF file to be imported.The Android platform supports the following paths: - assets file:'file:///android_assets/test.xfdf' - file path: '/data/xxx.xfdf' - Uri: 'content://xxxx' |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| result | boolean | true: import successful,``false: import failed. |
const result = await pdfReaderRef.current.importWidgets('xxx.xfdf');exports the form data from the current PDF document to an XFDF file.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| xfdfPath | string | The path of the XFDF file if export is successful; an empty string if the export fails. |
const exportXfdfFilePath = await pdfReaderRef.current?.exportWidgets();Retrieves all form widgets on the current page.
This method fetches all form widgets present on the current page of the PDF document and returns a list of corresponding CPDFWidget instances.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| widgets | CPDFWidget[] | true: import successful,``false: import failed. |
const pageIndex = 0;
const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
const widgets = await page?.getWidgets();Related Widgets
| Class | Description |
|---|---|
| CPDFWidget | Base class for all form widgets |
| CPDFTextWidget | Text input field widget |
| CPDFSignatureWidget | Signature widget |
| CPDFRadiobuttonWidget | Radio button widget |
| CPDFPushbuttonWidget | Button widget |
| CPDFListboxWidget | List box widget |
| CPDFCheckboxWidget | Checkbox widget |
| CPDFComboboxWidget | Combo box widget |
ComPDF supports programmatically filling form fields in a PDF document.
The steps to fill in form fields using code are as follows:
Get the page object of the form to be filled in from CPDFDocument.
Retrieve all forms from the page object.
Traverse all forms to find the one to be filled in.
Modify the form field contents as needed.
This example shows how to fill in form fields:
const pageIndex = 0;
// Retrieve the page object of the first page
const cpdfPage: CPDFPage = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
// Retrieve all form widgets on the current page
const widgets = await page?.getWidgets();
// Fill in the text field content
// Assume that there is a text field form on the current page and retrieve the CPDFTextWidget object
const textWidget = widgets[0] as CPDFTextWidget;
// Set the text field content to "Hello World"
await textWidget.setText('Hello World');
// Refresh the appearance of the form to apply changes, this step is necessary
await textWidget.updateAp();
// Modify the radio button's checked state
const radioButtonWidget = widgets[0] as CPDFRadiobuttonWidget;
// Set the radio button to checked
await radioButtonWidget.setChecked(true);
// Refresh the appearance of the radio button
await radioButtonWidget.updateAp();
// Modify the checkbox's checked state
const checkboxWidget = widgets[0] as CPDFCheckboxWidget;
// Set the checkbox to checked
await checkboxWidget.setChecked(true);
// Refresh the appearance of the checkbox
await checkboxWidget.updateAp();
// Add an electronic signature to the signature form
const signatureWidget = widgets[0] as CPDFSignatureWidget;
// Android-supported URI format:
await signatureWidget.addImageSignature('content://media/external/images/media/123');
// Or file path:
await signatureWidget.addImageSignature('/path/to/image');
// Refresh the appearance of the signature form
await signatureWidget.updateAp();Removes the specified widget from the PDF document
Parameters:
| Name | Type | Description |
|---|---|---|
| widget | CPDFWidget | The widget to be removed. |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| result | boolean | true: remove successful, false: remove failed. |
await pdfReaderRef?.current?._pdfDocument.removeWidget(widget);
// or use
const pageIndex = 0;
const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
const annotations = await page?.getAnnotations();
const annotationToRemove = annotations[0];
await page?.removeAnnotation(annotationToRemove);Checks if the PDF document is encrypted.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean |
const isEncrypted = await pdfReaderRef.current?._pdfDocument.isEncrypted();Gets the current document's permissions.
There are three types of permissions:
No restrictions: CPDFDocumentPermissions.NONEIf the document has an open password and an owner password,using the open password will grant CPDFDocumentPermissions.USER permissions, and using the owner password will grant CPDFDocumentPermissions.OWNER permissions.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | CPDFDocumentPermissions | Gets the current document's permissions. |
const permissions = await pdfReaderRef.current?._pdfDocument.getPermissions();Check if owner permissions are unlocked
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean |
const unlocked = await pdfReaderRef.current?._pdfDocument.checkOwnerUnlocked();Whether the owner password is correct. If the password is correct, the document will be unlocked with full owner permissions.
Parameters:
| Name | Type | Description |
|---|---|---|
| password | string | password The owner password to be verified. |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | A promise that resolves to true if the owner password is correct, otherwise false. |
const check = await pdfReaderRef.current?._pdfDocument.checkOwnerPassword('ownerPassword');This method sets the document password, including the user password for access restrictions and the owner password for granting permissions.
Parameters:
| Name | Type | Description |
|---|---|---|
| userPassword | string | The user password for document access restrictions. |
| ownerPassword | string | The owner password to grant permissions (e.g., printing, copying). |
| allowsPrinting | boolean | Whether printing is allowed (true or false). |
| allowsCopying | boolean | Whether copying is allowed (true or false). |
| encryptAlgo | CPDFDocumentEncryptAlgo | The encryption algorithm to use (e.g., CPDFDocumentEncryptAlgo.rc4). |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | A promise that resolves to true if the password is successfully set, otherwise false. |
const success = await pdfReaderRef.current?._pdfDocument.setPassword(
'user_password',
'owner_password',
false,
false,
CPDFDocumentEncryptAlgo.rc4
);Remove the user password and owner permission password. set in the document, and perform an incremental save.
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | boolean | Returns true if password removal is successful, otherwise false. |
const check = await pdfReaderRef.current?._pdfDocument.checkOwnerPassword('ownerPassword');Get the encryption algorithm of the current document
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| result | CPDFDocumentEncryptAlgo | Encryption Type |
const encryptAlgo = await pdfReaderRef.current?._pdfDocument.getEncryptAlgo();