Page.Watermark Property

Provides access to the current watermark on this page.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v24.2.Core.dll

Declaration

C#

public PageWatermark Watermark { get; }

VB.NET

Public ReadOnly Property Watermark As PageWatermark

Property Value

Type	Description
PageWatermark	A PageWatermark object which represents the current watermark.

Remarks

When a Document is generated, all its Document.Pages contain a watermark which is specified by the PrintingSystemBase.Watermarks property of a document’s printing system.

To specify individual watermarks for particular pages, use the Page.WatermarkId property or call the Page.AssignWatermark method.

Example

The following example demonstrates how to specify a unique watermark for different pages in a report. You can do it in the following ways:

• Assign the Page.WatermarkId property to the Watermark.Id value.

• Call the Page.AssignWatermark method for the page whose watermark you want to change, and pass a new watermark to this method as a parameter.

Page.AssignWatermark takes priority over Page.WatermarkId.

If you want to remove the watermark from a particular page, pass a new empty watermark to the AssignWatermark method.

View Example

C#

using System;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.Drawing;
using DevExpress.XtraPrinting;
using DevExpress.XtraPrinting.Drawing;
using DevExpress.XtraReports.UI;
// ...

namespace DifferentWatermarks {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e) {
            // Create a report and assign a watermark to it.
            XtraReport1 report = new XtraReport1();
            report.Watermarks.Add(CreateTextWatermark("Common Watermark", "Watermark1"));
            report.Watermarks.Add(CreateTextWatermark("Second Page", "Watermark2"));
            report.CreateDocument();

            // Add a custom watermark to the second page.
            Page myPage = report.Pages[1];
            myPage.WatermarkId = "Watermark2";

            // Remove a watermark from the third page.
            myPage = report.Pages[2];
            myPage.AssignWatermark(new PageWatermark());

            // Show the Print Preview.
            report.ShowPreviewDialog();
        }

        // Create a watermark with the specified text.
        private Watermark CreateTextWatermark(string text, string id) {
            Watermark textWatermark = new Watermark();
            textWatermark.Id = id;
            textWatermark.Text = text;
            textWatermark.TextDirection = DirectionMode.ForwardDiagonal;
            textWatermark.Font = new DXFont(textWatermark.Font.Name, 40);
            textWatermark.ForeColor = Color.DodgerBlue;
            textWatermark.TextTransparency = 150;
            textWatermark.TextPosition = WatermarkPosition.InFront;
            return textWatermark;
        }

    }
}

VB.NET

Imports Microsoft.VisualBasic
Imports System
Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.Drawing
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraPrinting.Drawing
Imports DevExpress.XtraReports.UI
' ...

Namespace DifferentWatermarks
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click
            ' Create a report and assign a watermark to it.
            Dim report As New XtraReport1()
            report.Watermarks.Add(CreateTextWatermark("Common Watermark", "Watermark1"))
            report.Watermarks.Add(CreateTextWatermark("Second Page", "Watermark2"))
            report.CreateDocument()

            ' Add a custom watermark to the second page.
            Dim myPage As Page = report.Pages(1)
            myPage.WatermarkId = "Watermark2"

            ' Remove a watermark from the third page.
            myPage = report.Pages(2)
            myPage.AssignWatermark(New PageWatermark())

            ' Show the Print Preview.
            report.ShowPreviewDialog()
        End Sub

        ' Create a watermark with the specified text.
        Private Function CreateTextWatermark(ByVal text As String, ByVal id As String) As Watermark
            Dim textWatermark As New Watermark()
            textWatermark.Id = id
            textWatermark.Text = text
            textWatermark.TextDirection = DirectionMode.ForwardDiagonal
            textWatermark.Font = New DXFont(textWatermark.Font.Name, 40)
            textWatermark.ForeColor = Color.DodgerBlue
            textWatermark.TextTransparency = 150
            textWatermark.TextPosition = WatermarkPosition.InFront
            Return textWatermark
        End Function

    End Class
End Namespace