com.groupdocs.metadata.options

Class LoadOptions

java.lang.Object

com.groupdocs.metadata.options.LoadOptions

public class LoadOptions
extends Object

Allows a developer to specify additional options (such as a password) when loading a file.

Learn more

• Load from a local disk
• Load from a stream
• Load a file of a specific format
• Load a password-protected document

Constructor Summary

Constructors

Constructor and Description
LoadOptions() Initializes a new instance of the LoadOptions class.
LoadOptions(FileFormat fileFormat) Initializes a new instance of the LoadOptions class.

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoadOptions

public LoadOptions()

Initializes a new instance of the LoadOptions class.

LoadOptions

public LoadOptions(FileFormat fileFormat)

Initializes a new instance of the LoadOptions class.

Parameters:

fileFormat - The exact type of the file.

Method Detail

getFileFormat

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.

Returns:

The exact type of the file that is to be loaded.

getPassword

public final String getPassword()

Gets the password for opening an encrypted document.

Returns:

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.

setPassword

public final void setPassword(String value)

Sets the password for opening an encrypted document.

Parameters:

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.