Watermark.PageRange Property

Gets or sets the range of pages which contain a watermark.

Namespace: DevExpress.XtraPrinting.Drawing

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

Declaration

C#

[XtraSerializableProperty]
[DefaultValue("")]
public string PageRange { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue("")>
Public Property PageRange As String

Property Value

Type	Default	Description
String	String.Empty	A String specifying the range of pages which contain a watermark.

Remarks

The PageRange property’s value contains the range of pages on which a watermark is displayed. The ranges are separated by commas. For example: “1,3,5-12”.

Note

If not all pages from the specified page range exist in the current document, invalid page numbers are ignored. So, only valid page numbers are taken into account.

If there are no valid page numbers in the page range string, the watermark is added to all pages of the document.

Example

This example demonstrates how a watermark can be added to a printing system document. The SetTextWatermark method demonstrates the properties which are useful when a text watermark is added to a document, while the SetPictureWatermark method demonstrates the properties required to set a picture as the document’s watermark.

C#

using System.Drawing;
using DevExpress.XtraPrinting;
using DevExpress.XtraPrinting.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 Font(textWatermark.Font.FontFamily, 40);
   textWatermark.ForeColor = Color.DodgerBlue;
   textWatermark.TextTransparency = 150;
   textWatermark.ShowBehind = false;
   textWatermark.PageRange = "1,3-5";

   // Set the watermark to a document.
   ps.Watermark.CopyFrom(textWatermark);
}

public void SetPictureWatermark(PrintingSystem ps){
   // Create the picture watermark.
   Watermark pictureWatermark = new Watermark();

   // Set watermark options.
   pictureWatermark.Image = Bitmap.FromFile("watermark.gif");
   pictureWatermark.ImageAlign = ContentAlignment.TopCenter;
   pictureWatermark.ImageTiling = false;
   pictureWatermark.ImageViewMode = ImageViewMode.Stretch;
   pictureWatermark.ImageTransparency = 150;
   pictureWatermark.ShowBehind = true;
   pictureWatermark.PageRange = "2,4";

   // Set the watermark to a document.
   ps.Watermark.CopyFrom(pictureWatermark);
}

VB.NET

Imports System.Drawing
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraPrinting.Drawing
' ...

Sub SetTextWatermark(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 Font(textWatermark.Font.FontFamily, 40)
   textWatermark.ForeColor = Color.DodgerBlue
   textWatermark.TextTransparency = 150
   textWatermark.ShowBehind = False
   textWatermark.PageRange = "1,3-5"

   ' Add the watermark to a document.
   ps.Watermark.CopyFrom(textWatermark)
End Sub

Public Sub SetPictureWatermark(ps As PrintingSystem)
   ' Create the picture watermark.
   Dim pictureWatermark As New Watermark()

   ' Set watermark options.
   pictureWatermark.Image = Bitmap.FromFile("watermark.gif")
   pictureWatermark.ImageAlign = ContentAlignment.TopCenter
   pictureWatermark.ImageTiling = False
   pictureWatermark.ImageViewMode = ImageViewMode.Stretch
   pictureWatermark.ImageTransparency = 150
   pictureWatermark.ShowBehind = True
   pictureWatermark.PageRange = "2,4"

   ' Add the watermark to a document.
   ps.Watermark.CopyFrom(pictureWatermark)
End Sub