com.groupdocs.viewer.options

Class WordProcessingOptions

java.lang.Object

com.groupdocs.viewer.options.WordProcessingOptions

public class WordProcessingOptions
extends Object

Provides options for rendering word processing documents.

The WordProcessingOptions class provides options for rendering word processing documents in the GroupDocs.Viewer component. It encapsulates settings and parameters that can be used to control the rendering process and output format for word processing files. For details, see the documentation.

Example usage:

 PngViewOptions pngViewOptions = new PngViewOptions();
 WordProcessingOptions wordProcessingOptions = pngViewOptions.getWordProcessingOptions();
 wordProcessingOptions.setRenderTrackedChanges(true);
 wordProcessingOptions.setLeftMargin(32f);

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

See Also:

Viewer, PngViewOptions

Constructor Summary

Constructors

Constructor and Description
WordProcessingOptions() Initializes a new instance of the WordProcessingOptions class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Check if the options are changed.
Double	getBottomMargin() Bottom page margin (for HTML rendering only)
int	getHorizontalResolution() Gets the horizontal resolution for generated images in dots per inch.
Double	getLeftMargin() Retrieves the left page margin for HTML rendering.
WordsPageNumberLocation	getPageNumberLocation() Allows to forcibly apply page numbering for the loaded WordProcessing document.
PageSize	getPageSize() Retrieves the page size for rendering HTM and HTML files.
Double	getRightMargin() Gets the right page margin for HTML rendering.
Double	getTopMargin() Retrieves the top page margin for HTML rendering.
int	getVerticalResolution() Gets the vertical resolution for generated images in dots per inch.
int	hashCode()
boolean	isEnableOpenTypeFeatures() This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.
boolean	isRenderTrackedChanges() Indicates whether tracked changes (revisions) rendering is enabled.
boolean	isUnlinkTableOfContents() Indicates whether table of contents navigation should be disabled when rendering to HTML or PDF.
boolean	isUpdateFields() Gets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats.
void	setBottomMargin(Double bottomMargin) Sets the bottom page margin for HTML rendering.
void	setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures) This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.
void	setHorizontalResolution(int horizontalResolution) Sets the horizontal resolution for generated images in dots per inch.
void	setLeftMargin(Double leftMargin) Sets the left page margin for HTML rendering.
void	setPageNumberLocation(WordsPageNumberLocation pageNumberLocation) Allows to forcibly apply page numbering for the loaded WordProcessing document.
void	setPageSize(PageSize pageSize) Sets the page size for rendering HTM and HTML files.
void	setRenderTrackedChanges(boolean value) Sets whether tracked changes (revisions) rendering is enabled.
void	setRightMargin(Double rightMargin) Sets the right page margin for HTML rendering.
void	setTopMargin(Double topMargin) Sets the top page margin for HTML rendering.
void	setUnlinkTableOfContents(boolean unlinkTableOfContents) Sets whether table of contents navigation should be disabled when rendering to HTML or PDF.
void	setUpdateFields(boolean updateFields) Sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats.
void	setVerticalResolution(int verticalResolution) Sets the vertical resolution for generated images in dots per inch.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordProcessingOptions

public WordProcessingOptions()

Initializes a new instance of the WordProcessingOptions class. Contains options for rendering word processing documents. For details, see the documentation.

Method Detail

equals

public boolean equals(Object o)

Check if the options are changed.

Overrides:

equals in class Object

Parameters:

o - The object to compare for equality.

Returns:

true if the options are equal to the specified object, false otherwise.

getBottomMargin

public Double getBottomMargin()

Bottom page margin (for HTML rendering only)

For details, see the documentation.

Returns:

the bottom page margin.

getHorizontalResolution

public int getHorizontalResolution()

Gets the horizontal resolution for generated images in dots per inch. This option is used when rendering WordProcessing documents to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

Returns:

the horizontal resolution in DPI.

getLeftMargin

public Double getLeftMargin()

Retrieves the left page margin for HTML rendering.

For details, see the documentation.

Returns:

the left page margin value.

getPageNumberLocation

public WordsPageNumberLocation getPageNumberLocation()

Allows to forcibly apply page numbering for the loaded WordProcessing document. By default is WordsPageNumberLocation.NOT_APPLY — document is intact.

Returns:

the page number location.

getPageSize

public PageSize getPageSize()

Retrieves the page size for rendering HTM and HTML files.

When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using PageSize.A3.

