ApiWatermarkSettings

class ApiWatermarkSettings

Description

Class representing the settings which are used to create a watermark.

Instance Methods

GetClassType(): watermarkSettings

Returns a type of the ApiWatermarkSettings class.

SetType(sType)

Sets the type of the watermark in the document.

GetType(): WatermarkType

Returns the type of the watermark in the document.

SetText(sText)

Sets the text of the watermark in the document.

GetText(): string | "null"

Returns the text of the watermark in the document.

SetTextPr(oTextPr)

Sets the text properties of the watermark in the document.

GetTextPr(): ApiTextPr

Returns the text properties of the watermark in the document.

SetOpacity(nOpacity)

Sets the opacity of the watermark in the document.

GetOpacity(): number

Returns the opacity of the watermark in the document.

SetDirection(sDirection)

Sets the direction of the watermark in the document.

GetDirection(): WatermarkDirection

Returns the direction of the watermark in the document.

SetImageURL(sURL)

Sets the image URL of the watermark in the document.

GetImageURL(): string | "null"

Returns the image URL of the watermark in the document.

GetImageWidth(): EMU | "null"

Returns the width of the watermark image in the document.

GetImageHeight(): EMU | "null"

Returns the height of the watermark image in the document.

SetImageSize(nWidth, nHeight)

Sets the size (width and height) of the watermark image in the document.

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).