Package com.groupdocs.cloud.viewer.model

Class WordProcessingOptions

java.lang.Object

com.groupdocs.cloud.viewer.model.WordProcessingOptions

public class WordProcessingOptions
extends Object

Provides options for rendering word processing documents

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WordProcessingOptions.PageSizeEnum	The size of the page.

Constructor Summary

Constructors

Constructor	Description
WordProcessingOptions()

Method Summary

Modifier and Type	Method	Description
WordProcessingOptions	bottomMargin(Double bottomMargin)
WordProcessingOptions	enableOpenTypeFeatures(Boolean enableOpenTypeFeatures)
boolean	equals(Object o)
Double	getBottomMargin()	Bottom page margin (for HTML rendering only)
Boolean	getEnableOpenTypeFeatures()	This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian Latin-based, or Cyrillic-based scripts.
Double	getLeftMargin()	Left page margin (for HTML rendering only)
WordProcessingOptions.PageSizeEnum	getPageSize()	The size of the page.
Boolean	getRenderTrackedChanges()	Enables tracked changes (revisions) rendering
Double	getRightMargin()	Right page margin (for HTML rendering only)
Double	getTopMargin()	Top page margin (for HTML rendering only)
Boolean	getUnlinkTableOfContents()	When rendering to HTML or PDF, you can set this option to `true` to disable navigation from the table of contents.
Boolean	getUpdateFields()	Determines if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats.
int	hashCode()
WordProcessingOptions	leftMargin(Double leftMargin)
WordProcessingOptions	pageSize(WordProcessingOptions.PageSizeEnum pageSize)
WordProcessingOptions	renderTrackedChanges(Boolean renderTrackedChanges)
WordProcessingOptions	rightMargin(Double rightMargin)
void	setBottomMargin(Double bottomMargin)
void	setEnableOpenTypeFeatures(Boolean enableOpenTypeFeatures)
void	setLeftMargin(Double leftMargin)
void	setPageSize(WordProcessingOptions.PageSizeEnum pageSize)
void	setRenderTrackedChanges(Boolean renderTrackedChanges)
void	setRightMargin(Double rightMargin)
void	setTopMargin(Double topMargin)
void	setUnlinkTableOfContents(Boolean unlinkTableOfContents)
void	setUpdateFields(Boolean updateFields)
WordProcessingOptions	topMargin(Double topMargin)
String	toString()
WordProcessingOptions	unlinkTableOfContents(Boolean unlinkTableOfContents)
WordProcessingOptions	updateFields(Boolean updateFields)

Methods inherited from class java.lang.Object

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

Constructor Detail

WordProcessingOptions

public WordProcessingOptions()

Method Detail

renderTrackedChanges

public WordProcessingOptions renderTrackedChanges(Boolean renderTrackedChanges)

getRenderTrackedChanges

public Boolean getRenderTrackedChanges()

Enables tracked changes (revisions) rendering

Returns:

renderTrackedChanges

setRenderTrackedChanges

public void setRenderTrackedChanges(Boolean renderTrackedChanges)

leftMargin

public WordProcessingOptions leftMargin(Double leftMargin)

getLeftMargin

public Double getLeftMargin()

Left page margin (for HTML rendering only)

Returns:

leftMargin

setLeftMargin

public void setLeftMargin(Double leftMargin)

rightMargin

public WordProcessingOptions rightMargin(Double rightMargin)

getRightMargin

public Double getRightMargin()

Right page margin (for HTML rendering only)

Returns:

rightMargin

setRightMargin

public void setRightMargin(Double rightMargin)

topMargin

public WordProcessingOptions topMargin(Double topMargin)

getTopMargin

public Double getTopMargin()

Top page margin (for HTML rendering only)

Returns:

topMargin

setTopMargin

public void setTopMargin(Double topMargin)

bottomMargin

public WordProcessingOptions bottomMargin(Double bottomMargin)

getBottomMargin

public Double getBottomMargin()

Bottom page margin (for HTML rendering only)

Returns:

bottomMargin

setBottomMargin

public void setBottomMargin(Double bottomMargin)

pageSize

public WordProcessingOptions pageSize(WordProcessingOptions.PageSizeEnum pageSize)

getPageSize

public WordProcessingOptions.PageSizeEnum getPageSize()

The size of the page.

Returns:

pageSize

setPageSize

public void setPageSize(WordProcessingOptions.PageSizeEnum pageSize)

enableOpenTypeFeatures

public WordProcessingOptions enableOpenTypeFeatures(Boolean enableOpenTypeFeatures)

getEnableOpenTypeFeatures

public Boolean getEnableOpenTypeFeatures()

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

Returns:

enableOpenTypeFeatures

setEnableOpenTypeFeatures

public void setEnableOpenTypeFeatures(Boolean enableOpenTypeFeatures)

unlinkTableOfContents

public WordProcessingOptions unlinkTableOfContents(Boolean unlinkTableOfContents)

getUnlinkTableOfContents

public Boolean getUnlinkTableOfContents()

When rendering to HTML or PDF, you can set this option to `true` to disable navigation from the table of contents. For HTML rendering, `a` tags with relative links 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 to document sections.

Returns:

unlinkTableOfContents

setUnlinkTableOfContents

public void setUnlinkTableOfContents(Boolean unlinkTableOfContents)

updateFields

public WordProcessingOptions updateFields(Boolean updateFields)

getUpdateFields

public Boolean getUpdateFields()

Determines 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.

Returns:

updateFields

setUpdateFields

public void setUpdateFields(Boolean updateFields)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object