Package com.groupdocs.cloud.conversion.model

Class WordProcessingLoadOptions

java.lang.Object

com.groupdocs.cloud.conversion.model.LoadOptions

com.groupdocs.cloud.conversion.model.WordProcessingLoadOptions

Direct Known Subclasses:

DocLoadOptions, DocmLoadOptions, DocxLoadOptions, DotLoadOptions, DotmLoadOptions, DotxLoadOptions, MobiLoadOptions, OdtLoadOptions, OttLoadOptions

public class WordProcessingLoadOptions
extends LoadOptions

WordProcessing document load options

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WordProcessingLoadOptions.CommentDisplayModeEnum	Specifies how comments should be displayed in the output document.

Constructor Summary

Constructors

Constructor	Description
WordProcessingLoadOptions()

Method Summary

Modifier and Type	Method	Description
WordProcessingLoadOptions	autoHyphenation(Boolean autoHyphenation)
WordProcessingLoadOptions	bookmarksOutlineLevel(Integer bookmarksOutlineLevel)
WordProcessingLoadOptions	clearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)
WordProcessingLoadOptions	clearCustomDocumentProperties(Boolean clearCustomDocumentProperties)
WordProcessingLoadOptions	commentDisplayMode(WordProcessingLoadOptions.CommentDisplayModeEnum commentDisplayMode)
WordProcessingLoadOptions	convertOwned(Boolean convertOwned)
WordProcessingLoadOptions	convertOwner(Boolean convertOwner)
WordProcessingLoadOptions	defaultFont(String defaultFont)
WordProcessingLoadOptions	depth(Integer depth)
WordProcessingLoadOptions	embedTrueTypeFonts(Boolean embedTrueTypeFonts)
boolean	equals(Object o)
WordProcessingLoadOptions	expandedOutlineLevels(Integer expandedOutlineLevels)
WordProcessingLoadOptions	fontConfigSubstitutionEnabled(Boolean fontConfigSubstitutionEnabled)
WordProcessingLoadOptions	fontInfoSubstitutionEnabled(Boolean fontInfoSubstitutionEnabled)
WordProcessingLoadOptions	fontNameSubstitutionEnabled(Boolean fontNameSubstitutionEnabled)
WordProcessingLoadOptions	fontSubstitutes(Map<String,String> fontSubstitutes)
Boolean	getAutoHyphenation()	Gets or sets value determining whether automatic hyphenation is turned on for the document.
Integer	getBookmarksOutlineLevel()	Specifies the default level in the document outline at which to display Word bookmarks.
Boolean	getClearBuiltInDocumentProperties()	Clear built-in document properties.
Boolean	getClearCustomDocumentProperties()	Clear custom document properties.
WordProcessingLoadOptions.CommentDisplayModeEnum	getCommentDisplayMode()	Specifies how comments should be displayed in the output document.
Boolean	getConvertOwned()	Option to control whether the owned documents in the documents container must be converted
Boolean	getConvertOwner()	Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document.
String	getDefaultFont()	Default font for Words document.
Integer	getDepth()	Option to control how many levels in depth to perform conversion.
Boolean	getEmbedTrueTypeFonts()	If EmbedTrueTypeFonts is true, GroupDocs.Conversion Cloud embed true type fonts in the output document.
Integer	getExpandedOutlineLevels()	Specifies how many levels in the document outline to show expanded when the file is viewed.
Boolean	getFontConfigSubstitutionEnabled()	Automatically substitutes missing fonts based on FontConfig in the system.
Boolean	getFontInfoSubstitutionEnabled()	Automatically substitutes missing fonts based on FontInfo in the document.
Boolean	getFontNameSubstitutionEnabled()	Automatically substitutes missing fonts based on the font name.
Map<String,String>	getFontSubstitutes()	Substitute specific fonts when converting Words document.
Integer	getHeadingsOutlineLevels()	Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.
Boolean	getHideWordTrackedChanges()	Hide markup and track changes for Word documents
Boolean	getHyphenateCaps()	Gets or sets value determining whether words written in all capital letters are hyphenated.
Boolean	getKeepDateFieldOriginalValue()	Keep original value of date field.
Boolean	getPageNumbering()	Enable or disable generation of page numbering in converted document.
String	getPassword()	Set password to unprotect protected document
Boolean	getPreserveDocumentStructure()	Determines whether the document structure should be preserved when converting to PDF (default is false).
Boolean	getPreserveFormFields()	Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.
Boolean	getShowFullCommenterName()	Show full commenter name in comments.
Boolean	getSkipExternalResources()	If true all external resource will not be loading.
Boolean	getUpdateFields()	Update fields after loading.
Boolean	getUpdatePageLayout()	Update page layout after loading.
Boolean	getUseTextShaper()	Specifies whether to use a text shaper for better kerning display.
int	hashCode()
WordProcessingLoadOptions	headingsOutlineLevels(Integer headingsOutlineLevels)
WordProcessingLoadOptions	hideWordTrackedChanges(Boolean hideWordTrackedChanges)
WordProcessingLoadOptions	hyphenateCaps(Boolean hyphenateCaps)
WordProcessingLoadOptions	keepDateFieldOriginalValue(Boolean keepDateFieldOriginalValue)
WordProcessingLoadOptions	pageNumbering(Boolean pageNumbering)
WordProcessingLoadOptions	password(String password)
WordProcessingLoadOptions	preserveDocumentStructure(Boolean preserveDocumentStructure)
WordProcessingLoadOptions	preserveFormFields(Boolean preserveFormFields)
WordProcessingLoadOptions	putFontSubstitutesItem(String key, String fontSubstitutesItem)
void	setAutoHyphenation(Boolean autoHyphenation)
void	setBookmarksOutlineLevel(Integer bookmarksOutlineLevel)
void	setClearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)
void	setClearCustomDocumentProperties(Boolean clearCustomDocumentProperties)
void	setCommentDisplayMode(WordProcessingLoadOptions.CommentDisplayModeEnum commentDisplayMode)
void	setConvertOwned(Boolean convertOwned)
void	setConvertOwner(Boolean convertOwner)
void	setDefaultFont(String defaultFont)
void	setDepth(Integer depth)
void	setEmbedTrueTypeFonts(Boolean embedTrueTypeFonts)
void	setExpandedOutlineLevels(Integer expandedOutlineLevels)
void	setFontConfigSubstitutionEnabled(Boolean fontConfigSubstitutionEnabled)
void	setFontInfoSubstitutionEnabled(Boolean fontInfoSubstitutionEnabled)
void	setFontNameSubstitutionEnabled(Boolean fontNameSubstitutionEnabled)
void	setFontSubstitutes(Map<String,String> fontSubstitutes)
void	setHeadingsOutlineLevels(Integer headingsOutlineLevels)
void	setHideWordTrackedChanges(Boolean hideWordTrackedChanges)
void	setHyphenateCaps(Boolean hyphenateCaps)
void	setKeepDateFieldOriginalValue(Boolean keepDateFieldOriginalValue)
void	setPageNumbering(Boolean pageNumbering)
void	setPassword(String password)
void	setPreserveDocumentStructure(Boolean preserveDocumentStructure)
void	setPreserveFormFields(Boolean preserveFormFields)
void	setShowFullCommenterName(Boolean showFullCommenterName)
void	setSkipExternalResources(Boolean skipExternalResources)
void	setUpdateFields(Boolean updateFields)
void	setUpdatePageLayout(Boolean updatePageLayout)
void	setUseTextShaper(Boolean useTextShaper)
WordProcessingLoadOptions	showFullCommenterName(Boolean showFullCommenterName)
WordProcessingLoadOptions	skipExternalResources(Boolean skipExternalResources)
String	toString()
WordProcessingLoadOptions	updateFields(Boolean updateFields)
WordProcessingLoadOptions	updatePageLayout(Boolean updatePageLayout)
WordProcessingLoadOptions	useTextShaper(Boolean useTextShaper)

