XRWatermark Class

A watermark in a report.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public class XRWatermark :
    Watermark,
    IXRSerializable

VB.NET

Public Class XRWatermark
    Inherits Watermark
    Implements IXRSerializable

Related API Members

The following members return XRWatermark objects:

• XtraReport.Watermark

Remarks

This class is used to represent a report’s watermark which is accessed via the XtraReport.Watermark property.

Example

This example demonstrates how to add a watermark to a report. The SetTextWatermark method demonstrates properties that are useful when adding a text watermark to a report, while the SetPictureWatermark method demonstrates properties required to set a picture as the report’s watermark.

C#

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

public void SetTextWatermark(XtraReport report){
    // Adjust text watermark settings.
    report.Watermark.Text = "CUSTOM WATERMARK TEXT";
    report.Watermark.TextDirection = DirectionMode.ForwardDiagonal;
    report.Watermark.Font = new Font(report.Watermark.Font.FontFamily, 40);
    report.Watermark.ForeColor = Color.DodgerBlue;
    report.Watermark.TextTransparency = 150;
    report.Watermark.ShowBehind = false;
    report.Watermark.PageRange = "1,3-5";
}

public void SetPictureWatermark(XtraReport report){
    // Adjust image watermark settings.
    report.Watermark.Image = Bitmap.FromFile("watermark.gif");
    report.Watermark.ImageAlign = ContentAlignment.TopCenter;
    report.Watermark.ImageTiling = false;
    report.Watermark.ImageViewMode = ImageViewMode.Stretch;
    report.Watermark.ImageTransparency = 150;
    report.Watermark.ShowBehind = true;
    report.Watermark.PageRange = "2,4";
}

VB.NET

Imports System.Drawing
Imports DevExpress.XtraPrinting.Drawing
Imports DevExpress.XtraReports.UI
' ...

Sub SetTextWatermark(report As XtraReport)
    ' Adjust text watermark settings.
    report.Watermark.Text = "CUSTOM WATERMARK TEXT"
    report.Watermark.TextDirection = DirectionMode.ForwardDiagonal
    report.Watermark.Font = New Font(report.Watermark.Font.FontFamily, 40)
    report.Watermark.ForeColor = Color.DodgerBlue
    report.Watermark.Transparency = 150
    report.Watermark.TextTransparency = 150
    report.Watermark.ShowBehind = False
    report.Watermark.PageRange = "1,3-5"
End Sub

Public Sub SetPictureWatermark(report As XtraReport)
    ' Adjust image watermark settings.
    report.Watermark.Image = Bitmap.FromFile("watermark.gif")
    report.Watermark.ImageAlign = ContentAlignment.TopCenter
    report.Watermark.ImageTiling = False
    report.Watermark.ImageViewMode = ImageViewMode.Stretch
    report.Watermark.ImageTransparency = 150
    report.Watermark.ShowBehind = True
    report.Watermark.PageRange = "2,4"
End Sub

Implements

DevExpress.Printing.Utils.DocumentStoring.IStorableObject

IDisposable

Inheritance

Object

DevExpress.Printing.Utils.DocumentStoring.StorableObjectBase

PageWatermark

Watermark

XRWatermark