WordProcessingOptions Leave feedback

Inheritance: java.lang.Object

public class WordProcessingOptions

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
 }
 

public WordProcessingOptions()

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

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: PageSize - The size of the output page.

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:

public final boolean isRenderTrackedChanges()

Indicates whether tracked changes (revisions) rendering is enabled.

For details, see the documentation.

Returns: boolean - true if tracked changes rendering is enabled, false otherwise.

public final void setRenderTrackedChanges(boolean value)

Sets whether tracked changes (revisions) rendering is enabled.

For details, see the documentation.

Parameters:

public Double getLeftMargin()

Retrieves the left page margin for HTML rendering.

For details, see the documentation.

Returns: java.lang.Double - the left page margin value.

public void setLeftMargin(Double leftMargin)

Sets the left page margin for HTML rendering.

For details, see the documentation.

Parameters:

public Double getRightMargin()

Gets the right page margin for HTML rendering.

For details, see the documentation.

Returns: java.lang.Double - the right page margin value.

public void setRightMargin(Double rightMargin)

Sets the right page margin for HTML rendering.

For details, see the documentation.

Parameters:

public Double getTopMargin()

Retrieves the top page margin for HTML rendering.

For details, see the documentation.

Returns: java.lang.Double - the top page margin.

public void setTopMargin(Double topMargin)

Sets the top page margin for HTML rendering.

For details, see the documentation.

Parameters:

public Double getBottomMargin()

Bottom page margin (for HTML rendering only)

For details, see the documentation.

Returns: java.lang.Double - the bottom page margin.

public void setBottomMargin(Double bottomMargin)

Sets the bottom page margin for HTML rendering.

For details, see the documentation.

Parameters:

public boolean isEnableOpenTypeFeatures()

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

Returns: boolean - True if OpenType features are enabled, false otherwise.

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:

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: boolean - True if table of content navigation is disabled; otherwise, false.

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:

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 \u2014 fields will be updated before saving.

For details, see the documentation.

Returns: boolean

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 \u2014 fields will be updated before saving.

For details, see the documentation.

Parameters:

public boolean equals(Object o)

Check if the options are changed.

Parameters:

Returns: boolean - true if the options are equal to the specified object, false otherwise.

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.

Returns: int - the hash code value for this object.