class AddWatermarkAction

  • Article

An action class that specifies adding watermark.

Summary

Members Descriptions
public const std::string& GetUIElementName() An API used to mark the watermark element.
public WatermarkLayout GetLayout() const An API used to get the water mark layout.
public const std::string& GetText() const Get the text that is meant to go into the watermark.
public const std::string& GetFontName() const Get the font name used to display the watermark.
public int GetFontSize() const Get the font size used to display the watermark.
public const std::string& GetFontColor() const Get the font color used to display the watermark.

Members

GetUIElementName function

An API used to mark the watermark element.

Returns: The name that should be used for the UI element that holds the watermark. The same name will be returned in RemoveWatermarkingAction in case the watermark needs to be removed.

GetLayout function

An API used to get the water mark layout.

Returns: WatermarkLayout the watermarking layout in th form of an enum HORIZONTAL|DIAGONAL. ,

GetText function

Get the text that is meant to go into the watermark.

Returns: Content header text.

GetFontName function

Get the font name used to display the watermark.

Returns: Font name. Default value is Calibri if nothing is set by the policy.

GetFontSize function

Get the font size used to display the watermark.

Returns: Font size as an integer.

GetFontColor function

Get the font color used to display the watermark.

Returns: Font color as a string (for example, "#000000").