Working with Watermark

This topic discusses how to work programmatically with watermark using Aspose.Words. A watermark is a background image that displays behind the text in a document. A watermark can contain a text or an image represented by the Watermark class.

Try online

You can try this functionality with our Free online document watermark.

How to Add a Watermark to a Document

In Microsoft Word, a watermark can easily be inserted in a document using the Insert Watermark command. Aspose.Words provides the Watermark class to add or remove watermark in documents. Aspose.Words provides the WatermarkType enumeration defining three possible types of watermarks (TEXT, IMAGE, and NONE) to work with. 

Add Text Watermark

The following code example demonstrates how to insert a text watermark in a document by defining TextWatermarkOptions using the set_text method.

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "Document.docx")

options = aw.TextWatermarkOptions()
    
options.font_family = "Arial"
options.font_size = 36
options.color = drawing.Color.black
options.layout = aw.WatermarkLayout.HORIZONTAL
options.is_semitrasparent = False
    

doc.watermark.set_text("Test", options)

doc.save(docs_base.artifacts_dir + "WorkWithWatermark.add_text_watermark_with_specific_options.docx")

Add Image Watermark

The following code example demonstrates how to insert an image watermark in a document by defining ImageWatermarkOptions using the set_image method:

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "Document.docx")

options = aw.ImageWatermarkOptions()
    
options.scale = 5
options.is_washout = False
    

doc.watermark.set_image(docs_base.images_dir + "Transparent background logo.png", options)

doc.save(docs_base.artifacts_dir + "WorkWithWatermark.add_image_watermark.docx")

The watermark can also be inserted using shape class as well. It is very easy to insert any shape or image into a header or footer and thus create a watermark of any imaginable type.

The following code example inserts a watermark into a Word document:

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
def test_add_and_remove_watermark(self) :
    
    doc = aw.Document(docs_base.my_dir + "Document.docx")

    self.insert_watermark_text(doc, "CONFIDENTIAL")
    doc.save(docs_base.artifacts_dir + "TestFile.watermark.docx")

    self.remove_watermark_text(doc)
    doc.save(docs_base.artifacts_dir + "WorkWithWatermark.remove_watermark.docx")
    

# <summary>
# Inserts a watermark into a document.
# </summary>
# <param name="doc">The input document.</param>
# <param name="watermarkText">Text of the watermark.</param>
def insert_watermark_text(self, doc : aw.Document, watermarkText : str) :
    
    # Create a watermark shape, this will be a WordArt shape.
    watermark = aw.drawing.Shape(doc, aw.drawing.ShapeType.TEXT_PLAIN_TEXT)
    watermark.name = "Watermark" 

    watermark.text_path.text = watermarkText
    watermark.text_path.font_family = "Arial"
    watermark.width = 500
    watermark.height = 100

    # Text will be directed from the bottom-left to the top-right corner.
    watermark.rotation = -40

    # Remove the following two lines if you need a solid black text.
    watermark.fill_color = drawing.Color.gray 
    watermark.stroke_color = drawing.Color.gray

    # Place the watermark in the page center.
    watermark.relative_horizontal_position = aw.drawing.RelativeHorizontalPosition.PAGE
    watermark.relative_vertical_position = aw.drawing.RelativeVerticalPosition.PAGE
    watermark.wrap_type = aw.drawing.WrapType.NONE
    watermark.vertical_alignment = aw.drawing.VerticalAlignment.CENTER
    watermark.horizontal_alignment = aw.drawing.HorizontalAlignment.CENTER

    # Create a new paragraph and append the watermark to this paragraph.
    watermarkPara = aw.Paragraph(doc)
    watermarkPara.append_child(watermark)

    # Insert the watermark into all headers of each document section.
    for sect in doc.sections :
        sect = sect.as_section()
        # There could be up to three different headers in each section.
        # Since we want the watermark to appear on all pages, insert it into all headers.
        self.insert_watermark_into_header(watermarkPara, sect, aw.HeaderFooterType.HEADER_PRIMARY)
        self.insert_watermark_into_header(watermarkPara, sect, aw.HeaderFooterType.HEADER_FIRST)
        self.insert_watermark_into_header(watermarkPara, sect, aw.HeaderFooterType.HEADER_EVEN)
        
    

