Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfWatermarkOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Visual text or image watermark placed in a rectangle on existing PDF pages.

Inheritance

  • Object
  • PdfWatermarkOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

Methods

public PdfWatermarkOptions Clone() #
Returns: PdfWatermarkOptions

Creates an independent copy, including any encoded image bytes.

Properties

public String Id { get; set; } #

Stable identifier for this watermark. Reusing it revises the existing watermark; use a new identifier to add another.

public String Text { get; set; } #

Text to draw when ImageBytes is null.

public Byte[] ImageBytes { get; set; } #

Optional encoded image. When supplied, it replaces the text appearance.

public PdfPageSelector TargetPages { get; set; } #

Target pages; null selects every page.

public Nullable<Double> X { get; set; } #

Left edge in visual page points; null centers the rectangle horizontally.

public Nullable<Double> Y { get; set; } #

Top edge in visual page points; null centers the rectangle vertically.

public Double Width { get; set; } #

Unrotated rectangle width in points.

public Double Height { get; set; } #

Unrotated rectangle height in points.

public Double RotationDegrees { get; set; } #

Clockwise rotation around the rectangle center, in degrees.

public Double Opacity { get; set; } #

Opacity between zero and one, for either text or image content.

public Boolean BehindContent { get; set; } #

Draws the watermark beneath existing page content when true.

public Double FontSize { get; set; } #

Text size in points.

public PdfStandardFont Font { get; set; } #

Standard text font.

public PdfColor Color { get; set; } #

Text color. Image pixels retain their own colors.