Package com.groupdocs.cloud.editor.model

Class WordProcessingSaveOptions

java.lang.Object

com.groupdocs.cloud.editor.model.Options

com.groupdocs.cloud.editor.model.SaveOptions

com.groupdocs.cloud.editor.model.WordProcessingSaveOptions

public class WordProcessingSaveOptions
extends SaveOptions

Allows to specify custom options for generating and saving WordProcessing-compliant documents

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WordProcessingSaveOptions.ProtectionTypeEnum	Write-protection type.

Constructor Summary

Constructors

Constructor	Description
WordProcessingSaveOptions()

Method Summary

Modifier and Type	Method	Description
WordProcessingSaveOptions	enablePagination(Boolean enablePagination)
boolean	equals(Object o)
Boolean	getEnablePagination()	Allows to enable or disable pagination which will be used for saving the document.
String	getLocale()	Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation.
String	getLocaleBi()	Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation.
String	getLocaleFarEast()	Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation.
String	getPassword()	Allows to specify document password
String	getProtectionPassword()	Write-protection password.
WordProcessingSaveOptions.ProtectionTypeEnum	getProtectionType()	Write-protection type.
int	hashCode()
WordProcessingSaveOptions	locale(String locale)
WordProcessingSaveOptions	localeBi(String localeBi)
WordProcessingSaveOptions	localeFarEast(String localeFarEast)
WordProcessingSaveOptions	password(String password)
WordProcessingSaveOptions	protectionPassword(String protectionPassword)
WordProcessingSaveOptions	protectionType(WordProcessingSaveOptions.ProtectionTypeEnum protectionType)
void	setEnablePagination(Boolean enablePagination)
void	setLocale(String locale)
void	setLocaleBi(String localeBi)
void	setLocaleFarEast(String localeFarEast)
void	setPassword(String password)
void	setProtectionPassword(String protectionPassword)
void	setProtectionType(WordProcessingSaveOptions.ProtectionTypeEnum protectionType)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from class com.groupdocs.cloud.editor.model.Options

fileInfo, getFileInfo, getOutputPath, outputPath, setFileInfo, setOutputPath

Methods inherited from class com.groupdocs.cloud.editor.model.SaveOptions

format, getFormat, getHtmlPath, getResourcesPath, htmlPath, resourcesPath, setFormat, setHtmlPath, setResourcesPath

Constructor Detail

WordProcessingSaveOptions

public WordProcessingSaveOptions()

Method Detail

password

public WordProcessingSaveOptions password(String password)

getPassword

public String getPassword()

Allows to specify document password

Returns:

password

setPassword

public void setPassword(String password)

enablePagination

public WordProcessingSaveOptions enablePagination(Boolean enablePagination)

getEnablePagination

public Boolean getEnablePagination()

Allows to enable or disable pagination which will be used for saving the document. If the original document was opened and edited in pagination mode, this option also should be enabled. By default is disabled.

Returns:

enablePagination

setEnablePagination

public void setEnablePagination(Boolean enablePagination)

locale

public WordProcessingSaveOptions locale(String locale)

getLocale

public String getLocale()

Allows to set override default locale (language) for the WordProcessing document, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document locale according to its own settings or other factors.

Returns:

locale

setLocale

public void setLocale(String locale)

localeBi

public WordProcessingSaveOptions localeBi(String localeBi)

getLocaleBi

public String getLocaleBi()

Allows to set override locale (language) for the WordProcessing document for the RTL (right-to-left) text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document RTL locale according to its own settings or other factors.

Returns:

localeBi

setLocaleBi

public void setLocaleBi(String localeBi)

localeFarEast

public WordProcessingSaveOptions localeFarEast(String localeFarEast)

getLocaleFarEast

public String getLocaleFarEast()

Allows to override the locale (language) for the WordProcessing document for the East-Asian text, which will be applied during its creation. When is not specified (default value), MS Word (or other program) will detect (or choose) the document East-Asian locale according to its own settings or other factors.

Returns:

localeFarEast

setLocaleFarEast

public void setLocaleFarEast(String localeFarEast)

protectionType

public WordProcessingSaveOptions protectionType(WordProcessingSaveOptions.ProtectionTypeEnum protectionType)

getProtectionType

public WordProcessingSaveOptions.ProtectionTypeEnum getProtectionType()

Write-protection type. Default value is NoProtection

Returns:

protectionType

setProtectionType

public void setProtectionType(WordProcessingSaveOptions.ProtectionTypeEnum protectionType)

protectionPassword

public WordProcessingSaveOptions protectionPassword(String protectionPassword)

getProtectionPassword

public String getProtectionPassword()

Write-protection password. Used when protection type is specified.

Returns:

protectionPassword

setProtectionPassword

public void setProtectionPassword(String protectionPassword)

equals

public boolean equals(Object o)

Overrides:

equals in class SaveOptions

hashCode

public int hashCode()

Overrides:

hashCode in class SaveOptions

toString

public String toString()

Overrides:

toString in class SaveOptions