Methods inherited from class com.groupdocs.cloud.conversion.model.LoadOptions

format, getFormat, setFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

WordProcessingLoadOptions

public WordProcessingLoadOptions()

Method Detail

defaultFont

public WordProcessingLoadOptions defaultFont(String defaultFont)

getDefaultFont

public String getDefaultFont()

Default font for Words document. The following font will be used if a font is missing.

Returns:

defaultFont

setDefaultFont

public void setDefaultFont(String defaultFont)

fontSubstitutes

public WordProcessingLoadOptions fontSubstitutes(Map<String,String> fontSubstitutes)

putFontSubstitutesItem

public WordProcessingLoadOptions putFontSubstitutesItem(String key,
                                                        String fontSubstitutesItem)

getFontSubstitutes

public Map<String,String> getFontSubstitutes()

Substitute specific fonts when converting Words document.

Returns:

fontSubstitutes

setFontSubstitutes

public void setFontSubstitutes(Map<String,String> fontSubstitutes)

password

public WordProcessingLoadOptions password(String password)

getPassword

public String getPassword()

Set password to unprotect protected document

Returns:

password

setPassword

public void setPassword(String password)

hideWordTrackedChanges

public WordProcessingLoadOptions hideWordTrackedChanges(Boolean hideWordTrackedChanges)

getHideWordTrackedChanges

public Boolean getHideWordTrackedChanges()

Hide markup and track changes for Word documents

Returns:

hideWordTrackedChanges

setHideWordTrackedChanges

