Interface IDocument

Namespace: PSPDFKit.Api

Assembly: Api.dll

Syntax

public interface IDocument

Properties

AnnotationManager

Gets annotation manager for the document.

Declaration

IAnnotationManager AnnotationManager { get; }

Property Value

Type	Description
IAnnotationManager

Methods

CreateExportConfiguration()

Creates a default configuration object for exporting a document as a PDF.

Declaration

IExportConfiguration CreateExportConfiguration()

Returns

Type	Description
IExportConfiguration	Default IExportConfiguration object.

ExecuteJavaScriptFunctionAsync(string, object[])

Execute a function from PSPDFKit for Web's JavaScript API that doesn't return anything.

Declaration

Task ExecuteJavaScriptFunctionAsync(string functionName, object[] args)

Parameters

Type	Name	Description
string	functionName	Name of JavaScript function to be called.
object[]	args	Arguments to be passed to the function.

Returns

Type	Description
Task	A task that represents an asynchronous operation of calling a JavaScript function.

Remarks

To access any member of the current document instance, use PSPDFKit.MAUI.MauiBridge.currentInstance.memberName.

ExecuteJavaScriptFunctionAsync<TReturnType>(string, object[])

Execute a function from PSPDFKit for Web's JavaScript API that returns a value.

Declaration

Task<TReturnType> ExecuteJavaScriptFunctionAsync<TReturnType>(string functionName, object[] args)

Parameters

Type	Name	Description
string	functionName	Name of JavaScript function to be called.
object[]	args	Arguments to be passed to the function.

Returns

Type	Description
Task<TReturnType>	A task that represents an asynchronous operation of calling a JavaScript function.

Type Parameters

Name	Description
TReturnType	Type of return value.

Remarks

To access any member of the current document instance, use PSPDFKit.MAUI.MauiBridge.currentInstance.memberName.

ExportDocumentAsync(IExportConfiguration)

Exports the document contents as a byte array.

Declaration

Task<byte[]> ExportDocumentAsync(IExportConfiguration configuration)

Parameters

Type	Name	Description
IExportConfiguration	configuration	Configuration used for exporting the document.

Returns

Type	Description
Task<byte[]>	A task that represents an asynchronous operation of exporting document, which wraps the byte array containing the contents of the document.