Class
PictureWatermark

Represents a picture watermark on a printable page.

Definition

Namespace:Telerik.Reporting.Drawing

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
public class PictureWatermark : Watermark

Inheritance: objectReportObjectWatermarkPictureWatermark

Derived Classes: BackgroundOverlay

Inherited Members Watermark.ShouldSerializeOpacityCore()Watermark.ResetOpacityCore()Watermark.PositionWatermark.OpacityWatermark.PrintOnFirstPageWatermark.PrintOnLastPageReportObject.ToString(string[])

Constructors

PictureWatermark()

Internal use only

Declaration

cs-api-definition
public PictureWatermark()

PictureWatermark(PictureWatermark)

Internal use only

Declaration

cs-api-definition
public PictureWatermark(PictureWatermark watermark)

Parameters

watermark

PictureWatermark

Properties

Image

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

Declaration

cs-api-definition
[TypeConverter(typeof(SimpleImageConverter))]
public object Image { get; set; }

Property Value

object

The image of the watermark to be printed on the page.

Remarks

The specified image can be in one of the following supported formats: an object instance inherited from Image; an array of bytes containing binary image data; a local file path (relative or absolute) or an URL to an external image file. Instead of providing the image directly, it is possible to specify it indirectly as an expression that gets evaluated at runtime for each printable page. The result of the evaluation should be of one of the support types enumerated above. If the image is null (Nothing in Visual Basic), or if the specified expression evaluates to null (Nothing in Visual Basic), 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.png", Null)

Sizing

Gets or sets the sizing mode of the watermark image on the printable page.

Declaration

cs-api-definition
public WatermarkSizeMode Sizing { get; set; }

Property Value

WatermarkSizeMode

A ImageSizeMode value that specifies the sizing mode of the watermark image on the printable page.

Methods

GetStrings()

TODO: Add documentation.

Declaration

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

Returns

IEnumerable<string>

Overrides Watermark.GetStrings()

ResetSizingCore()

Internal use only

Declaration

cs-api-definition
protected virtual void ResetSizingCore()

ShouldSerializeSizingCore()

Internal use only

Declaration

cs-api-definition
protected virtual bool ShouldSerializeSizingCore()

Returns

bool