Inherits SystemIDisposable.
Public Types | |
enum | Style { Style.e_Solid = 0, Style.e_Dashed = 1, Style.e_UnderLine = 2, Style.e_Beveled = 3, Style.e_Inset = 4, Style.e_Cloudy = 5 } |
Enumeration for PDF annotation border style. More... | |
Public Member Functions | |
BorderInfo (float width, BorderInfo.Style style, float intensity, float dash_phase, FloatArray dashes) | |
Constructor, with parameters. More... | |
BorderInfo () | |
Constructor. | |
BorderInfo (BorderInfo border_info) | |
Constructor, with another BorderInfo object. More... | |
void | Set (float width, BorderInfo.Style style, float intensity, float dash_phase, FloatArray dashes) |
Set value. More... | |
This class represents annotation border information.
|
strong |
Enumeration for PDF annotation border style.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
e_Solid | Border style: Solid. |
e_Dashed | Border style: Dashed. This is only useful for link, free text, line, square, circle, polygon, polyline and screen annotation. If this is set to other type annotation, Foxit PDF SDK will change to set border style as e_Solid by default internally. |
e_UnderLine | Border style: Underline. This is only useful for link annotation. If this is set to other type annotation, Foxit PDF SDK will change to set border style as e_Solid by default internally. |
e_Beveled | Border style: Beveled. Currently, Foxit PDF SDK does not support the annotation appearance of this border style. If this is set to any annotation, Foxit PDF SDK will change to set border style as e_Solid by default internally. |
e_Inset | Border style: Inset. Currently, Foxit PDF SDK does not support the annotation appearance of this border style. If this is set to any annotation, Foxit PDF SDK will change to set border style as e_Solid by default internally. |
e_Cloudy | Border style: Cloudy. This is only useful for free text, square, circle, and polygon annotations. If this is set to other type annotation, Foxit PDF SDK will change to set border style as e_Solid by default internally. |
|
inline |
Constructor, with parameters.
width | Border width, in points. This should be a non-negative value. If this value is 0, no border is drawn. |
style | Border style. Please refer to e_borderStyleXXX values and it should be one of these values. |
intensity | Intensity of the cloudy effect. Only useful when parameter style is e_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. |
dash_phase | Dash phase. Only useful when parameter style is e_Dashed. |
dashes | A dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when BorderInfo::GetPageLabelStyle is e_Dashed. |
|
inline |
Constructor, with another BorderInfo object.
border_info | Another BorderInfo object. |
|
inline |
Set value.
width | Border width, in points. This should be a non-negative value. If this value is 0, no border is drawn. |
style | Border style. Please refer to e_borderStyleXXX values and it should be one of these values. |
intensity | Intensity of the cloudy effect. Only useful when parameter style is e_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. |
dash_phase | Dash phase. Only useful when parameter style is e_Dashed. |
dashes | A dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when BorderInfo::GetPageLabelStyle is e_Dashed. |