public final class WordProcessingSaveOptions extends Object implements ISaveOptions
Allows to specify custom options for generating and saving WordProcessing-compliant documents after they were edited
Constructor and Description |
---|
WordProcessingSaveOptions(WordProcessingFormats outputFormat)
Creates a new instance of WordProcessingSaveOptions with specified
mandatory WordProcessing output format, while all other parameters are
default
|
Modifier and Type | Method and Description |
---|---|
WordProcessingSaveOptions |
deepClone()
Creates and returns a full copy of this instance of
WordProcessingSaveOptions class
|
boolean |
getEnablePagination()
Allows to enable or disable pagination which will be used for saving the
document.
|
byte |
getFontEmbedding()
Responsible for embedding font resources into output WordProcessing
document.
|
Locale |
getLocale()
Allows to set override default locale (language) for the WordProcessing
document, which will be applied during its creation.
|
Locale |
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.
|
Locale |
getLocaleFarEast()
Allows to override the locale (language) for the WordProcessing 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.
|
WordProcessingFormats |
getOutputFormat()
Allows to specify a WordProcessing 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 WordProcessing document.
|
WordProcessingProtection |
getProtection()
Allows to control and apply the document protection options for the
WordProcessing document of any format, which supports document
protection.
|
void |
setEnablePagination(boolean value)
Allows to enable or disable pagination which will be used for saving the
document.
|
void |
setFontEmbedding(byte value)
Responsible for embedding font resources into output WordProcessing
document.
|
void |
setLocale(Locale value)
Allows to set override default locale (language) for the WordProcessing
document, which will be applied during its creation.
|
void |
setLocaleBi(Locale value)
Allows to set override locale (language) for the WordProcessing 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 WordProcessing 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(WordProcessingFormats value)
Allows to specify a WordProcessing 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 WordProcessing document.
|
void |
setProtection(WordProcessingProtection value)
Allows to control and apply the document protection options for the
WordProcessing document of any format, which supports document
protection.
|
public WordProcessingSaveOptions(WordProcessingFormats outputFormat)
Creates a new instance of WordProcessingSaveOptions with specified mandatory WordProcessing output format, while all other parameters are default
outputFormat
- Mandatory output format, in which the WordProcessing
document should be savedpublic final WordProcessingSaveOptions deepClone()
Creates and returns a full copy of this instance of WordProcessingSaveOptions class
public final 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.
public final byte getFontEmbedding()
Responsible for embedding font resources into output WordProcessing document. By default doesn't embed any fonts (NotEmbed).
public final Locale 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.
public final Locale 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.
This option forcibly applies the specified locale to overall RTL text in the document. Do not use it, if document contains different parts of text, which are written on different languages.
public final Locale 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.
This option forcibly applies the specified locale to overall East-Asian text in the document. Do not use it, if document contains different parts of text, which are written on different languages.
public final 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 final WordProcessingFormats getOutputFormat()
Allows to specify a WordProcessing format, which will be used for saving the document
public final String getPassword()
Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated WordProcessing document. Specify NULL or empty string for removing (cleaning) the password.
public final WordProcessingProtection getProtection()
Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection. By default is NULL - document protection will not be used.
public final void setEnablePagination(boolean value)
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.
value
- public final void setFontEmbedding(byte value)
Responsible for embedding font resources into output WordProcessing document. By default doesn't embed any fonts (NotEmbed).
value
- public final void setLocale(Locale value)
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.
This option forcibly applies the specified locale to overall text in the document. Do not use it, if document contains different parts of text, which are written on different languages.
value
- public final void setLocaleBi(Locale value)
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.
This option forcibly applies the specified locale to overall RTL text in the document. Do not use it, if document contains different parts of text, which are written on different languages.
value
- public final void setLocaleFarEast(Locale value)
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.
This option forcibly applies the specified locale to overall East-Asian text in the document. Do not use it, if document contains different parts of text, which are written on different languages.
value
- public final 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).
value
- public final void setOutputFormat(WordProcessingFormats value)
Allows to specify a WordProcessing format, which will be used for saving the document
value
- public final void setPassword(String value)
Allows to specify, modify, obtain, or remove a password, which will be used to encode the generated WordProcessing document. Specify NULL or empty string for removing (cleaning) the password.
value
- public final void setProtection(WordProcessingProtection value)
Allows to control and apply the document protection options for the WordProcessing document of any format, which supports document protection. By default is NULL - document protection will not be used.
value
-