com.ironsoftware.ironpdf.stamp

Class HtmlStamper

java.lang.Object

com.ironsoftware.ironpdf.stamp.Stamper

com.ironsoftware.ironpdf.stamp.HtmlStamper

public class HtmlStamper
extends Stamper

Defines an HTML stamper allowing developers to edit a PdfDocument by adding new content designed in HTML, CSS and JavaScript.

An implementation of Stamper.

See: PdfDocument.applyStamp(Stamper)

Constructor Summary

Constructors

Constructor and Description
HtmlStamper() Initializes a new instance of the HtmlStamper class.
HtmlStamper(String html) Initializes a new instance of the HtmlStamper class.
HtmlStamper(String html, Path baseUrl) Initializes a new instance of the HtmlStamper class.
HtmlStamper(String html, String baseUrlString) Initializes a new instance of the HtmlStamper class.

Method Summary

Modifier and Type	Method and Description
CssMediaType	getCssMediaType() Gets css media type.
String	getHtmlBaseUrl() Gets the HTML base URL for which references to external CSS, Javascript and Image files will be relative.
int	getRenderDelay() Gets render delay.
int	getTimeout() Gets timeout.
void	setCssMediaType(CssMediaType value) Sets css media type.
void	setHtmlBaseUrl(String value) Sets the HTML base URL for which references to external CSS, Javascript and Image files will be relative.
void	setRenderDelay(int value) Sets render delay.
void	setTimeout(int value) Sets timeout.

Methods inherited from class com.ironsoftware.ironpdf.stamp.Stamper

getHorizontalAlignment, getHorizontalOffset, getHtml, getHyperlink, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpacity, getRotation, getScale, getVerticalAlignment, getVerticalOffset, isStampBehindContent, setHorizontalAlignment, setHorizontalOffset, setHtml, setHyperlink, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOpacity, setRotation, setScale, setStampBehindContent, setVerticalAlignment, setVerticalOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlStamper

public HtmlStamper(String html)

Initializes a new instance of the HtmlStamper class.

Parameters:

html - The HTML string.

HtmlStamper

public HtmlStamper(String html,
                   String baseUrlString)

Initializes a new instance of the HtmlStamper class.

Parameters:

html - The HTML string.

baseUrlString - The HTML base URL for which references to external CSS, Javascript and Image files will be relative.

HtmlStamper

public HtmlStamper(String html,
                   Path baseUrl)

Initializes a new instance of the HtmlStamper class.

Parameters:

html - The HTML string.

baseUrl - The HTML base URL for which references to external CSS, Javascript and Image files will be relative.

HtmlStamper

public HtmlStamper()

Initializes a new instance of the HtmlStamper class.

Method Detail

getHtmlBaseUrl

public final String getHtmlBaseUrl()

Gets the HTML base URL for which references to external CSS, Javascript and Image files will be relative.

Returns:

the html base url

setHtmlBaseUrl

public final void setHtmlBaseUrl(String value)

Sets the HTML base URL for which references to external CSS, Javascript and Image files will be relative.

Parameters:

value - the value

getRenderDelay

public final int getRenderDelay()

Gets render delay. Milliseconds to wait after Html is rendered before printing. This can use useful when considering the rendering of JavaScript, WebFonts, Ajax or animations.

Default value is 0.

Returns:

the render delay

setRenderDelay

public final void setRenderDelay(int value)

Sets render delay. Milliseconds to wait after Html is rendered before printing. This can use useful when considering the rendering of JavaScript, WebFonts, Ajax or animations.

Default value is 0.

Parameters:

value - the value

getTimeout

public final int getTimeout()

Gets timeout. Render timeout in seconds

Default value is 60.

Returns:

the timeout

setTimeout

public final void setTimeout(int value)

Sets timeout. Render timeout in seconds

Default value is 60.

Parameters:

value - the value

getCssMediaType

public final CssMediaType getCssMediaType()

Gets css media type. Enables Media="screen" CSS Styles and StyleSheets

Note: By setting CssMediaType=PRINT, IronPdf renders Stamp from HTML using CSS for media="print" as if printing a web page in a browser print dialog. It renders exactly as per Google Chrome.

Default value is CssMediaType.SCREEN.

Returns:

the css media type

setCssMediaType

public final void setCssMediaType(CssMediaType value)

Sets css media type. Enables Media="screen" CSS Styles and StyleSheets

Note: By setting CssMediaType=PRINT, IronPdf renders Stamp from HTML using CSS for media="print" as if printing a web page in a browser print dialog. It renders exactly as per Google Chrome.

Default value is CssMediaType.SCREEN.

Parameters:

value - the value