com.groupdocs.viewer.options

Class HtmlViewOptions

java.lang.Object

com.groupdocs.viewer.options.BaseViewOptions

com.groupdocs.viewer.options.ViewOptions

com.groupdocs.viewer.options.HtmlViewOptions

public class HtmlViewOptions
extends ViewOptions

Provides options for rendering documents into HTML format.

The HtmlViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into HTML format in the GroupDocs.Viewer component.

For details, see the topic and its children.

Example usage:

 HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources();
 options.setExcludeFonts(true);
 options.setFontsToExclude(Arrays.asList("font-name"));

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(options);
     // Use the viewer object for further operations
 }
 

See Also:

Viewer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_PAGE_STREAM
static String	FILE_PATH_FORMAT

Method Summary

Modifier and Type	Method and Description
static HtmlViewOptions	forEmbeddedResources() Initializes a new instance of the HtmlViewOptions class.
static HtmlViewOptions	forEmbeddedResources(CreatePageStream createPageStream) Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.
static HtmlViewOptions	forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream) Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.
static HtmlViewOptions	forEmbeddedResources(PageStreamFactory pageStreamFactory) Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.
static HtmlViewOptions	forEmbeddedResources(Path filePathFormat) Initializes a new instance of the HtmlViewOptions class.
static HtmlViewOptions	forEmbeddedResources(String filePathFormat) Initializes a new instance of the HtmlViewOptions class.
static HtmlViewOptions	forExternalResources() Initializes new instance of HtmlViewOptions class.
static HtmlViewOptions	forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl) Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources.
static HtmlViewOptions	forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream) Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources.
static HtmlViewOptions	forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory) Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources.
static HtmlViewOptions	forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat) Initializes a new instance of the HtmlViewOptions class.
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback	getDocumentSavingCallback() Retrieves the callback used to estimate the saving progress of a Words or Email document.
List<String>	getFontsToExclude() Retrieves the list of font names to exclude from the HTML document.
int	getImageHeight() Gets the height of the output image in pixels when converting a single image to HTML.
int	getImageMaxHeight() Gets the maximum height of an output image in pixels.
int	getImageMaxWidth() Returns the maximum width of an output image in pixels.
int	getImageWidth() Gets the width of the output image in pixels.
boolean	isExcludeFonts() Determines whether to exclude fonts from the HTML document.
boolean	isForPrinting() Checks if the output HTML should be optimized for printing.
boolean	isMinify() Checks if HTML content and HTML resources minification is enabled.
boolean	isRenderResponsive() Determines whether responsive rendering is enabled.
boolean	isRenderToSinglePage() Enables rendering an entire document to one HTML file.
void	setDocumentSavingCallback(com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback documentSavingCallback) Sets the callback used to estimate the saving progress of a Words or Email document.
void	setExcludeFonts(boolean value) Sets whether to exclude fonts from the HTML document.
void	setFontsToExclude(List<String> value) Sets the list of font names to exclude from the HTML document.
void	setForPrinting(boolean value) Sets whether the output HTML should be optimized for printing.
void	setImageHeight(int imageHeight) Sets the height of the output image in pixels when converting a single image to HTML.
void	setImageMaxHeight(int imageMaxHeight) Sets the maximum height of an output image in pixels.
void	setImageMaxWidth(int imageMaxWidth) Sets the maximum width of an output image in pixels.
void	setImageWidth(int imageWidth) Sets the width of the output image in pixels.
void	setMinify(boolean value) Sets whether HTML content and HTML resources minification is enabled.
void	setRenderResponsive(boolean value) Sets whether responsive rendering is enabled.
void	setRenderToSinglePage(boolean renderSinglePage) Enables rendering an entire document to one HTML file.

Methods inherited from class com.groupdocs.viewer.options.ViewOptions

getPageRotations, getWatermark, isPageRotationsInitialized_Internal, rotatePage, setWatermark

Methods inherited from class com.groupdocs.viewer.options.BaseViewOptions

