PageWatermark.Text Property

Gets or sets a PageWatermark‘s text.

Namespace: DevExpress.XtraPrinting.Drawing

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

Declaration

C#

[XtraSerializableProperty]
[DefaultValue("")]
[TypeConverter(typeof(WMTextConverter))]
public string Text { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue("")>
<TypeConverter(GetType(WMTextConverter))>
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 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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_how-to-add-different-watermarks-to-document-pages-e109/CS/Form1.cs#L37

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

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

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

VB.NET

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

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

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

Dim wm As Watermark = printableComponentLink1.PrintingSystem.Watermark
wm.Text = "Change the Watermark," & Constants.vbCrLf & "then close and re-open" & Constants.vbCrLf & "the form."
wm.ShowBehind = False