|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetCloud_intensity () |
| Get intensity of the cloudy effect. More... | |
| def | GetDash_phase () |
| Get dash phase. More... | |
| def | GetDashes () |
| Get a dash array that represents the dash patterns. More... | |
| def | GetStyle () |
| Get border style. More... | |
| def | GetWidth () |
| Get border width, in points. More... | |
| def | Set (width, style, intensity, dash_phase, dashes) |
| Set value. More... | |
| def | SetCloud_intensity (value) |
| Set intensity of the cloudy effect. More... | |
| def | SetDash_phase (value) |
| Set dash phase. More... | |
| def | SetDashes (value) |
| Set a dash array that represents the dash patterns. More... | |
| def | SetStyle (value) |
| Set border style. More... | |
| def | SetWidth (value) |
| Set border width, in points. More... | |
This class represents annotation border information.
| fsdk.BorderInfo.GetCloud_intensity | ( | ) |
Get intensity of the cloudy effect.
This is only useful to free text, square, circle, and polygon annotations when style of current object is fsdk.BorderInfoE_Cloudy .
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.
| fsdk.BorderInfo.GetDash_phase | ( | ) |
Get dash phase.
Only useful when style of current object is fsdk.BorderInfoE_Dashed .
| fsdk.BorderInfo.GetDashes | ( | ) |
Get a dash array that represents the dash patterns.
Only useful when style of current object is fsdk.BorderInfoE_Dashed .
The value of elements in this array should not be negative.
| fsdk.BorderInfo.GetStyle | ( | ) |
Get border style.
| fsdk.BorderInfo.GetWidth | ( | ) |
Get border width, in points.
This value should not be negative. If this value is 0, no border will be drawn.
| def fsdk.BorderInfo.Set | ( | width, | |
| style, | |||
| intensity, | |||
| dash_phase, | |||
| dashes | |||
| ) |
Set value.
| [in] | width | Border width, in points. This should be a non-negative value. If this value is 0, no border is drawn. |
| [in] | style | Border style. Please refer to values starting from fsdk.BorderInfoE_Solid and this should be one of these values. |
| [in] | intensity | Intensity of the cloudy effect. Only useful when parameter style is fsdk.BorderInfoE_Cloudy . 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_phase | Dash phase. Only useful when parameter style is fsdk.BorderInfoE_Dashed . |
| [in] | dashes | A dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when style is fsdk.BorderInfoE_Dashed . |
| fsdk.BorderInfo.SetCloud_intensity | ( | value | ) |
Set intensity of the cloudy effect.
This is only useful to free text, square, circle, and polygon annotations when style of current object is fsdk.BorderInfoE_Cloudy .
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.
| [in] | value | Intensity of the cloudy effect. |
| fsdk.BorderInfo.SetDash_phase | ( | value | ) |
Set dash phase.
Only useful when style of current object is fsdk.BorderInfoE_Dashed .
| [in] | value | Dash phase. |
| fsdk.BorderInfo.SetDashes | ( | value | ) |
Set a dash array that represents the dash patterns.
Only useful when style of current object is fsdk.BorderInfoE_Dashed .
The value of elements in this array should not be negative.
| [in] | value | A dash array that represents the dash patterns. |
| fsdk.BorderInfo.SetStyle | ( | value | ) |
Set border style.
| [in] | value | Border style. Please refer to values starting from fsdk.BorderInfoE_Solid and this should be one of these values. Please also check comment of these values for more details. |
| fsdk.BorderInfo.SetWidth | ( | value | ) |
Set border width, in points.
This value should not be negative. If this value is 0, no border will be drawn.
| [in] | value | Border width, in points. |