PageWatermark.ImageViewMode Property

Gets or sets the mode in which a picture PageWatermark is displayed.

Namespace: DevExpress.XtraPrinting.Drawing

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

Declaration

[DefaultValue(ImageViewMode.Clip)]
public ImageViewMode ImageViewMode { get; set; }

Property Value

Type Default Description
ImageViewMode

Clip

An ImageViewMode enumeration value specifying how the picture should be displayed.

Available values:

Name Description
Clip

The image is placed in the upper-left corner of the image control. The image is clipped if it’s larger than the image control which contains it.

Stretch

The image within the image control is stretched or shrunk, as appropriate, to fit the size of the image control.

Zoom

The image is sized proportionally (without clipping), so that it best fits the image control. If the height and width ratio of the image control is the same as the image’s ratio it will be resized to exactly fit into the image control. Otherwise, the closest fitting side (height or width) of the image will be sized to the control. The other side (height or width) of the image will be sized proportionally (leaving empty space).

Remarks

This member is in effect only for picture watermarks.

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.

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);
}
See Also