corelibraries-devexpress-dot-xtraprinting-dot-drawing-009e9cf1.md
A collection of watermarks.
Namespace : DevExpress.XtraPrinting.Drawing
Assembly : DevExpress.Printing.v25.2.Core.dll
NuGet Package : DevExpress.Printing.Core
public class WatermarkCollection :
Collection<Watermark>,
IDisposable
Public Class WatermarkCollection
Inherits Collection(Of Watermark)
Implements IDisposable
The following members return WatermarkCollection objects:
| Library | Related API Members |
|---|---|
| Cross-Platform Class Library | PrintingSystemBase.Watermarks |
| WinForms Controls | PrintingSystem.Watermarks |
| WPF Controls | IDocumentViewModel.Watermarks |
| .NET Reporting Tools | XtraReport.Watermarks |
This example demonstrates how to add a watermark to a printing system document. The SetTextWatermark method demonstrates the properties that are used to specify settings when a text watermark is added to a document, while the SetPictureWatermark method demonstrates the properties required to set a picture as a document’s watermark.
using DevExpress.XtraPrinting;
using DevExpress.XtraPrinting.Drawing;
using DevExpress.Drawing;
// ...
public void SetTextWatermark(PrintingSystem ps){
// Create the text watermark.
Watermark textWatermark = new Watermark();
// Set watermark options.
textWatermark.Text = "CUSTOM WATERMARK TEXT";
textWatermark.TextDirection = DirectionMode.ForwardDiagonal;
textWatermark.Font = new DXFont(textWatermark.Font.FontFamily, 40);
textWatermark.ForeColor = Color.DodgerBlue;
textWatermark.TextTransparency = 150;
textWatermark.TextPosition = WatermarkPosition.InFront;
textWatermark.PageRange = "1,3-5";
// Add the watermark to the collection.
ps.Watermarks.Add(textWatermark);
}
public void SetPictureWatermark(PrintingSystem ps){
// Create the picture watermark.
Watermark pictureWatermark = new Watermark();
// Set watermark options.
pictureWatermark.Image = Bitmap.FromFile("watermark.gif");
pictureWatermark.ImageAlignment = ImageAlignment.TopCenter;
pictureWatermark.ImageTiling = false;
pictureWatermark.ImageViewMode = ImageViewMode.Stretch;
pictureWatermark.ImageTransparency = 150;
pictureWatermark.ImagePosition = WatermarkPosition.Behind;
pictureWatermark.PageRange = "2,4";
// Add the watermark to the collection.
ps.Watermarks.Add(pictureWatermark);
}
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraPrinting.Drawing
Imports DevExpress.Drawing
' ...
Public Sub SetTextWatermark(ByVal ps As PrintingSystem)
' Create the text watermark.
Dim textWatermark As New Watermark()
' Set watermark options.
textWatermark.Text = "CUSTOM WATERMARK TEXT"
textWatermark.TextDirection = DirectionMode.ForwardDiagonal
textWatermark.Font = New DXFont(textWatermark.Font.FontFamily, 40)
textWatermark.ForeColor = Color.DodgerBlue
textWatermark.TextTransparency = 150
textWatermark.TextPosition = WatermarkPosition.InFront
textWatermark.PageRange = "1,3-5"
' Add the watermark to the collection.
ps.Watermarks.Add(textWatermark)
End Sub
Public Sub SetPictureWatermark(ByVal ps As PrintingSystem)
' Create the picture watermark.
Dim pictureWatermark As New Watermark()
' Set watermark options.
pictureWatermark.Image = Bitmap.FromFile("watermark.gif")
pictureWatermark.ImageAlignment = ImageAlignment.TopCenter
pictureWatermark.ImageTiling = False
pictureWatermark.ImageViewMode = ImageViewMode.Stretch
pictureWatermark.ImageTransparency = 150
pictureWatermark.ImagePosition = WatermarkPosition.Behind
pictureWatermark.PageRange = "2,4"
' Add the watermark to the collection.
ps.Watermarks.Add(pictureWatermark)
End Sub
Object Collection<Watermark> WatermarkCollection
See Also