PageWatermark.Text Property

Gets or sets a PageWatermark‘s text.

Namespace: DevExpress.XtraPrinting.Drawing

Assembly: DevExpress.Printing.v22.1.Core.dll

NuGet Packages: DevExpress.Printing.Core, DevExpress.Win.Dashboard.Design

Declaration

C#

[DefaultValue("")]
[XRLocalizable(true)]
public string Text { get; set; }

VB.NET

<DefaultValue("")>
<XRLocalizable(True)>
Public Property Text As String

Property Value

Type	Default	Description
String	String.Empty	A String specifying the text of a watermark.

Remarks

This member is only in effect for a text watermark.

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 snippet (auto-collected from DevExpress Examples) contains a reference to the Text 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-winforms-watermark-different-pages/CS/Form1.cs#L37

textWatermark.Text = text;
textWatermark.TextDirection = DirectionMode.ForwardDiagonal;

VB.NET

reporting-winforms-watermark-different-pages/VB/Form1.vb#L36

Dim textWatermark As Watermark = New Watermark()
textWatermark.Text = text
textWatermark.TextDirection = DirectionMode.ForwardDiagonal