Foxit PDF SDK
FSBorderInfo Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithBorder_info:
 Constructor, with another border information object.
More...
 
(id) - initWithWidth:style:intensity:dash_phase:dashes:
 Constructor, with parameters.
More...
 
(void) - set:style:intensity:dash_phase:dashes:
 Set value.
More...
 

Properties

float cloud_intensity
 Intensity of the cloudy effect.
More...
 
float dash_phase
 Dash phase.
More...
 
FSFloatArraydashes
 A dash array that represents the dash patterns.
More...
 
FSBorderInfoStyle style
 Border style. Please refer to values starting from FSBorderInfoSolid and this should be one of these values. Please also check comment of these values for more details.

 
float width
 Border width, in points.
More...
 

Detailed Description

This class represents annotation border information.

Method Documentation

◆ initWithBorder_info:()

- (id) initWithBorder_info: (FSBorderInfo*)  border_info

Constructor, with another border information object.

Parameters
[in]border_infoAnother border information object.

◆ initWithWidth:style:intensity:dash_phase:dashes:()

- (id) initWithWidth: (float)  width
style: (FSBorderInfoStyle style
intensity: (float)  intensity
dash_phase: (float)  dash_phase
dashes: (FSFloatArray*)  dashes 

Constructor, with parameters.

Parameters
[in]widthBorder width, in points. This should be a non-negative value. If this value is 0, no border is drawn.
[in]styleBorder style. Please refer to values starting from FSBorderInfoSolid and this should be one of these values.
[in]intensityIntensity of the cloudy effect. Only useful when parameter style is FSBorderInfoCloudy. Valid value range: 0 to 2. 0 means no cloudy border effect.
If the value is below 0, it will have the same effect as value 0. If the value is above 2, it will have the same effect as value 2.
[in]dash_phaseDash phase. Only useful when parameter style is FSBorderInfoDashed.
[in]dashesA dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when style is FSBorderInfoDashed.

◆ set:style:intensity:dash_phase:dashes:()

- (void) set: (float)  width
style: (FSBorderInfoStyle style
intensity: (float)  intensity
dash_phase: (float)  dash_phase
dashes: (FSFloatArray*)  dashes 

Set value.

Parameters
[in]widthBorder width, in points. This should be a non-negative value. If this value is 0, no border is drawn.
[in]styleBorder style. Please refer to values starting from FSBorderInfoSolid and this should be one of these values.
[in]intensityIntensity of the cloudy effect. Only useful when parameter style is FSBorderInfoCloudy. Valid value range: 0 to 2. 0 means no cloudy border effect.
If the value is below 0, it will have the same effect as value 0. If the value is above 2, it will have the same effect as value 2.
[in]dash_phaseDash phase. Only useful when parameter style is FSBorderInfoDashed.
[in]dashesA dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when style is FSBorderInfoDashed.
Returns
None.

Property Documentation

◆ cloud_intensity

- (float) cloud_intensity
readwritenonatomicassign

Intensity of the cloudy effect.

This is only useful to free text, square, circle, and polygon annotations when style of current object is FSBorderInfoCloudy.
Suggested value range: 0 to 2. 0 means no cloudy border effect.
For rest value, their effect would be:

  • If the value is below 0, it will have the same effect as value 0.
  • If the value is above 2, it will have the same effect as value 2.



◆ dash_phase

- (float) dash_phase
readwritenonatomicassign

Dash phase.

Only useful when style of current object is FSBorderInfoDashed.

◆ dashes

- (FSFloatArray *) dashes
readwritenonatomicweak

A dash array that represents the dash patterns.

Only useful when style of current object is FSBorderInfoDashed.
The value of elements in this array should not be negative.

◆ width

- (float) width
readwritenonatomicassign

Border width, in points.

This value should not be negative. If this value is 0, no border will be drawn.