CPDFReaderView - Props ​

Open Document ​

CPDFReaderView is a React component designed to display PDF documents. Below are details about the required document prop.

document ​

Specifies the path or URI of the PDF document to be displayed.

• Type: string
• Required: Yes

**Usage Examples:

• (Android) For local storage file path:

<CPDFReaderView
	document={'/storage/emulated/0/Download/PDF_document.pdf'}/>

• (Android) For content Uri:

<CPDFReaderView
	document={'content://...'}/>

• (Android) For assets path:

<CPDFReaderView
	document={'file:///android_asset/...'}/>

• (iOS) For app bundle file path:

<CPDFReaderView	
	document={'pdf_document.pdf'}/>

password ​

The password to open the document is an optional parameter.

• Type: string

Usage Examples:

<CPDFReaderView	
	document={'pdf_document.pdf'}
  password={'password'}/>

configuration ​

Used to pass configuration parameters when rendering a PDF file to customize UI features and PDF view properties. ComPDFKit provides default configuration parameters through ComPDFKit.getDefaultConfig.

• Type:string
• Required: Yes

Usage Examples:

<CPDFReaderView
  document={samplePDF}
  configuration={ComPDFKit.getDefaultConfig({

  })}
  style={{flex:1}}
  />

Document ​

open ​

Reopens a specified document in the current CPDFReaderView component.

Parameters:

Returns a Promise.

await pdfReaderRef.current?._pdfDocument.open(document, 'password');

hasChange ​

Checks whether the document has been modified.

Returns a Promise.

Promise Parameters:

const hasChange = await pdfReaderRef.current?.hasChange();

save ​

Save the current document changes.

Returns a Promise.

Promise Parameters:

const saveResult = await pdfReaderRef.current.save();

onSaveDocument ​

function, optional

This function will be called when the document is saved.

Parameters:

<CPDFReaderView
	onSaveDocument={()=>{}}
	/>

getFileName ​

Gets the file name of the PDF document.

Returns a Promise.

const fileName = await pdfReaderRef.current?._pdfDocument.getFileName();

isImageDoc ​

Checks if the PDF document is an image document. This is a time-consuming operation that depends on the document size.

Returns a Promise.

const isImageDoc = await pdfReaderRef.current?._pdfDocument.isImageDoc();

Viewer ​

setMargins ​

Set the current PDF view margin.

Parameters:

await pdfReaderRef.current?.setMargins(10,10,10,10);

setPageSpacing ​

Sets the spacing between pages. This method is supported only on the Android platform.

• For the iOS platform, use the setMarginsmethod instead.The spacing between pages is equal to the value of CPDFEdgeInsets.top.

Parameters:

await pdfReaderRef.current?.setPageSpacing(10);

Note: This method only supports the Android platform.

setScale ​

Set the page scale, Value Range: 1.0~5.0

Parameters:

await pdfReaderRef.current?.setScale(2.0);

getScale ​

Get the current page scale

Returns a Promise.

const scale = await pdfReaderRef.current?.getScale();

setCanScale ​

Whether allow to scale.

Parameters:

await pdfReaderRef.current?.setCanScale(false);

Note: This method only supports the Android platform.

setReadBackgroundColor ​

Sets background color of reader.

Parameters:

await pdfReaderRef.current?.setReadBackgroundColor(CPDFThemes.LIGHT);

Explanation of Themes

getReadBackgroundColor ​

Get background color of reader.

Returns a Promise.

CPDFThemes theme = await pdfReaderRef.current?.getReadBackgroundColor();

setFormFieldHighlight ​

Sets whether to display highlight Form Field.

Parameters:

await pdfReaderRef.current?.setFormFieldHighlight(true);

isFormFieldHighlight ​

Whether to display highlight Form Field.

Returns a Promise.

const isFormFieldHighlight = await pdfReaderRef.current?.isFormFieldHighlight();

setLinkHighlight ​

Sets whether to display highlight Link.

Parameters:

await pdfReaderRef.current?.setLinkHighlight(true);

isLinkHighlight ​

Whether to display highlight Link.

Returns a Promise.

const isLinkHighlight = await pdfReaderRef.current?.isLinkHighlight();

setVerticalMode ​

Sets whether it is vertical scroll mode.

Parameters:

await pdfReaderRef.current?.setVerticalMode(true);

isVerticalMode ​

Whether it is vertical scroll mode.

Returns a Promise.

await pdfReaderRef.current?.isVerticalMode();

setContinueMode ​

Sets whether it is continuous scroll mode.

Parameters:

await pdfReaderRef.current?.setContinueMode(true);

isContinueMode ​

Whether it is continuous scroll mode.

Returns a Promise.

await pdfReaderRef.current?.isContinueMode();

setDoublePageMode ​

Sets whether it is double page mode.

Parameters:

await pdfReaderRef.current?.setDoublePageMode(true);

isDoublePageMode ​

Whether it is double page mode.

Returns a Promise.

await pdfReaderRef.current?.isDoublePageMode();

await pdfReaderRef.current?.isContinueMode();

setCoverPageMode ​

Sets whether it is cover page mode.

Parameters:

await pdfReaderRef.current?.setCoverPageMode(true);

isCoverPageMode ​

Whether it is cover page mode.

Returns a Promise.

