Foxit PDF SDK
|
Inherits Object.
Public Types | |
enum | TableBorderStyle { e_TableBorderStyleSolid = 0, e_TableBorderStyleDashed = 1 } |
Enumeration for PDF annotation type. More... | |
Public Member Functions | |
TableBorderInfo () | |
Constructor. | |
TableBorderInfo (const TableBorderInfo &table_border_info) | |
Constructor, with another table border information object. More... | |
TableBorderInfo (const TableBorderStyle &table_border_style, float line_width, ARGB color, float dash_phase, FloatArray dashes) | |
Constructor, with parameters. More... | |
bool | operator!= (const TableBorderInfo &data) const |
Not equal operator. More... | |
TableBorderInfo & | operator= (const TableBorderInfo &data) |
Assign operator. More... | |
bool | operator== (const TableBorderInfo &table_border_info) const |
Equal operator. More... | |
void | Set (const TableBorderStyle &table_border_style, float line_width, ARGB color, float dash_phase, FloatArray dashes) |
Set value. More... | |
Public Attributes | |
ARGB | color |
The table border color. Format: 0xAARRGGBB. | |
float | dash_phase |
Dash phase.It should not be negative. Only useful when parameter style</ i> is TableBorderInfo::e_TableBorderStyleDashed. Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details. | |
FloatArray | 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 TableBorderInfo::e_TableBorderStyleDashed. Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details. | |
float | line_width |
Table border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn. | |
TableBorderStyle | table_border_style |
Table border style. Please refer to values starting from TableBorderInfo::e_TableBorderStyleSolid and this should be one of these values. | |
This class represents table border information.
|
inline |
Constructor, with parameters.
[in] | table_border_style | Table border style. Please refer to values starting from TableBorderInfo::e_TableBorderStyleSolid and this should be one of these values. |
[in] | line_width | Table border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn. |
[in] | color | The table border color. Format: 0xAARRGGBB. |
[in] | dash_phase | Dash phase. Only useful when parameter style is TableBorderInfo::e_TableBorderStyleDashed. |
[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 TableBorderInfo::e_TableBorderStyleDashed. |
|
inline |
Constructor, with another table border information object.
[in] | table_border_info | Another table border information object. |
|
inline |
Not equal operator.
[in] | data | Another table border information object. This function will check if current object is not equal to this one. |
|
inline |
Assign operator.
[in] | data | Another table border information object, whose value would be assigned to current object. |
|
inline |
Equal operator.
[in] | table_border_info | Another table border information object. This function will check if current object is equal to this one. |
|
inline |
Set value.
[in] | table_border_style | Table border style. Please refer to values starting from TableBorderInfo::e_TableBorderStyleSolid and this should be one of these values. |
[in] | line_width | Table border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn. |
[in] | color | The table border color. Format: 0xAARRGGBB. |
[in] | dash_phase | Dash phase. Only useful when parameter style is TableBorderInfo::e_TableBorderStyleDashed. |
[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 TableBorderInfo::e_TableBorderStyleDashed. |