public class LoadOptions extends Object
Allows a developer to specify additional options (such as a password) when loading a file.
Learn more
Constructor and Description |
---|
LoadOptions()
Initializes a new instance of the
LoadOptions class. |
LoadOptions(FileFormat fileFormat)
Initializes a new instance of the
LoadOptions class. |
Modifier and Type | Method and Description |
---|---|
FileFormat |
getFileFormat()
Gets the exact type of the file that is to be loaded.
|
String |
getPassword()
Gets the password for opening an encrypted document.
|
void |
setPassword(String value)
Sets the password for opening an encrypted document.
|
public LoadOptions()
Initializes a new instance of the LoadOptions
class.
public LoadOptions(FileFormat fileFormat)
Initializes a new instance of the LoadOptions
class.
fileFormat
- The exact type of the file.public final String getPassword()
Gets the password for opening an encrypted document.
public final void setPassword(String value)
Sets the password for opening an encrypted document.
value
- Can be null or empty string. The default value is null.
If the document is not encrypted, set this to null or the empty string.public final FileFormat getFileFormat()
Gets the exact type of the file that is to be loaded.
The default value is FileFormat.Unknown
which means that the type should be detected automatically.