Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfWatermarkOptions

OfficeIMO.Pdf

Namespace
OfficeIMO.Pdf
Assembly
OfficeIMO.Pdf
Source revision
e163ccb36643 with working tree changes
Implements
IPdfOperationCancellation
Modifiers
sealed

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

Inheritance

  • object
  • PdfWatermarkOptions

Usage

Explore 3 API references to this type

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

Accepted by parameters 1

Constructors

public PdfWatermarkOptions() #

Methods

public PdfWatermarkOptions Clone() #

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 PdfWatermarkOptions.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 OfficeLength? X { get; set; } #

Nonnegative physical left offset on the visual page; null centers the rectangle horizontally.

public OfficeLength? Y { get; set; } #

Nonnegative physical top offset on the visual page; null centers the rectangle vertically.

public OfficeLength Width { get; set; } #

Physical unrotated rectangle width. Defaults to 360 points.

public OfficeLength Height { get; set; } #

Physical unrotated rectangle height. Defaults to 100 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 bool BehindContent { get; set; } #

Draws the watermark beneath existing page content when true.

public OfficeLength FontSize { get; set; } #

Physical text size. Defaults to 42 points.

public PdfStandardFont Font { get; set; } #

Standard text font.

public OfficeColor Color { get; set; } #

Text color. Image pixels retain their own colors.