|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetAlignment () |
| Get text horizontal alignment. More... | |
| def | GetColor () |
| Get text color. More... | |
| def | GetFont () |
| Get a font object used for the text. More... | |
| def | GetFont_size () |
| Get font size in points. More... | |
| def | GetFont_style () |
| Get font style. More... | |
| def | GetLine_space () |
| Get space between vertical center of lines, in line heights. More... | |
| def | Set (font, font_size, color, style, line_space, alignment) |
| Set value. More... | |
| def | SetAlignment (value) |
| Set text horizontal alignment. More... | |
| def | SetColor (value) |
| Set text color. More... | |
| def | SetFont (value) |
| Set a font object used for the text. More... | |
| def | SetFont_size (value) |
| Set font size in points. More... | |
| def | SetFont_style (value) |
| Set font style. More... | |
| def | SetLine_space (value) |
| Set 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.
| fsdk.WatermarkTextProperties.GetAlignment | ( | ) |
Get text horizontal alignment.
It should be one of the following macro definitions:
| fsdk.WatermarkTextProperties.GetColor | ( | ) |
Get text color.
| fsdk.WatermarkTextProperties.GetFont | ( | ) |
Get a font object used for the text.
| fsdk.WatermarkTextProperties.GetFont_size | ( | ) |
Get font size in points.
| fsdk.WatermarkTextProperties.GetFont_style | ( | ) |
Get font style.
It should be one of the following values:
| fsdk.WatermarkTextProperties.GetLine_space | ( | ) |
Get 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.
| def fsdk.WatermarkTextProperties.Set | ( | font, | |
| font_size, | |||
| color, | |||
| style, | |||
| line_space, | |||
| alignment | |||
| ) |
Set value.
The parameters line_space and alignment don't support tiled watermark, and will have no effect after setting.
| [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: |
| fsdk.WatermarkTextProperties.SetAlignment | ( | value | ) |
Set text horizontal alignment.
It should be one of the following macro definitions:
| [in] | value | Text horizontal alignment. The default value is fsdk.E_AlignmentLeft . |
| fsdk.WatermarkTextProperties.SetColor | ( | value | ) |
Set text color.
| [in] | value | Text color. Format: 0xRRGGBB. The default value is 0x000000. |
| fsdk.WatermarkTextProperties.SetFont | ( | value | ) |
Set a font object used for the text.
| [in] | value | A font object used for the text. |
| fsdk.WatermarkTextProperties.SetFont_size | ( | value | ) |
Set font size in points.
| [in] | value | Font size in points. The default value is 24.0. |
| fsdk.WatermarkTextProperties.SetFont_style | ( | value | ) |
Set font style.
It should be one of the following values:
| [in] | value | Font style.The default value is fsdk.WatermarkTextPropertiesE_FontStyleNormal . |
| fsdk.WatermarkTextProperties.SetLine_space | ( | value | ) |
Set 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.
| [in] | value | Space between vertical center of lines, in line heights. The default value is 1.0. |