com.ironsoftware.ironpdf.internal.staticapi

Class Render_Api

java.lang.Object

com.ironsoftware.ironpdf.internal.staticapi.Render_Api

public final class Render_Api
extends Object

The type Render api.

Constructor Summary

Constructors

Constructor and Description
Render_Api()

Method Summary

Modifier and Type	Method and Description
static InternalPdfDocument	renderHtmlAsPdf(String html) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlAsPdf(String html, ChromeHttpLoginCredentials loginCredentials) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlAsPdf(String html, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials, String baseUrl) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlAsPdf(String html, String baseUrl) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlAsPdf(String html, String baseUrl, ChromeHttpLoginCredentials loginCredentials) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlAsPdf(String html, String baseUrl, ChromePdfRenderOptions renderOptions) Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlFileAsPdf(String htmlFilePath) Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlFileAsPdf(String htmlFilePath, ChromeHttpLoginCredentials loginCredentials) Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlFileAsPdf(String htmlFilePath, ChromePdfRenderOptions renderOptions) Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderHtmlFileAsPdf(String htmlFilePath, String baseUrl, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials) Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderRtfAsPdf(String rtfString) Creates a PDF file from RTF string, and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderUrlAsPdf(String url) Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderUrlAsPdf(String url, ChromeHttpLoginCredentials loginCredentials) Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderUrlAsPdf(String url, ChromePdfRenderOptions renderOptions) Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderUrlAsPdf(String url, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials) Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.
static InternalPdfDocument	renderZipAsPdf(Path zipFilePath, String mainFile, ChromePdfRenderOptions renderOptions, ChromeHttpLoginCredentials loginCredentials)

Methods inherited from class java.lang.Object

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

Constructor Detail

Render_Api

public Render_Api()

Method Detail

renderHtmlFileAsPdf

public static InternalPdfDocument renderHtmlFileAsPdf(String htmlFilePath)
                                               throws IOException

Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.

Parameters:

htmlFilePath - Path to a Html to be rendered as a PDF.

Returns:

A InternalPdfDocument

Throws:

IOException - the io exception

renderHtmlFileAsPdf

public static InternalPdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                                      String baseUrl,
                                                      ChromePdfRenderOptions renderOptions,
                                                      ChromeHttpLoginCredentials loginCredentials)
                                               throws IOException

Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.

Parameters:

htmlFilePath - Path to a Html to be rendered as a PDF.

renderOptions - Rendering options

loginCredentials - Http login credentials

Returns:

A InternalPdfDocument

Throws:

IOException - the io exception

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html,
                                                  ChromePdfRenderOptions renderOptions,
                                                  ChromeHttpLoginCredentials loginCredentials,
                                                  String baseUrl)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

renderOptions - Rendering options

loginCredentials - Http login credentials

baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.

Returns:

A InternalPdfDocument

renderHtmlFileAsPdf

public static InternalPdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                                      ChromeHttpLoginCredentials loginCredentials)
                                               throws IOException

Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.

Parameters:

htmlFilePath - Path to a Html to be rendered as a PDF.

loginCredentials - Http login credentials

Returns:

A InternalPdfDocument

Throws:

IOException - the io exception

renderHtmlFileAsPdf

public static InternalPdfDocument renderHtmlFileAsPdf(String htmlFilePath,
                                                      ChromePdfRenderOptions renderOptions)
                                               throws IOException

Creates a PDF file from a local Html file, and returns it as a InternalPdfDocument.

Parameters:

htmlFilePath - Path to a Html to be rendered as a PDF.

renderOptions - Rendering options

Returns:

A InternalPdfDocument

Throws:

IOException - the io exception

renderUrlAsPdf

public static InternalPdfDocument renderUrlAsPdf(String url)

Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.

Parameters:

url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.

Returns:

A InternalPdfDocument

renderUrlAsPdf

public static InternalPdfDocument renderUrlAsPdf(String url,
                                                 ChromePdfRenderOptions renderOptions,
                                                 ChromeHttpLoginCredentials loginCredentials)

Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.

Parameters:

url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.

renderOptions - Rendering options

loginCredentials - Http login credentials

Returns:

A InternalPdfDocument

renderUrlAsPdf

public static InternalPdfDocument renderUrlAsPdf(String url,
                                                 ChromeHttpLoginCredentials loginCredentials)

Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.

Parameters:

url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.

loginCredentials - Http login credentials

Returns:

A InternalPdfDocument

renderUrlAsPdf

public static InternalPdfDocument renderUrlAsPdf(String url,
                                                 ChromePdfRenderOptions renderOptions)

Creates a PDF file from a URL or local file path and returns it as a InternalPdfDocument.

Parameters:

url - An absolute (fully formed) Uri. Points to the Html document to be rendered as a PDF.

renderOptions - Rendering options

Returns:

A InternalPdfDocument

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

Returns:

A InternalPdfDocument

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html,
                                                  String baseUrl,
                                                  ChromeHttpLoginCredentials loginCredentials)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.

loginCredentials - Http login credentials

Returns:

A InternalPdfDocument

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html,
                                                  String baseUrl,
                                                  ChromePdfRenderOptions renderOptions)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.

renderOptions - Rendering options

Returns:

A InternalPdfDocument

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html,
                                                  ChromePdfRenderOptions renderOptions,
                                                  ChromeHttpLoginCredentials loginCredentials)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

renderOptions - Rendering options

loginCredentials - Http login credentials

Returns:

A InternalPdfDocument

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html,
                                                  String baseUrl)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

baseUrl - Optional. Setting the BaseURL property gives the relative file path or URL context for hyperlinks, images, CSS and JavaScript files.

Returns:

A InternalPdfDocument

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html,
                                                  ChromeHttpLoginCredentials loginCredentials)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

loginCredentials - Http login credentials

Returns:

A InternalPdfDocument

renderHtmlAsPdf

public static InternalPdfDocument renderHtmlAsPdf(String html,
                                                  ChromePdfRenderOptions renderOptions)

Creates a PDF file from a Html string, and returns it as a InternalPdfDocument.

Parameters:

html - The Html to be rendered as a PDF.

renderOptions - Rendering options

Returns:

A InternalPdfDocument

renderRtfAsPdf

public static InternalPdfDocument renderRtfAsPdf(String rtfString)

Creates a PDF file from RTF string, and returns it as a InternalPdfDocument.

Parameters:

rtfString - The RTF string to be rendered as a PDF.

Returns:

A InternalPdfDocument

renderZipAsPdf

public static InternalPdfDocument renderZipAsPdf(Path zipFilePath,
                                                 String mainFile,
                                                 ChromePdfRenderOptions renderOptions,
                                                 ChromeHttpLoginCredentials loginCredentials)
                                          throws IOException

Throws:

IOException