UI Properties

Member Type Member Name Description
Property UIColor * documentBoundaryColor Gets or sets the document border color. The default is #5eb7e4.
Property NSInteger documentBoundaryThickness Gets or sets the document border thickness. The default is 6px.
Property BOOL showBrightnessToolItem Gets or sets whether to show the Brightness tool item. The default value is "YES".
Property BOOL showContrastToolItem Gets or sets whether to show the Contrast tool item. The default value is "YES".
Property NSString* brightnessText Gets or sets the text showed on the Brightness tool item on the document editor viewer. The default value is "Brightness".
Property NSString* contrastText Gets or sets the text showed on the Contrast tool item on the document editor viewer. The default value is "Contrast".
Property UIImage * brightnessContrastIcon Gets or sets the icon showed on the Brightness and Contrast tool item on the document editor viewer.
Property BOOL showImageModeToolItem Gets or sets whether to show the ImageMode tool item. The default value is "YES".
Property NSString * colorText Gets or sets the text showed on the ColorMode tool item on the document editor viewer. The default value is "Color".
Property NSString * greyText Gets or sets the text showed on the GreyMode tool item on the document editor viewer. The default value is "Grey".
Property NSString * blackWhiteText Gets or sets the text showed on the B/W Mode tool item on the document editor viewer. The default value is "B/W".
Property UIImage * imageModeIcon Gets or sets the icon showed on the ImageMode tool item on the document editor viewer.
Property UIImage * colorModeIcon Gets or sets the icon showed on the ColorMode tool item on the document editor viewer.
Property UIImage * greyModeIcon Gets or sets the icon showed on the GreyMode tool item on the document editor viewer.
Property UIImage * blackWhiteIcon Gets or sets the icon showed on the B/W tool item on the document editor viewer.
Property BOOL showRotateLeftToolItem Gets or sets whether to show the RotateLeft tool item. The default value is "YES".
Property BOOL showRotateRightToolItem Gets or sets whether to show the RotateRight tool item. The default value is "YES".
Property UIImage * rotateLeftIcon Gets or sets the icon showed on RotateLeft tool item on the document editor viewer.
Property UIImage * rotateRightIcon Gets or sets the icon showed on RotateRight tool item on the document editor viewer.
Property NSString * cancelText Gets or sets the text showed on the Cancel tool item on the document editor viewer. The default value is "Cancel".
Property NSString * okText Gets or sets the text showed on the OK tool item on the document editor viewer. The default value is "OK".
(nonatomic, strong) UIColor *documentBoundaryColor
Description Gets or sets the document border color. The default is #5eb7e4.
Remarks If it's set to a non UIColor object, the exception DcsTypeNotValidException will be thrown.

the value equals nil, it means the set fails, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSInteger documentBoundaryThickness
Description Gets or sets the document border thickness. The default is 6px.
Remarks If the value you set is below 0 or equals 0, the set fails and the boundry of the document remains the same.
(nonatomic, strong) NSString * brightnessText
Description Gets or sets the text showed on the Brightness tool item on the document editor viewer. The default value is "Brightness".
Remarks If it is set to nil, no text will be showed on the Brightness tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * contrastText
Description Gets or sets the text showed on the Contrast tool item on the document editor viewer. The default value is "Contrast".
Remarks If it is set to nil, no text will be showed on the Contrast tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * colorText
Description Gets or sets the text showed on the ColorMode tool item on the document editor viewer. The default value is "Color".
Remarks If it is set to nil, no text will be showed on the ColorMode tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * greyText
Description Gets or sets the text showed on the GreyMode tool item on the document editor viewer. The default value is "Grey".
Remarks If it is set to nil, no text will be showed on the GreyMode tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * blackWhiteText
Description Gets or sets the text showed on the B/W tool item on the document editor viewer. The default value is "B/W".
Remarks If it is set to nil, no text will be showed on the B/W tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * cancelText
Description Gets or sets the text showed on the Cancel tool item on the document editor viewer. The default value is "Cancel".
Remarks If it is set to nil, no text will be showed on the Cancel tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * okText
Description Gets or sets the text showed on the OK tool item on the document editor viewer. The default value is "OK".
Remarks If it is set to nil, no text will be showed on the OK tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * rotateLeftIcon
Description Gets or sets the icon showed on RotateLeft tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the RotateLeft tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * rotateRightIcon
Description Gets or sets the icon showed on RotateRight tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the RotateRight tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * colorModeIcon
Description Gets or sets the icon showed on ColorMode tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the ColorMode tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * greyModeIcon
Description Gets or sets the icon showed on GreyMode tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the GreyMode tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * blackWhiteIcon
Description Gets or sets the icon showed on B/W tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the B/W tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * imageModeIcon
Description Gets or sets the icon showed on ImageMode tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the ImageMode tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * brightnessContrastIcon
Description Gets or sets the icon showed on BrightnessContrast tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the BrightnessContrast tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

Is this page helpful?