LoadOptions

Inheritance: java.lang.Object

public class LoadOptions

Represents document loading options when loading a document.

Learn more:

• Loading documents
• Load from local disk
• Load from stream
• Load document of specific format
• Load password-protected document

Constructors

Constructor	Description
LoadOptions()	Initializes a new instance of the [LoadOptions](../../com.groupdocs.watermark.options/loadoptions) class.
LoadOptions(String password)	Initializes a new instance of the [LoadOptions](../../com.groupdocs.watermark.options/loadoptions) class with a specified password.

Methods

Method	Description
getPassword()	Gets the password for opening an encrypted document.
setPassword(String value)	Sets the password for opening an encrypted document.
getFormatFamily()	Get the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).
setFormatFamily(int formatFamily)	Set the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).
getFileType()	Get the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).
setFileType(FileType fileType)	Set the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).

LoadOptions()

public LoadOptions()

Initializes a new instance of the [LoadOptions](../../com.groupdocs.watermark.options/loadoptions) class.

LoadOptions(String password)

public LoadOptions(String password)

Initializes a new instance of the [LoadOptions](../../com.groupdocs.watermark.options/loadoptions) class with a specified password.

Parameters:

Parameter	Type	Description
password	java.lang.String	The password for opening an encrypted content.

getPassword()

public final String getPassword()

Gets the password for opening an encrypted document.

Returns: java.lang.String - The password for opening an encrypted document.

setPassword(String value)

public final void setPassword(String value)

Sets the password for opening an encrypted document.

The password be null or empty string. The default value is null. If the content is not encrypted, set this to null or empty string.

The following example demonstrates how to load a document protected with a password.

LoadOptions loadOptions = new LoadOptions(); loadOptions.setPassword(“pwd123”);

Watermarker watermarker = new Watermarker(“D:\doc.vsdx”, loadOptions); // … watermarker.close();

Parameters:

Parameter	Type	Description
value	java.lang.String	The password for opening an encrypted document.

getFormatFamily()

public int getFormatFamily()

Get the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

Returns: int - formatFamily The file type.

setFormatFamily(int formatFamily)

public void setFormatFamily(int formatFamily)

Set the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

Parameters:

Parameter	Type	Description
formatFamily	int	The file type.

getFileType()

public FileType getFileType()

Get the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).

Returns: FileType - fileType The file type.

setFileType(FileType fileType)

public void setFileType(FileType fileType)

Set the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).

Parameters:

Parameter	Type	Description
fileType	FileType	The file type.