WatermarkTextParams Class Documentation
class WatermarkTextParamsNamespace:datalogics_interface
Detailed Description
Watermark settings to control the appearance of text in a text-based watermark.
Uses types
Constructor & Destructor Documentation
WatermarkTextParams
WatermarkTextParams()Creates a new WatermarkTextParams with default settings.
The default font is CourierStd, font size is 24.0, color is DeviceGray black, and text alignment is left-aligned.
WatermarkTextParams
WatermarkTextParams(WatermarkTextParams && )Parameters
~WatermarkTextParams
~WatermarkTextParams()Member Function Documentation
get_color
std::unique_ptr< Color > get_color()Returns:
std::unique_ptr< Color >The Color of the watermark text.
Gets the color to be used when generating a text-based watermark.
get_font
Font get_font()Returns:
FontThe Font used for the watermark text.
Gets the Font to be used when generating a text-based watermark.
get_font_size
float get_font_size()Returns:
floatFont size in points.
get_text
std::string get_text()Returns:
std::stringThe watermark text string.
Gets the text to be used when generating a text-based watermark.
get_text_alignment
HorizontalAlignment get_text_alignment()Returns:
HorizontalAlignmentThe horizontal alignment for the watermark text.
Gets the alignment to be used when justifying a text-based watermark.
operator=
WatermarkTextParams & operator=(WatermarkTextParams && )Parameters
Returns:
WatermarkTextParams &set_color
void set_color(const Color & color)Parameters
color: const Color &the color to be used when generating a text-based watermark
Returns:
voidSets the color to be used when generating a text-based watermark.
set_font
void set_font(Font & font)Parameters
font: Font &The Font to use for the watermark text.
Returns:
voidSets the Font to be used when generating a text-based watermark.
set_font_size
void set_font_size(float size)Parameters
size: float
Returns:
voidFont size in points.
set_text
void set_text(const std::string & text)Parameters
text: const std::string &The watermark text string.
Returns:
voidSets the text to be used when generating a text-based watermark.
set_text_alignment
void set_text_alignment(HorizontalAlignment align)Parameters
align: HorizontalAlignmentThe horizontal alignment for the watermark text.
Returns:
voidSets the alignment to be used when justifying a text-based watermark.