Foxit PDF SDK  9.1
UIExtensionsManager Class Reference

The UI extensions manager which has included the default implementation of text selection tool, annotation tools... and so on. More...

Inheritance diagram for UIExtensionsManager:
<IUIInteractionEventListener> <ISignatureEventListener> <ILinkEventListener> <IRecoveryEventListener> <IAnnotEventListener> <IRotationEventListener> <IPageEventListener> <IDocEventListener> <FSPDFUIExtensionsManager>

Instance Methods

(void) - changeState:
 Change state of extensions manager. It is only be supported after the document is opened. More...
 
(void) - documentSaveAS:error:
 Save the file to the specified location. More...
 
(void) - enableBottomToolbar:
 Enable or disable bottom toolbar.No effect on bottom toolbar in full screen mode. More...
 
(void) - enableModification:
 Set whether the pdf document can be modified. The default is allow modification. More...
 
(void) - enableSmallBottomToolbar:
 Enable or disable small bottom toolbar. More...
 
(void) - enableSmallTopToolbar:
 Enable or disable small top toolbar. More...
 
(void) - enableTopToolbar:
 Enable or disable top toolbar.No effect on top toolbar in full screen mode. More...
 
(id< IAnnotHandler >) - getAnnotHandlerByType:
 Get the annotation handler by annotation type. More...
 
(NSString *) - getCurrentSelectedText
 Get current selected text. More...
 
(__kindof id< IModule >) - getModuleByName:
 Get the module by module name. More...
 
(FSReadToolSettings *) - getReadToolSettingsForType:
 Get t tool settings. More...
 
