Foxit PDF SDK  9.1
<IDocEventListener> Protocol Reference

The PDF document event listener. More...

Inheritance diagram for <IDocEventListener>:
FSFileListViewController SignatureModule UIExtensionsManager

Instance Methods

(void) - onDocClosed:error:
 Triggered when the document is closed. More...
 
(void) - onDocLoading:progress:
 Triggered when loading documents. More...
 
(void) - onDocOpened:error:
 Triggered when the document is opened. More...
 
(void) - onDocSaved:error:
 Triggered when the document is saved. More...
 
(void) - onDocWillClose:
 Triggered when the document will be closed. More...
 
(void) - onDocWillOpen
 Triggered when the document will be opened. More...
 
(void) - onDocWillSave:
 Triggered when the document will be saved. More...
 

Detailed Description

The PDF document event listener.

Method Documentation

◆ onDocClosed:error:

- (void) onDocClosed: (FSPDFDoc *_Nullable)  document
error: (int)  error 
optional

Triggered when the document is closed.

Parameters
[in]documentPDF document instance which is closed.
[in]errorError code. Please refer to FSErrorCode::FSErrXXX values and it should be one of these values.

◆ onDocLoading:progress:

- (void) onDocLoading: (FSPDFDoc *)  document
progress: (int)  progress 
optional

Triggered when loading documents.

Parameters
[in]documentPDF document instance which is loading.
[in]progressAn integer between 0 and 100 (inclusive), indicating the rate of current progress. -1 means error.

◆ onDocOpened:error:

- (void) onDocOpened: (FSPDFDoc *_Nullable)  document
error: (int)  error 
optional

Triggered when the document is opened.

Parameters
[in]documentPDF document instance which is opened.
[in]errorError code. Please refer to FSErrorCode::FSErrXXX values and it should be one of these values.

◆ onDocSaved:error:

- (void) onDocSaved: (FSPDFDoc *)  document
error: (int)  error 
optional

Triggered when the document is saved.

Parameters
[in]documentPDF document instance which is saved.
[in]errorError code. Please refer to FSErrorCode::FSErrXXX values and it should be one of these values.

◆ onDocWillClose:

- (void) onDocWillClose: (FSPDFDoc *)  document
optional

Triggered when the document will be closed.

Parameters
[in]documentPDF document instance which will be closed.

◆ onDocWillOpen

- (void) onDocWillOpen
optional

Triggered when the document will be opened.

◆ onDocWillSave:

- (void) onDocWillSave: (FSPDFDoc *)  document
optional

Triggered when the document will be saved.

Parameters
[in]documentPDF document instance which will be saved.