Note: The default value is PageSize.UNSPECIFIED, which means that a page size set in the page settings (Page Setup) will be used.

Returns:

The size of the output page.

getRightMargin

public Double getRightMargin()

Gets the right page margin for HTML rendering.

For details, see the documentation.

Returns:

the right page margin value.

getTopMargin

public Double getTopMargin()

Retrieves the top page margin for HTML rendering.

For details, see the documentation.

Returns:

the top page margin.

getVerticalResolution

public int getVerticalResolution()

Gets the vertical resolution for generated images in dots per inch. This option is used when rendering WordProcessing documents to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

Returns:

the vertical resolution in DPI.

hashCode

public int hashCode()

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

Note: This method overrides the default implementation of the hashCode() method defined in the Object class.

Overrides:

hashCode in class Object

Returns:

the hash code value for this object.

isEnableOpenTypeFeatures

public boolean isEnableOpenTypeFeatures()

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.

Returns:

True if OpenType features are enabled, false otherwise.

isRenderTrackedChanges

public final boolean isRenderTrackedChanges()

Indicates whether tracked changes (revisions) rendering is enabled.

For details, see the documentation.

Returns:

true if tracked changes rendering is enabled, false otherwise.

isUnlinkTableOfContents

public boolean isUnlinkTableOfContents()

Indicates whether table of contents navigation should be disabled when rendering to HTML or PDF. When this option is set to true, for HTML rendering, relative links from the table of contents will be replaced with span tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links.

Returns:

True if table of content navigation is disabled; otherwise, false.

isUpdateFields

public boolean isUpdateFields()

Gets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is true — fields will be updated before saving.

For details, see the documentation.

setBottomMargin

public void setBottomMargin(Double bottomMargin)

Sets the bottom page margin for HTML rendering.

For details, see the documentation.

Parameters:

bottomMargin - The bottom page margin to set.

setEnableOpenTypeFeatures

public void setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures)

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.

Parameters:

enableOpenTypeFeatures - True to enable OpenType features, false otherwise.

setHorizontalResolution

public void setHorizontalResolution(int horizontalResolution)

Sets the horizontal resolution for generated images in dots per inch. This option is used when rendering WordProcessing documents to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

Parameters:

horizontalResolution - the horizontal resolution in DPI.

setLeftMargin

public void setLeftMargin(Double leftMargin)

Sets the left page margin for HTML rendering.

For details, see the documentation.

Parameters:

leftMargin - The left page margin value to set.

setPageNumberLocation

public void setPageNumberLocation(WordsPageNumberLocation pageNumberLocation)

Allows to forcibly apply page numbering for the loaded WordProcessing document. By default is WordsPageNumberLocation.NOT_APPLY — document is intact.

Parameters:

pageNumberLocation - the page number location.

Throws:

IllegalArgumentException - if pageNumberLocation is null.

setPageSize

public void setPageSize(PageSize pageSize)

Sets the page size for rendering HTM and HTML files.

When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using PageSize.A3.

Note: The default value is PageSize.UNSPECIFIED, which means that a page size set in the page settings (Page Setup) will be used.

Parameters:

pageSize - The size of the output page.

setRenderTrackedChanges

public final void setRenderTrackedChanges(boolean value)

Sets whether tracked changes (revisions) rendering is enabled.

For details, see the documentation.

Parameters:

value - true to enable tracked changes rendering, false to disable it.

setRightMargin

public void setRightMargin(Double rightMargin)

Sets the right page margin for HTML rendering.

For details, see the documentation.

Parameters:

rightMargin - The right page margin value to set.

setTopMargin

public void setTopMargin(Double topMargin)

Sets the top page margin for HTML rendering.

For details, see the documentation.

Parameters:

topMargin - The top page margin to set.

setUnlinkTableOfContents

public void setUnlinkTableOfContents(boolean unlinkTableOfContents)

Sets whether table of contents navigation should be disabled when rendering to HTML or PDF. When this option is set to true, for HTML rendering, relative links from the table of contents will be replaced with span tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links.

Parameters:

unlinkTableOfContents - Indicates whether table of content navigation should be disabled.

setUpdateFields

public void setUpdateFields(boolean updateFields)

Sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is true — fields will be updated before saving.

For details, see the documentation.

setVerticalResolution

public void setVerticalResolution(int verticalResolution)

Sets the vertical resolution for generated images in dots per inch. This option is used when rendering WordProcessing documents to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

Parameters:

verticalResolution - the vertical resolution in DPI.