Foxit PDF SDK  9.1
FSReadToolSettings Class Reference
Inheritance diagram for FSReadToolSettings:
SettingObj

Instance Methods

(instancetype) - initWithToolSettingType:
 Initialization method. More...
 
(instancetype) - initWithToolSettingType:extensionsManager:
 Initialization method. More...
 

Properties

int attachmentIcon
 Set/Get the stamp icon.Only FSReadToolSettingsTypeAttachments is effective. If it doesn't exist, it will be -1. More...
 
NSString * distanceUnit
 Set/Get the measure unit.Only FSReadToolSettingsTypeMeasure is effective. If it doesn't exist, it will be nil. More...
 
float eraserLineWidth
 Set/Get the eraser line width.Only FSReadToolSettingsTypeEraser is effective. If it doesn't exist, it will be -1. More...
 
int noteIcon
 Set/Get the note icon.Only FSReadToolSettingsTypeNote is effective. If it doesn't exist, it will be -1. More...
 
FSRotation screenAnnotRotation
 Set/Get the screen rotation.Only FSReadToolSettingsTypeImageAnnotation is effective. If it doesn't exist, it will be FSRotationUnknown. More...
 
unsigned int settingsColor
 Get the settings color. If it doesn't exist, it will be 0. More...
 
FSReadToolSettingsType settingsType
 Get the read tool item type. Please refer to {@linkFSReadToolSettingsTypeXXX} and FSReadToolSettingsType values and it would be one of these values.. More...
 
int stampIcon
 Set/Get the note icon.Only FSReadToolSettingsTypeStamp is effective. If it doesn't exist, it will be -1. More...
 
- Properties inherited from SettingObj
UIColor * color
 
BOOL customText
 
UIColor * fillColor
 
NSString * icon
 
BOOL multipleSelection
 
CGFloat opacity
 
unsigned int rotation
 
NSString * scaleFromUnit
 
unsigned int scaleFromValue
 
NSString * scaleToUnit
 
unsigned int scaleToValue
 
UIColor * textColor
 
NSString * textFace
 
CGFloat textSize
 
float thickness
 

Method Documentation

◆ initWithToolSettingType:

- (instancetype) initWithToolSettingType: (FSReadToolSettingsType type

Initialization method.

Parameters
[in]typeThe read tool item type.Please refer to {@linkFSReadToolSettingsTypeXXX} and FSReadToolSettingsType values and it would be one of these values.
Returns
The read tool settings.

◆ initWithToolSettingType:extensionsManager:

- (instancetype) initWithToolSettingType: (FSReadToolSettingsType type
extensionsManager: (UIExtensionsManager *)  extensionsManager 

Initialization method.

Parameters
[in]typeThe read tool item type.Please refer to {@linkFSReadToolSettingsTypeXXX} and FSReadToolSettingsType values and it would be one of these values.
[in]extensionsManagerThe current UIExtensionsManager object. The default configuration in UIExtensionsManager will be used.
Returns
The read tool settings.

Property Documentation

◆ attachmentIcon

- (int) attachmentIcon
readwritenonatomicassign

Set/Get the stamp icon.Only FSReadToolSettingsTypeAttachments is effective. If it doesn't exist, it will be -1.

◆ distanceUnit

- (NSString*) distanceUnit
readwritenonatomiccopy

Set/Get the measure unit.Only FSReadToolSettingsTypeMeasure is effective. If it doesn't exist, it will be nil.

◆ eraserLineWidth

- (float) eraserLineWidth
readwritenonatomicassign

Set/Get the eraser line width.Only FSReadToolSettingsTypeEraser is effective. If it doesn't exist, it will be -1.

◆ noteIcon

- (int) noteIcon
readwritenonatomicassign

Set/Get the note icon.Only FSReadToolSettingsTypeNote is effective. If it doesn't exist, it will be -1.

◆ screenAnnotRotation

- (FSRotation) screenAnnotRotation
readwritenonatomicassign

Set/Get the screen rotation.Only FSReadToolSettingsTypeImageAnnotation is effective. If it doesn't exist, it will be FSRotationUnknown.

◆ settingsColor

- (unsigned int) settingsColor
readnonatomicassign

Get the settings color. If it doesn't exist, it will be 0.

◆ settingsType

- (FSReadToolSettingsType) settingsType
readnonatomicassign

Get the read tool item type. Please refer to {@linkFSReadToolSettingsTypeXXX} and FSReadToolSettingsType values and it would be one of these values..

◆ stampIcon

- (int) stampIcon
readwritenonatomicassign

Set/Get the note icon.Only FSReadToolSettingsTypeStamp is effective. If it doesn't exist, it will be -1.