public void setHideWordTrackedChanges(Boolean hideWordTrackedChanges)

bookmarksOutlineLevel

public WordProcessingLoadOptions bookmarksOutlineLevel(Integer bookmarksOutlineLevel)

getBookmarksOutlineLevel

public Integer getBookmarksOutlineLevel()

Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.

Returns:

bookmarksOutlineLevel

setBookmarksOutlineLevel

public void setBookmarksOutlineLevel(Integer bookmarksOutlineLevel)

headingsOutlineLevels

public WordProcessingLoadOptions headingsOutlineLevels(Integer headingsOutlineLevels)

getHeadingsOutlineLevels

public Integer getHeadingsOutlineLevels()

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.

Returns:

headingsOutlineLevels

setHeadingsOutlineLevels

public void setHeadingsOutlineLevels(Integer headingsOutlineLevels)

expandedOutlineLevels

public WordProcessingLoadOptions expandedOutlineLevels(Integer expandedOutlineLevels)

getExpandedOutlineLevels

public Integer getExpandedOutlineLevels()

Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.

Returns:

expandedOutlineLevels

setExpandedOutlineLevels

public void setExpandedOutlineLevels(Integer expandedOutlineLevels)

clearCustomDocumentProperties

public WordProcessingLoadOptions clearCustomDocumentProperties(Boolean clearCustomDocumentProperties)

getClearCustomDocumentProperties

public Boolean getClearCustomDocumentProperties()

Clear custom document properties. Default is false.

Returns:

clearCustomDocumentProperties

setClearCustomDocumentProperties

public void setClearCustomDocumentProperties(Boolean clearCustomDocumentProperties)

clearBuiltInDocumentProperties

public WordProcessingLoadOptions clearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)

getClearBuiltInDocumentProperties

public Boolean getClearBuiltInDocumentProperties()

Clear built-in document properties. Default is false.

Returns:

clearBuiltInDocumentProperties

setClearBuiltInDocumentProperties

public void setClearBuiltInDocumentProperties(Boolean clearBuiltInDocumentProperties)

depth

public WordProcessingLoadOptions depth(Integer depth)

getDepth

public Integer getDepth()

Option to control how many levels in depth to perform conversion. Default: 1.

Returns:

depth

setDepth

public void setDepth(Integer depth)

convertOwned

public WordProcessingLoadOptions convertOwned(Boolean convertOwned)

getConvertOwned

public Boolean getConvertOwned()

Option to control whether the owned documents in the documents container must be converted

Returns:

convertOwned

setConvertOwned

public void setConvertOwned(Boolean convertOwned)

convertOwner

public WordProcessingLoadOptions convertOwner(Boolean convertOwner)

getConvertOwner

public Boolean getConvertOwner()

Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document. Default is true.

Returns:

convertOwner

setConvertOwner

public void setConvertOwner(Boolean convertOwner)

autoHyphenation

public WordProcessingLoadOptions autoHyphenation(Boolean autoHyphenation)

getAutoHyphenation

public Boolean getAutoHyphenation()

Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is false.

Returns:

autoHyphenation

setAutoHyphenation

public void setAutoHyphenation(Boolean autoHyphenation)

hyphenateCaps

public WordProcessingLoadOptions hyphenateCaps(Boolean hyphenateCaps)

getHyphenateCaps

public Boolean getHyphenateCaps()

Gets or sets value determining whether words written in all capital letters are hyphenated. Default value for this property is true.

Returns:

hyphenateCaps

setHyphenateCaps

public void setHyphenateCaps(Boolean hyphenateCaps)

pageNumbering

public WordProcessingLoadOptions pageNumbering(Boolean pageNumbering)

getPageNumbering

public Boolean getPageNumbering()

Enable or disable generation of page numbering in converted document. Default: false

Returns:

pageNumbering

setPageNumbering

public void setPageNumbering(Boolean pageNumbering)

preserveDocumentStructure

public WordProcessingLoadOptions preserveDocumentStructure(Boolean preserveDocumentStructure)

getPreserveDocumentStructure

public Boolean getPreserveDocumentStructure()

Determines whether the document structure should be preserved when converting to PDF (default is false).

Returns:

preserveDocumentStructure

setPreserveDocumentStructure

public void setPreserveDocumentStructure(Boolean preserveDocumentStructure)

skipExternalResources

public WordProcessingLoadOptions skipExternalResources(Boolean skipExternalResources)

getSkipExternalResources

public Boolean getSkipExternalResources()

If true all external resource will not be loading. Default is true.

Returns:

skipExternalResources

setSkipExternalResources

public void setSkipExternalResources(Boolean skipExternalResources)

useTextShaper

public WordProcessingLoadOptions useTextShaper(Boolean useTextShaper)

getUseTextShaper

public Boolean getUseTextShaper()

