public final class SpreadsheetSaveOptions extends Object implements ISaveOptions
Allows to specify custom options for generating and saving Spreadsheet (Excel-compliant) documents
Constructor and Description |
---|
SpreadsheetSaveOptions(SpreadsheetFormats outputFormat)
Creates a new instance of SpreadsheetSaveOptions with specified mandatory
Spreadsheet output format, while all other parameters are default
|
Modifier and Type | Method and Description |
---|---|
SpreadsheetFormats |
getOutputFormat()
Allows to specify a Spreadsheet 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 Spreadsheet document, if tis document format
supports password protection.
|
WorksheetProtection |
getWorksheetProtection()
Allows to enable a worksheet protection for the output Spreadsheet
document.
|
void |
setOutputFormat(SpreadsheetFormats value)
Allows to specify a Spreadsheet 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 Spreadsheet document, if tis document format
supports password protection.
|
void |
setWorksheetProtection(WorksheetProtection value)
Allows to enable a worksheet protection for the output Spreadsheet
document.
|
public SpreadsheetSaveOptions(SpreadsheetFormats outputFormat)
Creates a new instance of SpreadsheetSaveOptions with specified mandatory Spreadsheet output format, while all other parameters are default
outputFormat
- Mandatory output format, in which the Spreadsheet
document should be savedpublic final SpreadsheetFormats getOutputFormat()
Allows to specify a Spreadsheet 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 Spreadsheet document, if tis document format supports password protection. Specify NULL or empty string for removing (cleaning) the password.
public final WorksheetProtection getWorksheetProtection()
Allows to enable a worksheet protection for the output Spreadsheet document. By default is NULL - protection is not applied. Not all formats support a worksheet protection.
public final void setOutputFormat(SpreadsheetFormats value)
Allows to specify a Spreadsheet 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 Spreadsheet document, if tis document format supports password protection. Specify NULL or empty string for removing (cleaning) the password.
value
- public final void setWorksheetProtection(WorksheetProtection value)
Allows to enable a worksheet protection for the output Spreadsheet document. By default is NULL - protection is not applied. Not all formats support a worksheet protection.
value
- Copyright © 2020. All rights reserved.