TextWatermarkOptions class

TextWatermarkOptions class

Contains options that can be specified when adding a watermark with text. To learn more, visit the Working with Watermark documentation article.

Constructors

NameDescription
TextWatermarkOptions()The default constructor.

Properties

NameDescription
colorGets or sets font color. The default value is aspose.pydrawing.Color.silver.
font_familyGets or sets font family name. The default value is “Calibri”.
font_sizeGets or sets a font size. The default value is 0 - auto.
is_semitrasparentGets or sets a boolean value which is responsible for opacity of the watermark. The default value is True.
layoutGets or sets layout of the watermark. The default value is WatermarkLayout.DIAGONAL.

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