Specifies whether to use a text shaper for better kerning display. Default is false.

Returns:

useTextShaper

setUseTextShaper

public void setUseTextShaper(Boolean useTextShaper)

preserveFormFields

public WordProcessingLoadOptions preserveFormFields(Boolean preserveFormFields)

getPreserveFormFields

public Boolean getPreserveFormFields()

Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

Returns:

preserveFormFields

setPreserveFormFields

public void setPreserveFormFields(Boolean preserveFormFields)

commentDisplayMode

public WordProcessingLoadOptions commentDisplayMode(WordProcessingLoadOptions.CommentDisplayModeEnum commentDisplayMode)

getCommentDisplayMode

public WordProcessingLoadOptions.CommentDisplayModeEnum getCommentDisplayMode()

Specifies how comments should be displayed in the output document. Default is Balloon.

Returns:

commentDisplayMode

setCommentDisplayMode

public void setCommentDisplayMode(WordProcessingLoadOptions.CommentDisplayModeEnum commentDisplayMode)

keepDateFieldOriginalValue

public WordProcessingLoadOptions keepDateFieldOriginalValue(Boolean keepDateFieldOriginalValue)

getKeepDateFieldOriginalValue

public Boolean getKeepDateFieldOriginalValue()

Keep original value of date field. Default: false

Returns:

keepDateFieldOriginalValue

setKeepDateFieldOriginalValue

public void setKeepDateFieldOriginalValue(Boolean keepDateFieldOriginalValue)

updateFields

public WordProcessingLoadOptions updateFields(Boolean updateFields)

getUpdateFields

public Boolean getUpdateFields()

Update fields after loading. Default: false

Returns:

updateFields

setUpdateFields

public void setUpdateFields(Boolean updateFields)

updatePageLayout

public WordProcessingLoadOptions updatePageLayout(Boolean updatePageLayout)

getUpdatePageLayout

public Boolean getUpdatePageLayout()

Update page layout after loading. Default: false

Returns:

updatePageLayout

setUpdatePageLayout

public void setUpdatePageLayout(Boolean updatePageLayout)

embedTrueTypeFonts

public WordProcessingLoadOptions embedTrueTypeFonts(Boolean embedTrueTypeFonts)

getEmbedTrueTypeFonts

public Boolean getEmbedTrueTypeFonts()

If EmbedTrueTypeFonts is true, GroupDocs.Conversion Cloud embed true type fonts in the output document. Default: true

Returns:

embedTrueTypeFonts

setEmbedTrueTypeFonts

public void setEmbedTrueTypeFonts(Boolean embedTrueTypeFonts)

fontInfoSubstitutionEnabled

public WordProcessingLoadOptions fontInfoSubstitutionEnabled(Boolean fontInfoSubstitutionEnabled)

getFontInfoSubstitutionEnabled

public Boolean getFontInfoSubstitutionEnabled()

Automatically substitutes missing fonts based on FontInfo in the document. Default: false.

Returns:

fontInfoSubstitutionEnabled

setFontInfoSubstitutionEnabled

public void setFontInfoSubstitutionEnabled(Boolean fontInfoSubstitutionEnabled)

fontConfigSubstitutionEnabled

public WordProcessingLoadOptions fontConfigSubstitutionEnabled(Boolean fontConfigSubstitutionEnabled)

getFontConfigSubstitutionEnabled

public Boolean getFontConfigSubstitutionEnabled()

Automatically substitutes missing fonts based on FontConfig in the system. Default: false.

Returns:

fontConfigSubstitutionEnabled

setFontConfigSubstitutionEnabled

public void setFontConfigSubstitutionEnabled(Boolean fontConfigSubstitutionEnabled)

fontNameSubstitutionEnabled

public WordProcessingLoadOptions fontNameSubstitutionEnabled(Boolean fontNameSubstitutionEnabled)

getFontNameSubstitutionEnabled

public Boolean getFontNameSubstitutionEnabled()

Automatically substitutes missing fonts based on the font name. Default: false.

Returns:

fontNameSubstitutionEnabled

setFontNameSubstitutionEnabled

public void setFontNameSubstitutionEnabled(Boolean fontNameSubstitutionEnabled)

showFullCommenterName

public WordProcessingLoadOptions showFullCommenterName(Boolean showFullCommenterName)

getShowFullCommenterName

public Boolean getShowFullCommenterName()

Show full commenter name in comments. Default is false.

Returns:

showFullCommenterName

setShowFullCommenterName

public void setShowFullCommenterName(Boolean showFullCommenterName)

equals

public boolean equals(Object o)

Overrides:

equals in class LoadOptions

hashCode

public int hashCode()

Overrides:

hashCode in class LoadOptions

toString

public String toString()

Overrides:

toString in class LoadOptions