Class Stamper

Defines a PDF Stamper.

To see a full class walkthrough with diagrams and examples visit: https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#stamping-and-watermarking

Inheritance

System.Object

Stamper

Namespace: IronPdf.Editing

Assembly: IronPdf.dll

Syntax

public abstract class Stamper : Object

Properties

HorizontalAlignment

The horizontal alignment of the stamp relative to the page.

Documentation: Stamper layout

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
HorizontalAlignment

HorizontalOffset

The horizontal offset. Default value is 0, and default unit is Percentage.

Value of 0 has no effect.

Positive indicates an offset to the right direction.

Negative indicates an offset to the left direction.

Documentation: Stamper layout

Declaration

public Length HorizontalOffset { get; set; }

Property Value

Type	Description
Length

Html

The HTML fragment which will be stamped onto your PDF. All external references to JavaScript, CSS, and image files will be relative to IronPdf.Editing.Stamper.InnerHtmlBaseUrl.

Declaration

public string Html { set; }

Property Value

Type	Description
System.String

Hyperlink

Makes stamped elements of this Stamper have an on-click hyperlink.

Note: HTML links created by <a href=''> tags are not reserved by stamping.

Declaration

public string Hyperlink { get; set; }

Property Value

Type	Description
System.String

IsStampAnnotation

Set to true to apply the annotation stamp to the PDF.

Default is fault.

Declaration

public bool IsStampAnnotation { get; set; }

Property Value

Type	Description
System.Boolean

IsStampBehindContent

Set to true for apply stamp behind the content. If the content is opaque, the stamp may be invisible.

Declaration

public bool IsStampBehindContent { get; set; }

Property Value

Type	Description
System.Boolean

MaxHeight

The maximum height of the output stamp.

Declaration

public Length MaxHeight { get; set; }

Property Value

Type	Description
Length

MaxWidth

The maximum width of the output stamp.

Declaration

public Length MaxWidth { get; set; }

Property Value

Type	Description
Length

MinHeight

The minimum height of the output stamp.

Declaration

public Length MinHeight { get; set; }

Property Value

Type	Description
Length

MinWidth

The minimum width of the output stamp.

Declaration

public Length MinWidth { get; set; }

Property Value

Type	Description
Length

Opacity

Allows the stamp to be transparent. 0 is fully invisible, 100 if fully opaque.

Declaration

public int Opacity { get; set; }

Property Value

Type	Description
System.Int32

Rotation

Rotates the stamp clockwise from 0 to 360 degrees as specified.

Declaration

public int Rotation { get; set; }

Property Value

Type	Description
System.Int32

Scale

Applies a percentage scale to the stamps to be larger or smaller.

Default is 100 (Percent) which has no effect.

Declaration

public double Scale { get; set; }

Property Value

Type	Description
System.Double

Timeout

Render timeout in seconds

Default value is 60.

Declaration

public int Timeout { get; set; }

Property Value

Type	Description
System.Int32

VerticalAlignment

The vertical alignment of the stamp relative to the page.

Documentation: Stamper layout

Declaration

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
VerticalAlignment

VerticalOffset

The vertical offset. Default value is 0, and default unit is Percentage.

Value of 0 has no effect.

Positive indicates an offset in the downward direction.

Negative indicates an offset in the upward direction.

Documentation: Stamper layout

Declaration

public Length VerticalOffset { get; set; }

Property Value

Type	Description
Length

WaitFor

A convenient wrapper to wait for various events, or just wait for amount of time.

Declaration

public WaitFor WaitFor { get; set; }

Property Value

Type	Description
WaitFor

Methods

AntiClockwiseRotateAlignment(HorizontalAlignment, VerticalAlignment, PdfPageRotation)

Declaration

public static (HorizontalAlignment, VerticalAlignment) AntiClockwiseRotateAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign, PdfPageRotation degree)

Parameters

Type	Name	Description
HorizontalAlignment	hAlign
VerticalAlignment	vAlign
PdfPageRotation	degree

Returns

Type	Description
System.ValueTuple<HorizontalAlignment, VerticalAlignment>