com.groupdocs.watermark.options

Class LoadOptions

java.lang.Object

com.groupdocs.watermark.options.LoadOptions

Direct Known Subclasses:

DiagramLoadOptions, EmailLoadOptions, ImageLoadOptions, OoxmlLoadOptions, PdfLoadOptions, PresentationLoadOptions, SpreadsheetLoadOptions, WordProcessingLoadOptions

public class LoadOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
LoadOptions() Initializes a new instance of the LoadOptions class.
LoadOptions(String password) Initializes a new instance of the LoadOptions class with a specified password.

Method Summary

Modifier and Type	Method and Description
FileType	getFileType() Get the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).
int	getFormatFamily() Get the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).
String	getPassword() Gets the password for opening an encrypted document.
void	setFileType(FileType fileType) Set the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).
void	setFormatFamily(int formatFamily) Set the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).
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(String password)

Initializes a new instance of the LoadOptions class with a specified password.

Parameters:

password - The password for opening an encrypted content.

Method Detail

getFileType

public FileType getFileType()

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

Returns:

fileType The file type.

getFormatFamily

public int getFormatFamily()

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

Returns:

formatFamily The file type.

getPassword

public final String getPassword()

Gets the password for opening an encrypted document.

Returns:

The password for opening an encrypted document.

setFileType

public void setFileType(FileType fileType)

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

Parameters:

fileType - The file type.

setFormatFamily

public void setFormatFamily(int formatFamily)

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

Parameters:

formatFamily - The file type.

setPassword

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:

value - The password for opening an encrypted document.