Class
TextWatermark

Represents a text watermark on a printable page.

Definition

Namespace:Telerik.Reporting.Drawing

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
public sealed class TextWatermark : Watermark

Inheritance: objectReportObjectWatermarkTextWatermark

Inherited Members Watermark.PositionWatermark.OpacityWatermark.PrintOnFirstPageWatermark.PrintOnLastPage

Constructors

TextWatermark()

TODO: Add documentation.

Declaration

cs-api-definition
public TextWatermark()

Properties

Color

Gets or sets the color of the watermark text.

Declaration

cs-api-definition
public Color Color { get; set; }

Property Value

Color

A Color value that specifies the color of the watermark text without the transparency.

Font

Gets the font settings of the watermark text.

Declaration

cs-api-definition
public Font Font { get; }

Property Value

Font

A Font value that specifies the font settings of the watermark text.

Orientation

Gets or sets the orientation of the watermark text on the printable page.

Declaration

cs-api-definition
public WatermarkOrientation Orientation { get; set; }

Property Value

WatermarkOrientation

A WatermarkOrientation value that specifies the orientation of the watermark text on the printable page.

Text

Gets or sets the text of the watermark to be printed on the page.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

A string started with "=" is interpreted as an expression to calculate the real data, otherwise - literal string. Supports embedded expressions also.

Remarks

The text can be specified either directly as a string literal or indirectly as an expression that is evaluated at runtime for each printable page. If the text is null (Nothing in Visual Basic) or an empty string, or if the specified expression evaluates to null (Nothing in Visual Basic) or an empty string, the watermark is not printed on the current page.

Example

The following expression prints a watermark on every second page:

csharp
= If(PageNumber % 2 = 0, "Watermark", Null)

Methods

GetStrings()

Internal use only

Declaration

cs-api-definition
protected override IEnumerable<string> GetStrings()

Returns

IEnumerable<string>

Overrides Watermark.GetStrings()