ComPDFKit class

ComPDFKit plugin to load PDF and image documents on both platform iOS and Android.

Constructors

ComPDFKit.new()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

createDocumentInstance(String id) → Future<bool>

createUri(String fileName, {String? childDirectoryName, String mimeType = 'application/pdf'}) → Future<String?>

This method is supported only on the Android platform. It is used to create a URI for saving a file on the Android device. The file is saved in the Downloads directory by default, but you can specify a subdirectory within Downloads using the childDirectoryName parameter. If the childDirectoryName is not provided, the file will be saved directly in the Downloads directory. The fileName parameter is required to specify the name of the file (e.g., test.pdf).

getSDKBuildTag() → Future<String>

Get the version information of ComPDFKit SDK.

getTemporaryDirectory() → Future<Directory>

Retrieve the path of your operating system's temporary directory. Support Android and iOS only for now.

getVersionCode() → Future<String>

Get the version code of the ComPDFKit SDK.

init(String key) → void

Please enter your ComPDFKit license to initialize the ComPDFKit SDK.
This method is used for offline license authentication. In version 1.13.0, we have introduced a brand-new online authentication licensing scheme. By default, the ComPDFKit SDK performs online authentication. If you are unsure about the type of your license, please contact the ComPDFKit team..

initialize({required String androidOnlineLicense, required String iosOnlineLicense}) → void

Please enter your ComPDFKit license to initialize the ComPDFKit SDK.
This method is used for online license authentication In version 1.13.0, we have introduced a brand-new online authentication licensing scheme. By default, the ComPDFKit SDK performs online authentication. If you obtained your ComPDFKit License before the release of version 1.13.0, please use ComPDFKit.init
If you are unsure about the type of your license, please contact the ComPDFKit team..

initWithPath(String licenseFilePath) → void

Initializes the ComPDFKit SDK using a specified license file path.

openDocument(String document, {String? password, CPDFConfiguration? configuration}) → void

Enter the local PDF file path, document password (if required), and configuration parameters, and display the PDF document in a new window.

pickFile() → Future<String?>

removeSignFileList() → Future<bool>

Delete annotated electronic signature file list data for Samples:

setImportFontDir(String dirPath, {bool addSysFont = true}) → Future<bool>

Import font directory and configure whether to include system fonts.