def insert_watermark_into_header(self, watermarkPara : aw.Paragraph, sect : aw.Section, headerType : aw.HeaderFooterType) :
    
    header = sect.headers_footers.get_by_header_footer_type(headerType)

    if (header == None) :
        
        # There is no header of the specified type in the current section, so we need to create it.
        header = aw.HeaderFooter(sect.document, headerType)
        sect.headers_footers.add(header)
        

    # Insert a clone of the watermark into the header.
    header.append_child(watermarkPara.clone(True))
    

You can download the template file of this example from here.

Remove Watermark from a Document

The Watermark class provides the remove method to remove the watermark from a document.

The following code example shows how to remove a watermark from documents:

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()

# Add a plain text watermark.
doc.watermark.set_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.
textWatermarkOptions = aw.TextWatermarkOptions()
textWatermarkOptions.font_family = "Arial"
textWatermarkOptions.font_size = 36
textWatermarkOptions.color = drawing.Color.black
textWatermarkOptions.layout = aw.WatermarkLayout.DIAGONAL
textWatermarkOptions.is_semitrasparent = False

doc.watermark.set_text("Aspose Watermark", textWatermarkOptions)

doc.save(docs_base.artifacts_dir + "Document.text_watermark.docx")

# We can remove a watermark from a document like this.
if (doc.watermark.type == aw.WatermarkType.TEXT) :
    doc.watermark.remove()

doc.save(docs_base.artifacts_dir + "WorkWithWatermark.remove_watermark_from_document.docx")

If the watermarks are added using the Shape class object then to remove the watermark from a document you have to set only the name of watermark shape during inserting and then remove watermark shape by an assigned name.

The following code example show you how to set the name of the watermark shape and remove it from the document:

# Set name to be able to remove it afterwards
watermark.name = "WaterMark"

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
def remove_watermark_text(self, doc : aw.Document) :
    
    for hf in doc.get_child_nodes(aw.NodeType.HEADER_FOOTER, True) :
        hf = hf.as_header_footer()

        for shape in hf.get_child_nodes(aw.NodeType.SHAPE, True) :
            shape = shape.as_shape()

            if shape.name.find("WaterMark") >= 0 :
                shape.remove()
                
            

Add a Watermark in Table Cell

Sometimes you need to insert a watermark/image into a table’s cell and display it outside the table, you can use the is_layout_in_cell property. This property gets or sets a flag indicating whether the shape is displayed inside a table or outside of it. Note that this property works only when you optimize the document for Microsoft Word 2010 using the optimize_for method.

The following code example shows how to use this property:

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()
builder = aw.DocumentBuilder(doc)

builder.start_table()
builder.row_format.height = 100
builder.row_format.height_rule = aw.HeightRule.EXACTLY

for i in range(0, 31) :
    
    if (i != 0 and i % 7 == 0) :
        builder.end_row()
    builder.insert_cell()
    builder.write("Cell contents")
    

builder.end_table()

watermark = aw.drawing.Shape(doc, aw.drawing.ShapeType.TEXT_PLAIN_TEXT)
    
watermark.relative_horizontal_position = aw.drawing.RelativeHorizontalPosition.PAGE
watermark.relative_vertical_position = aw.drawing.RelativeVerticalPosition.PAGE
watermark.is_layout_in_cell = True # Display the shape outside of the table cell if it will be placed into a cell.
watermark.width = 300
watermark.height = 70
watermark.horizontal_alignment = aw.drawing.HorizontalAlignment.CENTER
watermark.vertical_alignment = aw.drawing.VerticalAlignment.CENTER
watermark.rotation = -40
    

watermark.fill_color = drawing.Color.gray
watermark.stroke_color = drawing.Color.gray

watermark.text_path.text = "watermarkText"
watermark.text_path.font_family = "Arial"

watermark.name = "WaterMark_" + str(uuid.uuid4())
watermark.wrap_type = aw.drawing.WrapType.NONE

run = doc.get_child_nodes(aw.NodeType.RUN, True)[doc.get_child_nodes(aw.NodeType.RUN, True).count - 1].as_run()

builder.move_to(run)
builder.insert_node(watermark)
doc.compatibility_options.optimize_for(aw.settings.MsWordVersion.WORD2010)

doc.save(docs_base.artifacts_dir + "WorkingWithShapes.layout_in_cell.docx")