Watermark class

Watermark class

Represents class to work with document watermark. To learn more, visit the Working with Watermark documentation article.

Properties

NameDescription
typeGets the watermark type.

Methods

NameDescription
remove()Removes the watermark.
set_image(image_path, options)Adds Image watermark into the document.
set_text(text)Adds Text watermark into the document.
set_text(text, options)Adds Text watermark into the document.

Examples

Shows how to create a text watermark.

doc = aw.Document()
# Add a plain text watermark.
doc.watermark.set_text(text='Aspose Watermark')
# If we wish to edit the text formatting using it as a watermark,
# we can do so by passing a TextWatermarkOptions object when creating the watermark.
text_watermark_options = aw.TextWatermarkOptions()
text_watermark_options.font_family = 'Arial'
text_watermark_options.font_size = 36
text_watermark_options.color = aspose.pydrawing.Color.black
text_watermark_options.layout = aw.WatermarkLayout.DIAGONAL
text_watermark_options.is_semitrasparent = False
doc.watermark.set_text(text='Aspose Watermark', options=text_watermark_options)
doc.save(file_name=ARTIFACTS_DIR + 'Document.TextWatermark.docx')
# We can remove a watermark from a document like this.
if doc.watermark.type == aw.WatermarkType.TEXT:
    doc.watermark.remove()

See Also