HtmlViewOptions Leave feedback

Inheritance: java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions

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
 }
 

public static final String CREATE_PAGE_STREAM

public static final String FILE_PATH_FORMAT

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: boolean - true if responsive rendering is enabled, false otherwise.

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:

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: boolean - true if minification is enabled, false otherwise.

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:

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);
 }

Returns: boolean

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);
 }

Parameters:

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: int - the maximum width of an output image.

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:

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: int - the maximum height of an output image.

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:

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: int - the width of the output image.

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:

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: int - the height of the output image in pixels.

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:

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: boolean - true if the output HTML should be optimized for printing, false otherwise.

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:

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: boolean - true if fonts should be excluded, false otherwise.

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:

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().isExcludeFonts()/#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled. For details and code example, see the documentation.

Returns: java.util.List<java.lang.String> - the list of font names to exclude from the HTML document.

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().isExcludeFonts()/#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled. For details and code example, see the documentation.

Parameters:

public final boolean isRemoveJavaScript()

Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (true).

For details about removing JavaScript, see the documentation.

Returns: boolean

public void setRemoveJavaScript(boolean value)

Sets permission to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (true).

For details about removing JavaScript, see the documentation.

Parameters:

public IDocumentSavingCallback getDocumentSavingCallback()

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

Returns: com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback used to estimate the document saving progress.

public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)

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

Parameters:

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:

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

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:

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

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:

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

public static HtmlViewOptions forEmbeddedResources()

Initializes a new instance of the HtmlViewOptions class.

For the code example, see the documentation.

Returns: HtmlViewOptions - a new instance of the HtmlViewOptions class.

public static HtmlViewOptions forEmbeddedResources(String filePathFormat)

Initializes a new instance of the HtmlViewOptions class.

For the code example, see the documentation.

Parameters:

Returns: HtmlViewOptions - a new instance of the HtmlViewOptions class.

public static HtmlViewOptions forEmbeddedResources(Path filePathFormat)

Initializes a new instance of the HtmlViewOptions class.

For the code example, see the documentation.

Parameters:

Returns: HtmlViewOptions - a new instance of the HtmlViewOptions class.

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:

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

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:

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

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:

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

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.

Returns: HtmlViewOptions

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:

Returns: HtmlViewOptions