Class CPDFPage

constructor

• new CPDFPage(viewerRef: any, pageIndex: number): CPDFPage

  Parameters

  • viewerRef: any
  • pageIndex: number

  Returns CPDFPage

getAllText

• getAllText(): Promise<string>

  Retrieves all text on the current page.

  Returns Promise<string>

  Example

  const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(0);
  const text = await page?.getAllText();
  Copy

getTextInRect

• getTextInRect(rect: CPDFRectF): Promise<string>

  Retrieves text inside the specified rectangle on the current page.

  Parameters

  • rect: CPDFRectF

    The rectangle in page coordinates.

  Returns Promise<string>

getTextLines

• getTextLines(): Promise<CPDFTextLine[]>

  Retrieves all text lines on the current page.

  Returns Promise<CPDFTextLine[]>

getTextByLine

• getTextByLine(line: CPDFTextLine): Promise<string>

  Retrieves text for a line returned by [getTextLines].

  Parameters

  • line: CPDFTextLine

    The text line to extract.

  Returns Promise<string>

getAnnotations

• getAnnotations(): Promise<CPDFAnnotation[]>

  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.

  Returns Promise<CPDFAnnotation[]>

  A promise that resolves with all annotations on the current page, or an empty array if retrieval fails.

  Example

  const pageIndex = 0;
  const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
  const annotations = await page?.getAnnotations();
  Copy

getWidgets

• getWidgets(): Promise<CPDFWidget[]>

  Retrieves all form widgets on the current page.

  This method fetches all form widgets available on the current page of the PDF document and returns a list of corresponding CPDFWidget instances.

  Returns Promise<CPDFWidget[]>

  A promise that resolves to an array of CPDFWidget instances representing form widgets on the current page. Returns an empty array if retrieval fails. Rejects with an error if the native view reference is unavailable.

  Example

  const pageIndex = 0;
  const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
  const widgets = await page?.getWidgets();
  Copy

  See

  • 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
  • CPDFComboboxWidget - Combo box widget
  • CPDFCheckboxWidget - Checkbox widget

removeAnnotation

• removeAnnotation(annotation: CPDFAnnotation): Promise<boolean>

  Removes an annotation from the current page.

  Parameters

  • annotation: CPDFAnnotation

    The annotation to be removed.

  Returns Promise<boolean>

  Example

  const pageIndex = 0;
  const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
  const annotations = await page?.getAnnotations();
  const annotationToRemove = annotations[0];
  await page?.removeAnnotation(annotationToRemove);
  Copy

removeWidget

• removeWidget(widget: CPDFWidget): Promise<boolean>

  Removes a form widget from the current page.

  Parameters

  • widget: CPDFWidget

    The widget to be removed.

  Returns Promise<boolean>

  A promise that resolves to true when the widget is removed.

  Example

  const pageIndex = 0;
  const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
  const widgets = await page?.getWidgets();
  const widgetToRemove = widgets[0];
  await page?.removeWidget(widgetToRemove);
  Copy

  See

  CPDFWidget - Base class for all form widgets

getRotation

• getRotation(): Promise<number>

  Gets the rotation angle of the current page.

  Returns Promise<number>

  A promise that resolves to the page rotation in degrees.

  Example

  const pageIndex = 0;
  const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
  const rotation = await page?.getRotation();
  Copy

setRotation

• setRotation(rotation: number): Promise<boolean>

  Sets the rotation angle of the current page.

  Parameters

  • rotation: number

    The rotation angle in degrees (0, 90, 180, 270). 360 is treated as 0.

  Returns Promise<boolean>

  A promise that resolves to true when the rotation is applied.

  Example

  const pageIndex = 0;
  const page = pdfReaderRef?.current?._pdfDocument.pageAtIndex(pageIndex);
  const success = await page?.setRotation(90);
  Copy

pageIndex