getArchiveOptions, getCadOptions, getDefaultFontName, getEmailOptions, getMailStorageOptions, getOutlookOptions, getPdfOptions, getPresentationOptions, getProjectManagementOptions, getSpreadsheetOptions, getTextOptions, getVisioRenderingOptions, getWebDocumentOptions, getWordProcessingOptions, isCadOptionsInitialized_Internal, isRenderComments, isRenderHiddenPages, isRenderNotes, setArchiveOptions, setCadOptions, setDefaultFontName, setEmailOptions, setMailStorageOptions, setOutlookOptions, setPdfOptions, setPresentationOptions, setProjectManagementOptions, setRenderComments, setRenderHiddenPages, setRenderNotes, setSpreadsheetOptions, setTextOptions, setVisioRenderingOptions, setWebDocumentOptions, setWordProcessingOptions

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_PAGE_STREAM

public static final String CREATE_PAGE_STREAM

See Also:

Constant Field Values

FILE_PATH_FORMAT

public static final String FILE_PATH_FORMAT

See Also:

Constant Field Values

Method Detail

forEmbeddedResources

public static HtmlViewOptions forEmbeddedResources()

Initializes a new instance of the HtmlViewOptions class.

For the code example, see the documentation.

Returns:

a new instance of the HtmlViewOptions class.

forEmbeddedResources

public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageStream)

Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.

Note: The method takes a CreatePageStream parameter, which is a method used to instantiate a stream for writing output page data. For the code example, see the documentation.

Parameters:

createPageStream - The method that instantiates a stream used to write output page data.

Returns:

a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.

See Also:

CreatePageStream

forEmbeddedResources

public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageStream,
                                                   ReleasePageStream releasePageStream)

Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.

For the code example, see the documentation.

Parameters:

createPageStream - The method that instantiates a stream used to write output page data.

releasePageStream - The method that releases the stream created by the method assigned to the createPageStream parameter.

Returns:

a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.

Throws:

IllegalArgumentException - If the createPageStream or releasePageStream is null.

See Also:

CreatePageStream, ReleasePageStream

forEmbeddedResources

public static HtmlViewOptions forEmbeddedResources(PageStreamFactory pageStreamFactory)

Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.

For the code example, see the documentation.

Parameters:

pageStreamFactory - The factory that implements methods for creating and releasing the output page stream.

Returns:

a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.

Throws:

IllegalArgumentException - If the pageStreamFactory is null.

See Also:

PageStreamFactory

forEmbeddedResources

public static HtmlViewOptions forEmbeddedResources(Path filePathFormat)

Initializes a new instance of the HtmlViewOptions class.

For the code example, see the documentation.

Parameters:

filePathFormat - The file path format, e.g., 'page_{0}.html'.

Returns:

a new instance of the HtmlViewOptions class.

Throws:

IllegalArgumentException - If filePathFormat is null.

forEmbeddedResources

public static HtmlViewOptions forEmbeddedResources(String filePathFormat)

Initializes a new instance of the HtmlViewOptions class.

For the code example, see the documentation.

Parameters:

filePathFormat - The file path format, e.g., 'page_{0}.html'.

Returns:

a new instance of the HtmlViewOptions class.

Throws:

IllegalArgumentException - If filePathFormat is null or empty.

forExternalResources

public static HtmlViewOptions forExternalResources()

Initializes new instance of HtmlViewOptions class.

• - with "p_{0}.html" as file path format for the output HTML files;
• - with "p_{0}_{1}" as file path format for the output HTML-resource files;
• - with "p_{0}_{1}" as URL format for HTML-resources;

The output files will be placed into current working directory of the application. For the code example, see the documentation.

Throws:

IllegalArgumentException - Thrown when the filePathFormat is null or empty.

forExternalResources

public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream,
                                                   CreateResourceStream createResourceStream,
                                                   CreateResourceUrl createResourceUrl)

Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources.

Note: This method should be used when rendering HTML with external resources, such as CSS and JavaScript files. For the code example, see the documentation.

Parameters:

createPageStream - The method that instantiates the stream used to write output page data.

createResourceStream - The method that releases the stream created by the createPageStream method.

createResourceUrl - The method that creates the URL for the HTML resource.

Returns:

a new instance of the HtmlViewOptions class for rendering into HTML with external resources.

Throws:

