Skip to main content

XRWatermark.ImageSource Property

Gets or sets the watermark picture.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

public override ImageSource ImageSource { get; set; }

Property Value

Type Description
ImageSource

The watermark picture.

Remarks

The XRWatermark control supports the following image formats:

  • BMP
  • JPG / JPEG / JPE / JFIF
  • GIF
  • TIF / TIFF
  • PNG
  • ICO
  • DIB
  • RLE
  • EMF / WMF
  • SVG

SVG Support Limitations

The XRWatermark control does not support the following SVG content:

  • Text that uses textPath
  • Animations
  • CSS styles
  • Raster images embedded into an SVG

Transparency is not supported for SVG image watermarks. The XRWatermark.ImageTransparency property’s value is ignored when you set an SVG image as a watermark.

Export (except for PDF) has the following limitations:

  • SVG images are converted to metafiles because document viewers may not support SVG format.

  • SVG images are exported as PNG in the Microsoft Azure environment.

Example

This example demonstrates how to add a watermark to a report. The SetTextWatermark method demonstrates the properties you can use to add a text watermark to a report; the SetPictureWatermark method demonstrates properties required to set a picture as the report’s watermark.

using System.Drawing;
using DevExpress.XtraPrinting;
using DevExpress.XtraPrinting.Drawing;
using DevExpress.Drawing;
// ...
public void SetTextWatermark(XtraReport report) {
    // Create a new watermark.
    Watermark textWatermark = new Watermark();
    // Specify watermark settings.
    textWatermark.Text = "CUSTOM WATERMARK TEXT";
    textWatermark.TextDirection = DirectionMode.ForwardDiagonal;
    textWatermark.Font = new DXFont(textWatermark.Font.Name, 40);
    textWatermark.ForeColor = Color.DodgerBlue;
    textWatermark.TextTransparency = 150;
    textWatermark.TextPosition = WatermarkPosition.InFront;
    textWatermark.PageRange = "1,3-5";
    textWatermark.Id = "Watermark1";
    // Add the watermark to the collection.
    report.Watermarks.Add(textWatermark);
}
public void SetPictureWatermark(XtraReport report) {
    Watermark pictureWatermark = new Watermark();
    pictureWatermark.ImageSource = ImageSource.FromFile("Watermark.png");
    pictureWatermark.ImageAlign = ContentAlignment.TopCenter;
    pictureWatermark.ImageTiling = false;
    pictureWatermark.ImageViewMode = ImageViewMode.Stretch;
    pictureWatermark.ImageTransparency = 150;
    pictureWatermark.ImagePosition = WatermarkPosition.Behind;
    pictureWatermark.PageRange = "2,4";
    pictureWatermark.Id = "Watermark2";
    report.Watermarks.Add(pictureWatermark);
}
See Also