|
Foxit PDF SDK
|
Inherits NSObject.
Instance Methods | |
| (id) | - init |
| Constructor. | |
| (id) | - initWithFont:font_size:color:style:line_space:alignment: |
| Constructor, with parameters. More... | |
| (id) | - initWithProperties: |
| Constructor, with another watermark text properties object. More... | |
| (void) | - set:font_size:color:style:line_space:alignment: |
| Set value. More... | |
Properties | |
| FSAlignment | alignment |
| Text horizontal alignment. More... | |
| unsigned int | color |
| Text color. Format: 0xRRGGBB. | |
| FSFont * | font |
| A font object used for the text. | |
| float | font_size |
| Font size in points. | |
| FSWatermarkTextPropertiesFontStyle | 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.
| - (id) initWithFont: | (FSFont*) | font | |
| font_size: | (float) | font_size | |
| color: | (unsigned int) | color | |
| style: | (FSWatermarkTextPropertiesFontStyle) | style | |
| line_space: | (float) | line_space | |
| alignment: | (FSAlignment) | alignment | |
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:
|
| - (id) initWithProperties: | (FSWatermarkTextProperties*) | properties |
Constructor, with another watermark text properties object.
| [in] | properties | Another watermark text properties object. |
| - (void) set: | (FSFont*) | font | |
| font_size: | (float) | font_size | |
| color: | (unsigned int) | color | |
| style: | (FSWatermarkTextPropertiesFontStyle) | style | |
| line_space: | (float) | line_space | |
| alignment: | (FSAlignment) | alignment | |
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:
|
|
readwritenonatomicassign |
Text horizontal alignment.
It should be one of the following macro definitions:
|
readwritenonatomicassign |
Font style.
It should be one of the following values:
|
readwritenonatomicassign |
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.