(FSUIManagerState- getState
 Get state of extensions manager. More...
 
(NSMutableDictionary *) - getToolbarItemHiddenStatus
 Get toolbar item hide/show status. More...
 
(id< IToolHandler >) - getToolHandlerByName:
 Get the current tool handler by name, which is defined above Tool_XXX. More...
 
(id) - initWithPDFViewControl:
 Intialize extensions manager. More...
 
(id) - initWithPDFViewControl:configuration:
 Intialize extensions manager. More...
 
(id) - initWithPDFViewControl:configurationObject:
 Intialize extensions manager. More...
 
(void) - registerAnnotEventListener:
 Register the annotation event listener. More...
 
(void) - registerAnnotHandler:
 Register an annotation handler. More...
 
(void) - registerDocModifiedEventListener:
 Register the document modified event listener. More...
 
(void) - registerFullScreenListener:
 Register a full screen event listener. More...
 
(void) - registerLinkEventListener:
 Register the link event listener. More...
 
(void) - registerPageNumberListener:
 Register a page number event listener. More...
 
(void) - registerRotateChangedListener:
 Register a rotation event listener. More...
 
(void) - registerSearchEventListener:
 Register the tool event listener. More...
 
(void) - registerSignatureEventListener:
 Register the signature event listener. More...
 
(void) - registerToolEventListener:
 Register the tool event listener. More...
 
(void) - registerToolHandler:
 Register a tool handler. More...
 
(void) - registerUIInteractionEventListener:
 Register the UI Interaction event listener. More...
 
(void) - resumeAutoFullScreen
 Resume the auto full screen mode. More...
 
(void) - setFullScreen:
 Enter or exit full screen mode. More...
 
(void) - setMoreItemClikedCallback:
 Set the callback method of more Item Clicked. More...
 
(void) - setToolbarItemHiddenWithTag:hidden:
 Set mainToolbar item hide/show. More...
 
(void) - showPropertyWithToolSettings:rect:inView:
 Show the property bar to set annotation color and opacity. More...
 
(void) - showSearchBar:
 Show or hide the text searching bar on the UI main screen. It will appear on the top of main screen. More...
 
(void) - suspendAutoFullScreen
 Suspend the auto full screen mode. More...
 
(void) - unregisterAnnotEventListener:
 Unregister the annotation event listener. More...
 
(void) - unregisterAnnotHandler:
 Remove an annotation handler. More...
 
(void) - unregisterDocModifiedEventListener:
 Unregister the document modified event listener. More...
 
(void) - unregisterFullScreenListener:
 Unregister a full screen event listener. More...
 
(void) - unregisterLinkEventListener:
 Unregister the link event listener. More...
 
(void) - unregisterPageNumerListener:
 Unregister a page number event listener. More...
 
(void) - unregisterRotateChangedListener:
 Unregister a rotation event listener. More...
 
(void) - unregisterSearchEventListener:
 Unregister the tool event listener. More...
 
(void) - unregisterSignatureEventListener:
 Unregister the signature event listener. More...
 
(void) - unregisterToolEventListener:
 Unregister the tool event listener. More...
 
(void) - unregisterToolHandler:
 Remove a tool handler. More...
 
(void) - unregisterUIInteractionEventListener:
 Unregister the UI Interaction event listener. More...
 
- Instance Methods inherited from <FSPDFUIExtensionsManager>
(BOOL) - shouldDrawAnnot:
 Whether the view control should draw this annotation or not. More...
 
- Instance Methods inherited from <IGestureEventListener>
(BOOL) - onDoubleTap:
 Triggered on the double tap gesture. More...
 
(BOOL) - onLongPress:
 Triggered on long press gesture. More...
 
(BOOL) - onPageGestureRecognizer:gestureRecognizer:shouldReceiveTouch:
 Called before touchesBegan:withEvent: is called on the gesture recognizer for a new touch. return NO to prevent the gesture recognizer from seeing this touch. More...
 
(BOOL) - onPan:
 Triggered on the pan gesture. More...
 
(BOOL) - onShouldBegin:
 Triggered when a gesture recognizer attempts to transition out of UIGestureRecognizerStatePossible. More...
 
(BOOL) - onTap:
 Triggered on the tap gesture. More...
 
- Instance Methods inherited from <IDrawEventListener>
(void) - onDraw:inContext:
 Triggered when drawing on a specified page. More...
 
- Instance Methods inherited from <ITouchEventListener>
(BOOL) - onTouchesBegan:withEvent:
 Triggered when the touches began. More...
 
(BOOL) - onTouchesCancelled:withEvent:
 Triggered when the touches has been canceled. More...
 
(BOOL) - onTouchesEnded:withEvent:
 Triggered when the touches has ended. More...
 
(BOOL) - onTouchesMoved:withEvent:
 Triggered when the touches has moved. More...
 
- Instance Methods inherited from <IDocEventListener>
(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...
 
- Instance Methods inherited from <IPageEventListener>
(void) - onPageChanged:currentIndex:
 Triggered when current page is changed. More...
 
(void) - onPageInvisible:
 Triggered when the page becomes invisible. More...
 
(void) - onPageJumped
 Triggered by the page navigation or link jump. More...
 
(void) - onPagesFlattened:
 Triggered when page were flattened. More...
 
(void) - onPagesInsertedAtRange:
 Triggered when pages were inserted. More...
 
(void) - onPagesMoved:dstIndex:
 Triggered when pages were moved to a new index. More...
 
(void) - onPagesRemoved:
 Triggered when pages were removed. More...
 
(void) - onPagesRotated:rotation:
 Triggered when pages were rotated. More...
 
(void) - onPagesWillFlatten:
 Triggered when page will be flattened. More...
 
(void) - onPagesWillMove:dstIndex:
 Triggered when pages will be moved to a new index. More...
 
(void) - onPagesWillRemove:
 Triggered when pages will be removed. More...
 
(void) - onPagesWillRotate:rotation:
 Triggered when pages will be rotated. More...
 
(void) - onPageVisible:
 Triggered when the page becomes visible. More...
 
- Instance Methods inherited from <IRotationEventListener>
(void) - didRotateFromInterfaceOrientation:
 Triggered after rotation is done. More...
 
(void) - willAnimateRotationToInterfaceOrientation:duration:
 Triggered when animated rotation begins. More...
 
(void) - willRotateToInterfaceOrientation:duration:
 Triggered when rotation begins. More...
 
- Instance Methods inherited from <IAnnotEventListener>
(void) - onAnnotAdded:annot:
 Triggered when the annotation is added. More...
 
(void) - onAnnotDeleted:annot:
 Triggered when the annotation is deleted. More...
 
(void) - onAnnotDeselected:annot:
 Triggered when the annotation is deselected. More...
 
(void) - onAnnotFlattened:annot:
 Triggered when the annotation is flattened. More...
 
(void) - onAnnotModified:annot:
 Triggered when the annotation is modified. More...
 
(void) - onAnnotsAdded:
 Triggered when the annotations are added. More...
 
(void) - onAnnotSelected:annot:
 Triggered when the annotation is selected. More...
 
(void) - onAnnotsWillDelete:
 Triggered before the annotations will be deleted. More...
 
(void) - onAnnotWillDelete:annot:
 Triggered before the annotation is deleted. More...
 
(void) - onAnnotWillFlatten:annot:
 Triggered before the annotation is flattened. More...
 
- Instance Methods inherited from <IRecoveryEventListener>
(void) - onRecovered
 Triggered after the view control has recovered from running out of memory. More...
 
(void) - onWillRecover
 Triggered before recovering the view control. More...
 
- Instance Methods inherited from <ISignatureEventListener>
(BOOL) - canReplaceDigitalSignatureOriginalFile:
 Whether the digital signature can replace the original file. More...
 
(void) - onDigitalSignatureSigned:
 Triggered when a digital signature is signed. More...
 
(void) - onDigitalSignatureSigned:originalDoc:outputPath:
 Triggered when a digital signature is signed. More...
 
- Instance Methods inherited from <IUIInteractionEventListener>
(void) - onUIInteractElementClicked:
 Triggered when ui interaction element will be clicked. More...
 

Class Methods

(NSSet< UIExtensionsManager * > *) + openedExtensionsManagers
 
(void) + printDoc:animated:inWindow:jobName:delegate:completionHandler:
 Print the document by displaying an UI to select printer. More...
 
(void) + printDoc:fromRect:inView:animated:inWindow:jobName:delegate:completionHandler:
 Print the rect in the specified view by displaying an UI to select printer. More...
 

Properties

id< FSActionCallbackactionHandler
 The Current action handler. More...
 
NSMutableDictionary< NSNumber *, FSReadToolSettings * > * addToolsSettings
 Get/set settings on add tools .If set to nil, it will be automatically created using default config. More...
 
NSString * annotAuthor
 Set/get annot author. More...
 
id< FSAnnotsPermissionDelegateannotsPermissionDelegate
 Delegate of annotations permission. If set, once one of the implementation results is false, the form function will be disabled. More...
 
FSAppInfoProviderappInfoProvider
 Set/Get the app Info provider. More...
 
FSMainBottombarbottomToolbar
 The Current UIExtensionsManager bottomToolbar. More...
 
BOOL canUpdateAnnotDefaultProperties
 Can update annot default properties, default is yes. More...
 
BOOL continueAddAnnot
 Whether to keep tool active after using it to add an annotation. More...
 
FSAnnotcurrentAnnot
 The Current selected annotation. More...
 
UIExtensionsManagercurrentExtManager
 
id< IToolHandlercurrentToolHandler
 The Current tool handler. More...
 
FSXFAWidgetcurrentWidget
 The Current selected xfa widget. More...
 
id< UIExtensionsManagerDelegatedelegate
 Delegate of UI extensions manager. More...
 
BOOL disableFingerWhenLinkApplePencil
 Whether to disable finger add ink type annotation when linking to Apple Pencil . The default is YES. More...
 
FSPDFDocSaveFlags docSaveFlag
 The Current doc save flag. More...
 
BOOL enableHighlightForm
 Whether to allow to highlight form and call -[FSPDFViewCtrl Refresh] if you want to take effect immediately. More...
 
BOOL enableHighlightLinks
 Whether to allow to highlight links. More...
 
BOOL enableLinks
 Whether to allow to jump to link address when tap on the link annotation. More...
 
id< FSExtFileOpenDelegateextFileOpenDelegate
 Delegate for opening external file . More...
 
void(^ goBack )(void)
 Caller can choose to provide a block to execute when user tap on 'back' button on the top toolbar. More...
 
UIColor * highlightFormColor
 Get/Set the highlight color for form and call -[FSPDFViewCtrl Refresh] if you want to take effect immediately. More...
 
BOOL isAutoSaveDoc
 Set to automatically save documents Yes/No. More...
 
BOOL isAutoSaveSignedDoc
 Set to automatically save the signed document Yes/No. More...
 
BOOL isDocModified
 Whether the current document is modified or not. More...
 
BOOL isFullScreen
 Whether is full screen. When full screen, top and bottom bar is not shown. More...
 
BOOL isMultiFileMode
 Whether the preview mode is multiple file mode. More...
 
BOOL isScreenLocked
 Whether screen rotation is locked or not. More...
 
UIColor * linksHighlightColor
 Get/Set the highlight color for links. More...
 
FSMeasurementUnits measurementUnits
 Measurement units for page size information. The default is inch. More...
 
id< FSMenuControlDelegatemenuControlDelegate
 Delegate of menucontrol. More...
 
FSMenuViewManagermenuViewManager
 The custom view manager . More...
 
MoreMenuViewmore
 The more menu View. More...
 
FSPanelControllerpanelController
 The panel controller. More...
 
FSPDFViewCtrlpdfViewCtrl
 The PDF view control. More...
 
id< IFSPermissionProviderpermissionProvider
 Permission provider. More...
 
UIStatusBarStyle preferredStatusBarStyle
 The controller preferred status bar style for UIExtensionsManager. The default is UIStatusBarStyleDefault. More...
 
BOOL prefersStatusBarHidden
 Whether the PDF view hide the status bar. More...
 
NSString * preventOverrideFilePath
 Prevent to override original pdf file. More...
 
UIColor * primaryColor
 Get/Set the primary color The default is #923094. More...
 
UIColor * selectionHighlightColor
 Get/Set the highlight color for text selection. More...
 
FSSettingBarsettingBar
 The setting bar. It shows when tap on the view button in the bottom bar. More...
 
NSString * signedDocSavePath
 Set/Get the full PDF file path where the signed document is saved and it works when set to automatically save the signed document. More...
 
UIColor * stateBarColor
 Get/Set the stateBar color. More...
 
FSMainTopbartopToolbar
 The Current UIExtensionsManager topToolbar. More...
 
BOOL useLogicalPageNumbers
 Whether to use logical page numbers. The default is NO. More...
 

Detailed Description

The UI extensions manager which has included the default implementation of text selection tool, annotation tools... and so on.

Method Documentation

◆ changeState:

- (void) changeState: (FSUIManagerState state

Change state of extensions manager. It is only be supported after the document is opened.

Parameters
[in]stateNew state. Please refer to FSUIManagerStateXXX and FSUIManagerState values and it would be one of these values.

◆ documentSaveAS:error:

- (void) documentSaveAS: (void(^)(void))  successed
error: (void(^)(void))  error 

Save the file to the specified location.

Parameters
[in]successedcallback.
[in]errorcallback.

◆ enableBottomToolbar:

- (void) enableBottomToolbar: (BOOL)  isEnabled

Enable or disable bottom toolbar.No effect on bottom toolbar in full screen mode.

Parameters
[in]isEnabledWhether bottom toolbar is enabled or not.

◆ enableModification:

- (void) enableModification: (BOOL)  isEnabled

Set whether the pdf document can be modified. The default is allow modification.

Parameters
[in]isEnabledWhether the pdf document can be modified.

◆ enableSmallBottomToolbar:

- (void) enableSmallBottomToolbar: (BOOL)  isEnabled

Enable or disable small bottom toolbar.

Parameters
[in]isEnabledWhether small bottom toolbar is enabled or not.

◆ enableSmallTopToolbar:

- (void) enableSmallTopToolbar: (BOOL)  isEnabled

Enable or disable small top toolbar.

Parameters
[in]isEnabledWhether small top toolbar is enabled or not.

◆ enableTopToolbar:

- (void) enableTopToolbar: (BOOL)  isEnabled

Enable or disable top toolbar.No effect on top toolbar in full screen mode.

Parameters
[in]isEnabledWhether top toolbar is enabled or not.

◆ getAnnotHandlerByType:

- (id<IAnnotHandler>) getAnnotHandlerByType: (FSAnnotType type

Get the annotation handler by annotation type.

Parameters
[in]typeThe type of annotation. Please refer to FSAnnotType values and it would be one of these values.
Returns
The annotation handler .

◆ getCurrentSelectedText

- (NSString *) getCurrentSelectedText

Get current selected text.

Returns
The current selected text.

◆ getModuleByName:

- (__kindof id<IModule>) getModuleByName: (FSModuleStringName)  name

Get the module by module name.

Returns
id<IModule> The id<IModule>;

◆ getReadToolSettingsForType:

- (FSReadToolSettings *) getReadToolSettingsForType: (FSReadToolSettingsType settingsType

Get t tool settings.

Parameters
[in]settingsTypeThe type of settings. Please refer to FSReadToolSettingsTypeXXX values and it would be one of these values.
Returns
FSReadToolSettings ,If the default tool settings ;

◆ getState

- (FSUIManagerState) getState

Get state of extensions manager.

Returns
The current state. Please refer to FSUIManagerStateXXX and FSUIManagerState values and it would be one of these values.

◆ getToolbarItemHiddenStatus

- (NSMutableDictionary *) getToolbarItemHiddenStatus

Get toolbar item hide/show status.

Returns
The toolbar item hide/show status dictionary.

◆ getToolHandlerByName:

- (id<IToolHandler>) getToolHandlerByName: (NSString *)  name

Get the current tool handler by name, which is defined above Tool_XXX.

Parameters
[in]nameThe name of tool handler.
Returns
The tool handler .

◆ initWithPDFViewControl:

- (id) initWithPDFViewControl: (FSPDFViewCtrl *)  viewctrl

Intialize extensions manager.

Parameters
[in]viewctrlThe PDF view control.
Returns
The extensions mananger instance.

◆ initWithPDFViewControl:configuration:

- (id) initWithPDFViewControl: (FSPDFViewCtrl *)  viewctrl
configuration: (NSData *_Nullable)  jsonConfigData 

Intialize extensions manager.

Parameters
[in]viewctrlThe PDF view control.
[in]jsonConfigDataThe json file data. See uiextensions_config.json for an example
Returns
The extensions mananger instance.

◆ initWithPDFViewControl:configurationObject:

- (id) initWithPDFViewControl: (FSPDFViewCtrl *)  viewctrl
configurationObject: (UIExtensionsConfig *_Nonnull)  configuration 

Intialize extensions manager.

Parameters
[in]viewctrlThe PDF view control.
[in]configurationThe modules configuration.
Returns
The extensions mananger instance.

◆ openedExtensionsManagers

+ (NSSet<UIExtensionsManager *> *) openedExtensionsManagers

◆ printDoc:animated:inWindow:jobName:delegate:completionHandler:

+ (void) printDoc: (FSPDFDoc *)  doc
animated: (BOOL)  animated
inWindow: (UIWindow *)  window
jobName: (nullable NSString *)  jobName
delegate: (nullable id< UIPrintInteractionControllerDelegate >)  delegate
completionHandler: (nullable UIPrintInteractionCompletionHandler)  completion 

Print the document by displaying an UI to select printer.

Parameters
[in]docThe pdf document.
[in]animatedUse animation or not .
[in]jobNameThe printing job name.
[in]delegateThe delegate for printing.
[in]completionA completion handler to be invoked after printing job is done.

◆ printDoc:fromRect:inView:animated:inWindow:jobName:delegate:completionHandler:

+ (void) printDoc: (FSPDFDoc *)  doc
fromRect: (CGRect)  rect
inView: (UIView *)  view
animated: (BOOL)  animated
inWindow: (UIWindow *)  window
jobName: (nullable NSString *)  jobName
delegate: (nullable id< UIPrintInteractionControllerDelegate >)  delegate
completionHandler: (nullable UIPrintInteractionCompletionHandler)  completion 

Print the rect in the specified view by displaying an UI to select printer.

Parameters
[in]docThe pdf document.
[in]rectThe rectangle area in the specified UIView.
[in]viewThe specified UIView.
[in]animatedUse animation or not .
[in]jobNameThe printing job name.
[in]delegateThe delegate for printing.
[in]completionA completion handler to be invoked after printing job is done.

◆ registerAnnotEventListener:

- (void) registerAnnotEventListener: (id< IAnnotEventListener >)  listener

Register the annotation event listener.

Parameters
[in]listenerThe annot event listener.

◆ registerAnnotHandler:

- (void) registerAnnotHandler: (id< IAnnotHandler >)  annotHandler

Register an annotation handler.

Parameters
[in]annotHandlerThe annot handler.

◆ registerDocModifiedEventListener:

- (void) registerDocModifiedEventListener: (id< IDocModifiedEventListener >)  listener

Register the document modified event listener.

Parameters
[in]listenerThe document modified event listener.

◆ registerFullScreenListener:

- (void) registerFullScreenListener: (id< IFullScreenListener >)  listener

Register a full screen event listener.

Parameters
[in]listenerThe Full Screen Listener.

◆ registerLinkEventListener:

- (void) registerLinkEventListener: (id< ILinkEventListener >)  listener

Register the link event listener.

Parameters
[in]listenerThe link event listener.

◆ registerPageNumberListener:

- (void) registerPageNumberListener: (id< IPageNumberListener >)  listener

Register a page number event listener.

Parameters
[in]listenerThe Page Number Listener.

◆ registerRotateChangedListener:

- (void) registerRotateChangedListener: (id< IRotationEventListener >)  listener

Register a rotation event listener.

Parameters
[in]listenerThe Rotation Event Listener.

◆ registerSearchEventListener:

- (void) registerSearchEventListener: (id< ISearchEventListener >)  listener

Register the tool event listener.

Parameters
[in]listenerThe search event listener.

◆ registerSignatureEventListener:

- (void) registerSignatureEventListener: (id< ISignatureEventListener >)  listener

Register the signature event listener.

Parameters
[in]listenerThe signature event listener.

◆ registerToolEventListener:

- (void) registerToolEventListener: (id< IToolEventListener >)  listener

Register the tool event listener.

Parameters
[in]listenerThe tool event listener.

◆ registerToolHandler:

- (void) registerToolHandler: (id< IToolHandler >)  toolHandler

Register a tool handler.

Parameters
[in]toolHandlerThe tool handler.

◆ registerUIInteractionEventListener:

- (void) registerUIInteractionEventListener: (id< IUIInteractionEventListener >)  listener

Register the UI Interaction event listener.

Parameters
[in]listenerThe UI Interaction event listener.

◆ resumeAutoFullScreen

- (void) resumeAutoFullScreen

Resume the auto full screen mode.

◆ setFullScreen:

- (void) setFullScreen: (BOOL)  fullScreen

Enter or exit full screen mode.

Parameters
[in]fullScreenBoolean flag to indicate whether to enter full screen mode or not.

◆ setMoreItemClikedCallback:

- (void) setMoreItemClikedCallback: (void(^)(UIView *moreItem))  clickedCallback

Set the callback method of more Item Clicked.

Parameters
[in]clickedCallbackthe callback method

◆ setToolbarItemHiddenWithTag:hidden:

- (void) setToolbarItemHiddenWithTag: (FS_TOOLBAR_ITEM_TAG)  itemTag
hidden: (BOOL)  isHidden 

Set mainToolbar item hide/show.

Currently, if the itemTag is just one of following formats, FS_TOOLBAR_ITEM_TAG_XXX, For other unsupported itemTag, this function will do nothing change.

Parameters
[in]itemTagThe item tag will show/hide.
[in]isHiddenThe item show/hide .

◆ showPropertyWithToolSettings:rect:inView:

- (void) showPropertyWithToolSettings: (FSReadToolSettings *)  toolSettings
rect: (CGRect)  rect
inView: (UIView *)  view 

Show the property bar to set annotation color and opacity.

Parameters
[in]toolSettingsTool settings item
[in]rectThe rect of property bar.
[in]viewThe view that property bar belong.

◆ showSearchBar:

- (void) showSearchBar: (BOOL)  show

Show or hide the text searching bar on the UI main screen. It will appear on the top of main screen.

Parameters
[in]showThe search bar show/hide.

◆ suspendAutoFullScreen

- (void) suspendAutoFullScreen

Suspend the auto full screen mode.

◆ unregisterAnnotEventListener:

- (void) unregisterAnnotEventListener: (id< IAnnotEventListener >)  listener

Unregister the annotation event listener.

Parameters
[in]listenerThe annot event listener.

◆ unregisterAnnotHandler:

- (void) unregisterAnnotHandler: (id< IAnnotHandler >)  annotHandler

Remove an annotation handler.

Parameters
[in]annotHandlerThe annot handler.

◆ unregisterDocModifiedEventListener:

- (void) unregisterDocModifiedEventListener: (id< IDocModifiedEventListener >)  listener

Unregister the document modified event listener.

Parameters
[in]listenerThe document modified event listener.

◆ unregisterFullScreenListener:

- (void) unregisterFullScreenListener: (id< IFullScreenListener >)  listener

Unregister a full screen event listener.

Parameters
[in]listenerThe Full Screen Listener.

◆ unregisterLinkEventListener:

- (void) unregisterLinkEventListener: (id< ILinkEventListener >)  listener

Unregister the link event listener.

Parameters
[in]listenerThe link event listener.

◆ unregisterPageNumerListener:

- (void) unregisterPageNumerListener: (id< IPageNumberListener >)  listener

Unregister a page number event listener.

Parameters
[in]listenerThe Page Number Listener.

◆ unregisterRotateChangedListener:

- (void) unregisterRotateChangedListener: (id< IRotationEventListener >)  listener

Unregister a rotation event listener.

Parameters
[in]listenerThe Rotation Event Listener.

◆ unregisterSearchEventListener:

- (void) unregisterSearchEventListener: (id< ISearchEventListener >)  listener

Unregister the tool event listener.

Parameters
[in]listenerThe search event listener.

◆ unregisterSignatureEventListener:

- (void) unregisterSignatureEventListener: (id< ISignatureEventListener >)  listener

Unregister the signature event listener.

Parameters
[in]listenerThe signature event listener.

◆ unregisterToolEventListener:

- (void) unregisterToolEventListener: (id< IToolEventListener >)  listener

Unregister the tool event listener.

Parameters
[in]listenerThe tool event listener.

◆ unregisterToolHandler:

- (void) unregisterToolHandler: (id< IToolHandler >)  toolHandler

Remove a tool handler.

Parameters
[in]toolHandlerThe tool handler.

◆ unregisterUIInteractionEventListener:

- (void) unregisterUIInteractionEventListener: (id< IUIInteractionEventListener >)  listener

Unregister the UI Interaction event listener.

Parameters
[in]listenerThe UI Interaction event listener.

Property Documentation

◆ actionHandler

- (id<FSActionCallback>) actionHandler
readwritenonatomicstrong

The Current action handler.

◆ addToolsSettings

- (NSMutableDictionary<NSNumber *, FSReadToolSettings *>*) addToolsSettings
readwritenonatomicstrong

Get/set settings on add tools .If set to nil, it will be automatically created using default config.

◆ annotAuthor

- (NSString*) annotAuthor
readwritenonatomiccopy

Set/get annot author.

◆ annotsPermissionDelegate

- (id<FSAnnotsPermissionDelegate>) annotsPermissionDelegate
readwritenonatomicweak

Delegate of annotations permission. If set, once one of the implementation results is false, the form function will be disabled.

◆ appInfoProvider

- (FSAppInfoProvider*) appInfoProvider
readwritenonatomicstrong

Set/Get the app Info provider.

◆ bottomToolbar

- (FSMainBottombar*) bottomToolbar
readnonatomicstrong

The Current UIExtensionsManager bottomToolbar.

◆ canUpdateAnnotDefaultProperties

- (BOOL) canUpdateAnnotDefaultProperties
readwritenonatomicassign

Can update annot default properties, default is yes.

◆ continueAddAnnot

- (BOOL) continueAddAnnot
readwritenonatomicassign

Whether to keep tool active after using it to add an annotation.

◆ currentAnnot

- (FSAnnot*) currentAnnot
readwritenonatomicstrong

The Current selected annotation.

◆ currentExtManager

- (UIExtensionsManager*) currentExtManager
readwritenonatomicweak

◆ currentToolHandler

- (id<IToolHandler>) currentToolHandler
readwritenonatomicstrong

The Current tool handler.

◆ currentWidget

- (FSXFAWidget*) currentWidget
readwritenonatomicstrong

The Current selected xfa widget.

◆ delegate

- (id<UIExtensionsManagerDelegate>) delegate
readwritenonatomicweak

Delegate of UI extensions manager.

◆ disableFingerWhenLinkApplePencil

- (BOOL) disableFingerWhenLinkApplePencil
readwritenonatomicassign

Whether to disable finger add ink type annotation when linking to Apple Pencil . The default is YES.

◆ docSaveFlag

- (FSPDFDocSaveFlags) docSaveFlag
readwritenonatomicassign

The Current doc save flag.

◆ enableHighlightForm

- (BOOL) enableHighlightForm
readwritenonatomicassign

Whether to allow to highlight form and call -[FSPDFViewCtrl Refresh] if you want to take effect immediately.

◆ enableHighlightLinks

- (BOOL) enableHighlightLinks
readwritenonatomicassign

Whether to allow to highlight links.

◆ enableLinks

- (BOOL) enableLinks
readwritenonatomicassign

Whether to allow to jump to link address when tap on the link annotation.

◆ extFileOpenDelegate

- (id<FSExtFileOpenDelegate>) extFileOpenDelegate
readwritenonatomicweak

Delegate for opening external file .

◆ goBack

- (void(^ goBack) (void))
readwritenonatomiccopy

Caller can choose to provide a block to execute when user tap on 'back' button on the top toolbar.

◆ highlightFormColor

- (UIColor*) highlightFormColor
readwritenonatomicstrong

Get/Set the highlight color for form and call -[FSPDFViewCtrl Refresh] if you want to take effect immediately.

◆ isAutoSaveDoc

- (BOOL) isAutoSaveDoc
readwritenonatomicassign

Set to automatically save documents Yes/No.

◆ isAutoSaveSignedDoc

- (BOOL) isAutoSaveSignedDoc
readwritenonatomicassign

Set to automatically save the signed document Yes/No.

◆ isDocModified

- (BOOL) isDocModified
readwritenonatomicassign

Whether the current document is modified or not.

◆ isFullScreen

- (BOOL) isFullScreen
readwritenonatomicassign

Whether is full screen. When full screen, top and bottom bar is not shown.

◆ isMultiFileMode

- (BOOL) isMultiFileMode
readwritenonatomicassign

Whether the preview mode is multiple file mode.

◆ isScreenLocked

- (BOOL) isScreenLocked
readnonatomicassign

Whether screen rotation is locked or not.

◆ linksHighlightColor

- (UIColor*) linksHighlightColor
readwritenonatomicstrong

Get/Set the highlight color for links.

◆ measurementUnits

- (FSMeasurementUnits) measurementUnits
readwritenonatomicassign

Measurement units for page size information. The default is inch.

◆ menuControlDelegate

- (id<FSMenuControlDelegate>) menuControlDelegate
readwritenonatomicweak

Delegate of menucontrol.

◆ menuViewManager

- (FSMenuViewManager*) menuViewManager
readnonatomicstrong

The custom view manager .

◆ more

- (MoreMenuView*) more
readnonatomicstrong

The more menu View.

◆ panelController

- (FSPanelController*) panelController
readwritenonatomicstrong

The panel controller.

◆ pdfViewCtrl

- (FSPDFViewCtrl*) pdfViewCtrl
readnonatomicstrong

The PDF view control.

◆ permissionProvider

- (id<IFSPermissionProvider>) permissionProvider
readwritenonatomicstrong

Permission provider.

◆ preferredStatusBarStyle

- (UIStatusBarStyle) preferredStatusBarStyle
readwritenonatomicassign

The controller preferred status bar style for UIExtensionsManager. The default is UIStatusBarStyleDefault.

◆ prefersStatusBarHidden

- (BOOL) prefersStatusBarHidden
readnonatomicassign

Whether the PDF view hide the status bar.

◆ preventOverrideFilePath

- (NSString*) preventOverrideFilePath
readwritenonatomicstrong

Prevent to override original pdf file.

◆ primaryColor

- (UIColor*) primaryColor
readwritenonatomicstrong

Get/Set the primary color The default is #923094.

◆ selectionHighlightColor

- (UIColor*) selectionHighlightColor
readwritenonatomicstrong

Get/Set the highlight color for text selection.

◆ settingBar

- (FSSettingBar*) settingBar
readwritenonatomicstrong

The setting bar. It shows when tap on the view button in the bottom bar.

◆ signedDocSavePath

- (NSString*) signedDocSavePath
readwritenonatomicstrong

Set/Get the full PDF file path where the signed document is saved and it works when set to automatically save the signed document.

◆ stateBarColor

- (UIColor*) stateBarColor
readwritenonatomicstrong

Get/Set the stateBar color.

◆ topToolbar

- (FSMainTopbar*) topToolbar
readnonatomicstrong

The Current UIExtensionsManager topToolbar.

◆ useLogicalPageNumbers

- (BOOL) useLogicalPageNumbers
readwritenonatomicassign

Whether to use logical page numbers. The default is NO.