IllegalArgumentException - If createPageStream is null.

IllegalArgumentException - If createResourceStream is null.

IllegalArgumentException - If createResourceUrl is null.

forExternalResources

public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream,
                                                   CreateResourceStream createResourceStream,
                                                   CreateResourceUrl createResourceUrl,
                                                   ReleasePageStream releasePageStream,
                                                   ReleaseResourceStream releaseResourceStream)

Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources.

For the code example, see the documentation.

Parameters:

createPageStream - The method that instantiates the stream used to write output page data.

createResourceStream - The method that instantiates the stream used to write output HTML resource data.

createResourceUrl - The method that creates the URL for the HTML resource.

releasePageStream - The method that releases the stream created by the createPageStream method.

releaseResourceStream - The method that releases the stream created by the createResourceStream method.

Returns:

a new instance of the HtmlViewOptions class for rendering into HTML with external resources.

Throws:

IllegalArgumentException - Thrown when createPageStream, createResourceStream, createResourceUrl, releasePageStream or releaseResourceStream is null.

forExternalResources

public static HtmlViewOptions forExternalResources(PageStreamFactory pageStreamFactory,
                                                   ResourceStreamFactory resourceStreamFactory)

Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources.

For the code example, see the documentation.

Parameters:

pageStreamFactory - The factory that implements methods for creating and releasing the output page stream.

resourceStreamFactory - The factory that implements methods for creating resource URLs and instantiating/releasing the output HTML resource stream.

Returns:

a new instance of the HtmlViewOptions class for rendering into HTML with external resources.

Throws:

IllegalArgumentException - Thrown when pageStreamFactory or resourceStreamFactory is null.

forExternalResources

public static HtmlViewOptions forExternalResources(String filePathFormat,
                                                   String resourceFilePathFormat,
                                                   String resourceUrlFormat)

Initializes a new instance of the HtmlViewOptions class.

For the code example, see the documentation.

Parameters:

filePathFormat - The file path format, e.g., 'page_{0}.html'.

resourceFilePathFormat - The resource file path format, e.g., 'page_{0}/resource_{1}'.

resourceUrlFormat - The resource URL format, e.g., 'page_{0}/resource_{1}'.

Throws:

IllegalArgumentException - Thrown when filePathFormat, resourceFilePathFormat or resourceUrlFormat is null or empty.

getDocumentSavingCallback

public com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback getDocumentSavingCallback()

Retrieves the callback used to estimate the saving progress of a Words or Email document.

Returns:

the callback used to estimate the document saving progress.

getFontsToExclude

public final List<String> getFontsToExclude()

Retrieves the list of font names to exclude from the HTML document.

This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems.

Note: Please note that this property is active only when the ExcludeFonts (isExcludeFonts()/setExcludeFonts(boolean)) option is disabled. For details and code example, see the documentation.

Returns:

the list of font names to exclude from the HTML document.

getImageHeight

public int getImageHeight()

Gets the height of the output image in pixels when converting a single image to HTML.

For details and code example, see the documentation.

Returns:

the height of the output image in pixels.

getImageMaxHeight

public int getImageMaxHeight()

Gets the maximum height of an output image in pixels.

Note: This option applies when converting a single image to HTML. It specifies the maximum height of the output image. For details and code example, see the documentation.

Returns:

the maximum height of an output image.

getImageMaxWidth

public int getImageMaxWidth()

Returns the maximum width of an output image in pixels.

Note: This value is used when converting a single image to HTML. For details and code example, see the documentation.

Returns:

the maximum width of an output image.

getImageWidth

public int getImageWidth()

Gets the width of the output image in pixels.

Note: This value is applicable only when converting a single image to HTML. For details and code example, see the documentation.

Returns:

the width of the output image.

isExcludeFonts

public final boolean isExcludeFonts()

Determines whether to exclude fonts from the HTML document.

By default, GroupDocs.Viewer embeds the fonts used in the document into HTML. To prevent it, set this property to true. For details and code example, see the documentation.

Returns:

true if fonts should be excluded, false otherwise.

isForPrinting

public final boolean isForPrinting()

Checks if the output HTML should be optimized for printing.

