|
Foxit PDF SDK
|
Inherits Object.
Public Types | |
| enum | FontStyle { e_FontStyleNormal = 0, e_FontStyleUnderline = 1 } |
| Enumeration for watermark font style. More... | |
Public Member Functions | |
| WatermarkTextProperties (const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment) | |
| Constructor, with parameters. More... | |
| WatermarkTextProperties () | |
| Constructor. | |
| WatermarkTextProperties (const WatermarkTextProperties &properties) | |
| Constructor, with another watermark text properties object. More... | |
| WatermarkTextProperties & | operator= (const WatermarkTextProperties &properties) |
| Assign operator. More... | |
| void | Set (const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment) |
| Set value. More... | |
Public Attributes | |
| foxit::common ::Alignment | alignment |
| Text horizontal alignment. More... | |
| RGB | color |
| Text color. Format: 0xRRGGBB. | |
| common::Font | font |
| A font object used for the text. | |
| float | font_size |
| Font size in points. | |
| FontStyle | font_style |
| Font style. More... | |
| float | line_space |
| Space between vertical center of lines, in line heights. More... | |
This class represents the watermark text settings used to construct a watermark object from text.
|
inline |
Constructor, with parameters.
| [in] | font | A valid font object used for the text. |
| [in] | font_size | Font size in points. |
| [in] | color | Text color. Format: 0xRRGGBB. |
| [in] | style | Font style. It should be one of the following values: |
| [in] | line_space | Space between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark. |
| [in] | alignment | Text horizontal alignment. It should be one of the following values: |
|
inline |
Constructor, with another watermark text properties object.
| [in] | properties | Another watermark text properties object. |
|
inline |
Assign operator.
| [in] | properties | Another watermark text properties object, whose value would be assigned to current object. |
|
inline |
Set value.
| [in] | font | A valid font object used for the text. |
| [in] | font_size | Font size in points. |
| [in] | color | Text color. Format: 0xRRGGBB. |
| [in] | style | Font style. It should be one of the following values: |
| [in] | line_space | Space between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark. |
| [in] | alignment | Text horizontal alignment. It should be one of the following values: |
| foxit::common ::Alignment foxit::pdf::WatermarkTextProperties::alignment |
Text horizontal alignment.
It should be one of the following macro definitions:
| FontStyle foxit::pdf::WatermarkTextProperties::font_style |
Font style.
It should be one of the following values:
| float foxit::pdf::WatermarkTextProperties::line_space |
Space between vertical center of lines, in line heights.
This value is used to specify the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.