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.

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:

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:

Image watermark can be inserted as image, string, or stream.

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:

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:

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:

Add a Watermark into a 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:

FAQ

  1. Q: How can I add a text watermark with a specific font size and color?
    A: Create a TextWatermarkOptions object, set the font_family, font_size, and color properties, and then call doc.watermark.set_text("Your Text", options). Example:

    import aspose.pydrawing
    import aspose.words as aw
    doc = aw.Document("input.docx")
    options = aw.TextWatermarkOptions()
    options.font_family = "Arial"
    options.font_size = 72
    options.color = aspose.pydrawing.Color.gray
    doc.watermark.set_text("CONFIDENTIAL", options)
    doc.save("output.docx")
    
  2. Q: How do I insert an image watermark from a file path or a stream?
    A: Use ImageWatermarkOptions and the doc.watermark.set_image method. Provide either a file path or a stream to the image. Example:

    import aspose.words as aw
    doc = aw.Document("input.docx")
    options = aw.ImageWatermarkOptions()
    options.scale = 0.5   # optional scaling
    doc.watermark.set_image("logo.png", options)
    doc.save("output.docx")
    
  3. Q: What is the recommended way to remove a watermark that was added with the Watermark class?
    A: Call the remove method of the document’s watermark. This removes any watermark added via the Watermark API. Example:

    import aspose.words as aw
    doc = aw.Document("watermarked.docx")
    doc.watermark.remove()
    doc.save("clean.docx")
    
  4. Q: I added a watermark as a Shape. How can I delete it later?
    A: Assign a unique name to the shape when you create it (e.g., watermark.name = "MyWatermark"). Later, retrieve the shape by name from the document’s node collection and remove it. Example:

    import aspose.words as aw
    doc = aw.Document("input.docx")
    shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.TEXT_PLAIN_TEXT)
    shape.name = "MyWatermark"
    # ... configure shape as watermark ...
    # later: find the shape by name and remove it
    for node in doc.get_child_nodes(aw.NodeType.SHAPE, True):
        if node.as_shape().name == "MyWatermark":
            node.remove()
            break
    doc.save("output.docx")
    
  5. Q: Can I place a watermark inside a table cell but have it appear outside the cell boundaries?
    A: Yes. Set the shape’s is_layout_in_cell property to False and ensure the document is optimized for Word 2010 using CompatibilityOptions.optimize_for. This forces the watermark to be rendered relative to the page rather than the cell. Example:

    import aspose.words as aw
    doc = aw.Document("input.docx")
    shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.IMAGE)
    shape.is_layout_in_cell = False
    doc.compatibility_options.optimize_for(aw.settings.MsWordVersion.WORD2010)
    # add shape to the desired cell
    doc.save("output.docx")