UI Properties

Boundary

Property documentBoundaryColor:UIColor Gets or sets the document border color. The default is #5eb7e4.
Property var documentBoundaryThickness:Int Gets or sets the document border thickness. The default is 6px.

Brightness & Contrast

Property var showBrightnessToolItem:Bool Gets or sets whether to show the Brightness tool item. The default value is "YES".
Property var showContrastToolItem:Bool Gets or sets whether to show the Contrast tool item. The default value is "YES".
Property var brightnessText:String Gets or sets the text showed on the Brightness tool item on the document editor viewer. The default value is "Brightness".
Property var contrastText:String Gets or sets the text showed on the Contrast tool item on the document editor viewer. The default value is "Contrast".
Property brightnessContrastIcon:UIImage Gets or sets the icon showed on the Brightness and Contrast tool item on the document editor viewer.

Color Mode

Property var showImageModeToolItem:Bool Gets or sets whether to show the ImageMode tool item. The default value is "YES".
Property var colorText:String Gets or sets the text showed on the ColorMode tool item on the document editor viewer. The default value is "Color".
Property var greyText:String Gets or sets the text showed on the GreyMode tool item on the document editor viewer. The default value is "Grey".
Property var blackWhiteText:String 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 imageModeIcon:UIImage Gets or sets the icon showed on the ImageMode tool item on the document editor viewer.
Property colorModeIcon:UIImage Gets or sets the icon showed on the ColorMode tool item on the document editor viewer.
Property greyModeIcon:UIImage Gets or sets the icon showed on the GreyMode tool item on the document editor viewer.
Property blackWhiteIcon:UIImage Gets or sets the icon showed on the B/W tool item on the document editor viewer.

Rotate

Property var showRotateLeftToolItem:Bool Gets or sets whether to show the RotateLeft tool item. The default value is "YES".
Property var showRotateRightToolItem:Bool Gets or sets whether to show the RotateRight tool item. The default value is "YES".
Property rotateLeftIcon:UIImage Gets or sets the icon showed on RotateLeft tool item on the document editor viewer.
Property rotateRightIcon:UIImage Gets or sets the icon showed on RotateRight tool item on the document editor viewer.

OK and Cancel

Property var cancelText:String Gets or sets the text showed on the Cancel tool item on the document editor viewer. The default value is "Cancel".
Property var okText:String Gets or sets the text showed on the OK tool item on the document editor viewer. The default value is "OK".

Further Details

var documentBoundaryColor:UIColor
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.

var documentBoundaryThickness:Int
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.
var brightnessText:String
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.

var contrastText:String
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.

var colorText:String
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.

var greyText:String
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.

var blackWhiteText:String
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.

var cancelText:String
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.

var okText:String
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.

var rotateLeftIcon:UIImage
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.

var rotateRightIcon:UIImage
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.

var colorModeIcon:UIImage
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.

var greyModeIcon:UIImage
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.

var blackWhiteIcon:UIImage
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.

var imageModeIcon:UIImage
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.

var brightnessContrastIcon:UIImage
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?