PageWatermark.ShowBehind Property

Gets or sets a value indicating whether a watermark should be printed behind or in front of the contents of a page.

Namespace: DevExpress.XtraPrinting.Drawing

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

NuGet Packages: DevExpress.Printing.Core, DevExpress.WindowsDesktop.Printing.Core

Declaration

C#

[DefaultValue(true)]
public bool ShowBehind { get; set; }

VB.NET

<DefaultValue(True)>
Public Property ShowBehind As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true to print a watermark behind the contents of a page; otherwise false.

Example

This example demonstrates how to add a text watermark (the SetTextWatermark method) or an image watermark (the SetPictureWatermark method) to a printing system document.

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 text watermark.
    Watermark pictureWatermark = new Watermark();

    // Set watermark options.
    pictureWatermark.ImageSource = ImageSource.FromFile("Watermark.png");
    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
' ...
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 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)
End Sub
Public Sub SetPictureWatermark(ByVal ps As PrintingSystem)
    ' Create the text watermark.
    Dim pictureWatermark As New Watermark()

    ' Set watermark options.
    pictureWatermark.ImageSource = ImageSource.FromFile("Watermark.png")
    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)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowBehind property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-add-different-watermarks-to-document-pages-e109/CS/Form1.cs#L42

textWatermark.TextTransparency = 150;
textWatermark.ShowBehind = false;

Reporting_how-to-save-load-a-documents-watermark-in-print-preview-e1909/CS/Form1.cs#L31

wm.Text = "Change the Watermark,\r\nthen close and re-open\r\nthe form.";
wm.ShowBehind = false;
wm.TextDirection = DirectionMode.Horizontal;

VB.NET

Reporting_how-to-add-different-watermarks-to-document-pages-e109/VB/Form1.vb#L41

textWatermark.TextTransparency = 150
textWatermark.ShowBehind = False
Return textWatermark

Reporting_how-to-save-load-a-documents-watermark-in-print-preview-e1909/VB/Form1.vb#L37

wm.Text = "Change the Watermark," & Constants.vbCrLf & "then close and re-open" & Constants.vbCrLf & "the form."
wm.ShowBehind = False
wm.TextDirection = DirectionMode.Horizontal