public final class WordsSaveOptions extends Object implements IDocumentSaveOptions
Allows to specify custom options for generating and saving MS Word-compliant documents
Constructor and Description |
---|
WordsSaveOptions()
Creates a new instance of WordsSaveOptions with default Word format and absence password
|
WordsSaveOptions(byte outputFormat)
Creates a new instance of WordsSaveOptions with specified Word format and absence password
|
WordsSaveOptions(byte outputFormat,
String password)
Creates a new instance of WordsSaveOptions with specified Word format and encryption password
|
Modifier and Type | Method and Description |
---|---|
Locale |
getLocale()
Allows to set override default locale (language) for the Word document, which will be applied during its creation.
|
Locale |
getLocaleBi()
Allows to set override locale (language) for the Word document for the RTL (right-to-left) text, which will be applied during its creation.
|
Locale |
getLocaleFarEast()
Allows to override the locale (language) for the Word document for the East-Asian text, which will be applied during its creation.
|
boolean |
getOptimizeMemoryUsage()
Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage.
|
byte |
getOutputFormat()
Allows to specify a Word format, which will be used for saving the document.
|
String |
getPassword()
Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document.
|
com.groupdocs.editor.words.htmltowords.DocumentProtection |
getProtection()
Allows to control and apply the document protection options for the Words document of any format, which supports document protection.
|
void |
setLocale(Locale value)
Allows to set override default locale (language) for the Word document, which will be applied during its creation.
|
void |
setLocaleBi(Locale value)
Allows to set override locale (language) for the Word document for the RTL (right-to-left) text, which will be applied during its creation.
|
void |
setLocaleFarEast(Locale value)
Allows to override the locale (language) for the Word document for the East-Asian text, which will be applied during its creation.
|
void |
setOptimizeMemoryUsage(boolean value)
Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage.
|
void |
setOutputFormat(byte value)
Allows to specify a Word format, which will be used for saving the document.
|
void |
setPassword(String value)
Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document.
|
void |
setProtection(com.groupdocs.editor.words.htmltowords.DocumentProtection value)
Allows to control and apply the document protection options for the Words document of any format, which supports document protection.
|
public WordsSaveOptions()
Creates a new instance of WordsSaveOptions with default Word format and absence password
public WordsSaveOptions(byte outputFormat)
Creates a new instance of WordsSaveOptions with specified Word format and absence password
outputFormat
- public WordsSaveOptions(byte outputFormat, String password)
Creates a new instance of WordsSaveOptions with specified Word format and encryption password
outputFormat
- Output format of the Word documentpassword
- public Locale getLocale()
Allows to set override default locale (language) for the Word 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.
public Locale getLocaleBi()
Allows to set override locale (language) for the Word 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.
public Locale getLocaleFarEast()
Allows to override the locale (language) for the Word 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.
public boolean getOptimizeMemoryUsage()
Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).
public byte getOutputFormat()
Allows to specify a Word format, which will be used for saving the document. The default 'Auto' value implies DOCX.
public String getPassword()
Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document. Specify NULL or empty string for removing (cleaning) the password.
getPassword
in interface IDocumentSaveOptions
public com.groupdocs.editor.words.htmltowords.DocumentProtection getProtection()
Allows to control and apply the document protection options for the Words document of any format, which supports document protection. By default is NULL - document protection will not be used.
public void setLocale(Locale value)
Allows to set override default locale (language) for the Word 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.
public void setLocaleBi(Locale value)
Allows to set override locale (language) for the Word 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.
public void setLocaleFarEast(Locale value)
Allows to override the locale (language) for the Word 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.
public void setOptimizeMemoryUsage(boolean value)
Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).
public void setOutputFormat(byte value)
Allows to specify a Word format, which will be used for saving the document. The default 'Auto' value implies DOCX.
public void setPassword(String value)
Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated Words document. Specify NULL or empty string for removing (cleaning) the password.
setPassword
in interface IDocumentSaveOptions
public void setProtection(com.groupdocs.editor.words.htmltowords.DocumentProtection value)
Allows to control and apply the document protection options for the Words document of any format, which supports document protection. By default is NULL - document protection will not be used.
Copyright © 2018. All rights reserved.