XRWatermark Class

A watermark in a report.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v25.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public class XRWatermark :
    Watermark

VB.NET

Public Class XRWatermark
    Inherits Watermark

Remarks

Use the XtraReport.Watermarks property to access an XRWatermark object and its members.

The following properties are in effect for text watermarks:

• Text
• TextDirection
• Font
• ForeColor
• TextTransparency
• TextAccessibleRole
• TextAccessibleDescription
• Id
• PageRange

The following code snippet creates a text watermark, specifies its settings, and adds it to a report:

C#

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

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());
report.ShowPreviewDialog();
}

private XRWatermark CreateTextWatermark() {
  // Create a new watermark.
  XRWatermark textWatermark = new XRWatermark();
  // Specify watermark settings.
  textWatermark.Id = "Watermark1";
  textWatermark.Text = "Confidential";
  textWatermark.TextDirection = DirectionMode.ForwardDiagonal;
  textWatermark.Font = new DXFont(textWatermark.Font.Name, 40);
  textWatermark.ForeColor = Color.DodgerBlue;
  textWatermark.TextTransparency = 150;
  textWatermark.TextPosition = WatermarkPosition.InFront;
  // Specify accessibility settings.
  textWatermark.TextAccessibleRole = XRAccessibleRole.Paragraph;
  textWatermark.TextAccessibleDescription = "A watermark indicating that the information on this page is confidential.";
  return textWatermark;
}

VB.NET

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

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs)
' Create a report and assign a watermark to it.
Dim report As New XtraReport1()
report.Watermarks.Add(CreateTextWatermark())
report.ShowPreviewDialog()
End Sub

Private Function CreateTextWatermark() As XRWatermark
  ' Create a new watermark.
  Dim textWatermark As New XRWatermark()
  ' Specify watermark settings.
  textWatermark.Id = "Watermark1"
  textWatermark.Text = "Confidential"
  textWatermark.TextDirection = DirectionMode.ForwardDiagonal
  textWatermark.Font = New DXFont(textWatermark.Font.Name, 40)
  textWatermark.ForeColor = Color.DodgerBlue
  textWatermark.TextTransparency = 150
  textWatermark.TextPosition = WatermarkPosition.InFront
  ' Specify accessibility settings.
  textWatermark.TextAccessibleRole = XRAccessibleRole.Paragraph
  textWatermark.TextAccessibleDescription = "A watermark indicating that the information on this page is confidential."
  Return textWatermark
End Function

The following properties are in effect for picture watermarks:

• ImageAlignment
• ImageTiling
• ImageViewMode
• ImageTransparency
• Id
• PageRange
• ImageSource
• ImageAccessibleDescription
• ImageAccessibleRole

The following code snippet creates an image watermark, specifies its settings, and adds it to a report:

C#

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

private void button1_Click(object sender, EventArgs e) {
// Create a report and assign a watermark to it.
XtraReport1 report = new XtraReport1();
report.Watermarks.Add(CreateImageWatermark());
report.ShowPreviewDialog();
}

private XRWatermark CreateImageWatermark() {
   // Create a new watermark.
    XRWatermark pictureWatermark = new XRWatermark();
    // Specify watermark settings.
    pictureWatermark.ImageSource = ImageSource.FromFile("WatermarkImage.png");
    pictureWatermark.ImageAlign = ContentAlignment.MiddleCenter;
    pictureWatermark.ImageTiling = false;
    pictureWatermark.ImageViewMode = ImageViewMode.Clip;
    pictureWatermark.ImagePosition = WatermarkPosition.Behind;
    pictureWatermark.Id = "Watermark1";
    // Specify accessibility settings.
    pictureWatermark.ImageAccessibleRole = XRAccessibleRole.Figure;
    pictureWatermark.ImageAccessibleDescription = "A watermark that contains the DevExpress logo.";
    return pictureWatermark;
}

VB.NET

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

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs)
' Create a report and assign a watermark to it.
Dim report As New XtraReport1()
report.Watermarks.Add(CreateImageWatermark())
report.ShowPreviewDialog()
End Sub

Private Function CreateImageWatermark() As XRWatermark
   ' Create a new watermark.
    Dim pictureWatermark As New XRWatermark()
    ' Specify watermark settings.
    pictureWatermark.ImageSource = ImageSource.FromFile("WatermarkImage.png")
    pictureWatermark.ImageAlign = ContentAlignment.MiddleCenter
    pictureWatermark.ImageTiling = False
    pictureWatermark.ImageViewMode = ImageViewMode.Clip
    pictureWatermark.ImagePosition = WatermarkPosition.Behind
    pictureWatermark.Id = "Watermark1"
    ' Specify accessibility settings.
    pictureWatermark.ImageAccessibleRole = XRAccessibleRole.Figure
    pictureWatermark.ImageAccessibleDescription = "A watermark that contains the DevExpress logo."
    Return pictureWatermark
End Function

See Display Watermarks in a Report for information on how to add a watermark to a report at design time.

Inheritance

Object

DevExpress.Printing.Utils.DocumentStoring.StorableObjectBase

PageWatermark

Watermark

XRWatermark