Enable this option to convert the output HTML pages to the vector SVG format. For details and code example, see the documentation.

Returns:

true if the output HTML should be optimized for printing, false otherwise.

isMinify

public final boolean isMinify()

Checks if HTML content and HTML resources minification is enabled.

Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to true. For code example, see the documentation.

Returns:

true if minification is enabled, false otherwise.

isRenderResponsive

public final boolean isRenderResponsive()

Determines whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes.

Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to true. For code example, see the documentation.

Returns:

true if responsive rendering is enabled, false otherwise.

isRenderToSinglePage

public boolean isRenderToSinglePage()

Enables rendering an entire document to one HTML file.

See the following topics for more information:

• Render archives as HTML, PDF, and image files
• Render text documents as HTML, PDF, and image files
• Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files
• Render web documents as PDF, PNG, and JPEG files

Example:

 try (final Viewer viewer = new Viewer("invoice.docx")) {
   HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
   viewOptions.setRenderToSinglePage(true);

   viewer.view(viewOptions);
 }
 

setDocumentSavingCallback

public void setDocumentSavingCallback(com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback documentSavingCallback)

Sets the callback used to estimate the saving progress of a Words or Email document.

Parameters:

documentSavingCallback - The callback used to estimate the document saving progress.

setExcludeFonts

public final void setExcludeFonts(boolean value)

Sets whether to exclude fonts from the HTML document.

By default, GroupDocs.Viewer embeds the fonts used in the document into HTML. To prevent it, set this property to true. For details and code example, see the documentation.

Parameters:

value - true to exclude fonts, false otherwise.

setFontsToExclude

public final void setFontsToExclude(List<String> value)

Sets the list of font names to exclude from the HTML document.

This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems.

Note: Please note that this property is active only when the ExcludeFonts (isExcludeFonts()/setExcludeFonts(boolean)) option is disabled. For details and code example, see the documentation.

Parameters:

value - The list of font names to exclude from the HTML document.

setForPrinting

public final void setForPrinting(boolean value)

Sets whether the output HTML should be optimized for printing.

Enable this option to convert the output HTML pages to the vector SVG format. For details and code example, see the documentation.

Parameters:

value - true to optimize the output HTML for printing, false otherwise.

setImageHeight

public void setImageHeight(int imageHeight)

Sets the height of the output image in pixels when converting a single image to HTML.

For details and code example, see the documentation.

Parameters:

imageHeight - The height of the output image in pixels.

setImageMaxHeight

public void setImageMaxHeight(int imageMaxHeight)

Sets the maximum height of an output image in pixels.

Note: This option applies when converting a single image to HTML. It specifies the maximum height of the output image. For details and code example, see the documentation.

Parameters:

imageMaxHeight - The maximum height of an output image.

setImageMaxWidth

public void setImageMaxWidth(int imageMaxWidth)

Sets the maximum width of an output image in pixels.

Note: This value is used when converting a single image to HTML. For details and code example, see the documentation.

Parameters:

imageMaxWidth - The maximum width of an output image.

setImageWidth

public void setImageWidth(int imageWidth)

Sets the width of the output image in pixels.

Note: This value is applicable only when converting a single image to HTML. For details and code example, see the documentation.

Parameters:

imageWidth - The width of the output image.

setMinify

public final void setMinify(boolean value)

Sets whether HTML content and HTML resources minification is enabled.

Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to true. For code example, see the documentation.

Parameters:

value - true to enable minification, false to disable.

setRenderResponsive

public final void setRenderResponsive(boolean value)

Sets whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes.

Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to true. For code example, see the documentation.

Parameters:

value - true to enable responsive rendering, false to disable it.

setRenderToSinglePage

public void setRenderToSinglePage(boolean renderSinglePage)

Enables rendering an entire document to one HTML file.

See the following topics for more information:

• Render archives as HTML, PDF, and image files
• Render text documents as HTML, PDF, and image files
• Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files
• Render web documents as PDF, PNG, and JPEG files

Example:

 try (final Viewer viewer = new Viewer("invoice.docx")) {
   HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
   viewOptions.setRenderToSinglePage(true);

   viewer.view(viewOptions);
 }