await pdfReaderRef.current?.isCoverPageMode();

setCropMode ​

Sets whether it is crop mode.

Parameters:

await pdfReaderRef.current?.setCropMode(true);

isCropMode ​

Whether it is cover page mode.

Returns a Promise.

await pdfReaderRef.current?.isCropMode();

setPageSameWidth ​

In the single page mode, set whether all pages keep the same width and the original page keeps the same width as readerView.

Parameters:

await pdfReaderRef.current?.setPageSameWidth(true);

Note: This method only supports the Android platform.

isPageInScreen ​

Gets whether the specified pageIndex is displayed on the screen

Parameters:

const isPageInScreen = await pdfReaderRef.current?.isPageInScreen(1);

Note: This method only supports the Android platform.

setFixedScroll ​

Sets whether to fix the position of the non-swipe direction when zooming in for reading.

Parameters:

await pdfReaderRef.current?.setFixedScroll(true);

Note: This method only supports the Android platform.

setPreviewMode ​

Switch the mode displayed by the current CPDFReaderWidget.

Parameters:

await pdfReaderRef.current?.setPreviewMode(CPDFViewMode.VIEWER);

getPreviewMode ​

Get the currently displayed mode.

Returns a Promise.

const mode = await pdfReaderRef.current?.getPreviewMode();

showThumbnailView ​

Displays the thumbnail view. When [editMode] is true, the page enters edit mode, allowing operations such as insert, delete, extract, etc.

Returns a Promise.

await pdfReaderRef.current?.showThumbnailView(true);

showBotaView ​

Displays the BOTA view, which includes the document outline, bookmarks, and annotation list.

await pdfReaderRef.current?.showBotaView();

showAddWatermarkView ​

Displays the BOTA view, which includes the document outline, bookmarks, and annotation list.

await pdfReaderRef.current?.showAddWatermarkView();

showSecurityView ​

Displays the document security settings view, allowing users to configure document security options.

await pdfReaderRef.current?.showSecurityView();

showDisplaySettingView ​

Displays the display settings view, where users can configure options such as scroll direction, scroll mode, and themes.

await pdfReaderRef.current?.showDisplaySettingView();

enterSnipMode ​

Enters snip mode, allowing users to capture screenshots.

await pdfReaderRef.current?.enterSnipMode();

exitSnipMode ​

Enters snip mode, allowing users to capture screenshots.

await pdfReaderRef.current?.exitSnipMode();

Page ​

setDisplayPageIndex ​

Jump to the index page.

Parameters:

await pdfReaderRef.current?.setDisplayPageIndex(1);

getCurrentPageIndex ​

get current page index.

Returns a Promise.

Promise Parameters:

const pageIndex = await pdfReaderRef.current?.getCurrentPageIndex();

onPageChanged ​

function, optional

This function is called when the page number has been changed.

Parameters:

<CPDFReaderView
	onPageChanged={(pageIndex:number)=>{
	}}
  />

getPageCount ​

Get the total number of pages in the current document

Returns a Promise.

Promise Parameters:

const pageCount = await pdfReaderRef.current?._pdfDocument.getPageCount();

Annotations ​

import Annotations ​

Imports annotations from the specified XFDF file into the current PDF document.

Parameters:

Returns a Promise.

Promise Parameters:

const result = await pdfReaderRef.current.importAnnotations('xxx.xfdf');

export Annotations ​

Exports annotations from the current PDF document to an XFDF file.

Returns a Promise.

Promise Parameters:

const exportXfdfFilePath = await pdfReaderRef.current?.exportAnnotations();

removeAllAnnotations ​

Delete all comments in the current document.

Returns a Promise.

Promise Parameters:

const removeResult = await pdfReaderRef.current?.removeAllAnnotations();

Security ​

isEncrypted ​

Checks if the PDF document is encrypted.

Returns a Promise.

const isEncrypted = await pdfReaderRef.current?._pdfDocument.isEncrypted();

getPermissions ​

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.

const permissions = await pdfReaderRef.current?._pdfDocument.getPermissions();

checkOwnerUnlocked ​

Check if owner permissions are unlocked

Returns a Promise.

const unlocked = await pdfReaderRef.current?._pdfDocument.checkOwnerUnlocked();

checkOwnerPassword ​

Whether the owner password is correct. If the password is correct, the document will be unlocked with full owner permissions.

Parameters:

Returns a Promise.

const check = await pdfReaderRef.current?._pdfDocument.checkOwnerPassword('ownerPassword');

setPassword ​

This method sets the document password, including the user password for access restrictions and the owner password for granting permissions.

• To enable permissions like printing or copying, the owner password must be set; otherwise, the settings will not take effect.

Parameters:

Returns a Promise.

const success = await pdfReaderRef.current?._pdfDocument.setPassword(
  'user_password',
  'owner_password',
  false,
  false,
  CPDFDocumentEncryptAlgo.rc4
);

removePassword ​

Remove the user password and owner permission password. set in the document, and perform an incremental save.

Returns a Promise.

const check = await pdfReaderRef.current?._pdfDocument.checkOwnerPassword('ownerPassword');

getEncryptAlgo ​

Get the encryption algorithm of the current document

Returns a Promise.

const encryptAlgo = await pdfReaderRef.current?._pdfDocument.getEncryptAlgo();