com.groupdocs.redaction.options

Class LoadOptions

java.lang.Object

com.groupdocs.redaction.options.LoadOptions

public class LoadOptions
extends Object

Provides options that will be used to open a file.

Learn more

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

The following example demonstrates how to open password-protected document.

LoadOptions loadOptions = new LoadOptions("mysecretpassword");
 try (Redactor redactor = new Redactor("PasswordProtected.pdf", loadOptions))
 {
     // work with document
 }
  

Constructor Summary

Constructors

Constructor and Description
LoadOptions() Initializes a new instance of LoadOptions class.
LoadOptions(boolean preRasterize) Initializes a new instance of LoadOptions class with specified pre-rasterization flag.
LoadOptions(String password) Initializes a new instance of LoadOptions class with specified password.
LoadOptions(String password, boolean preRasterize) Initializes a new instance of LoadOptions class with specified password.
LoadOptions(String password, boolean preRasterize, DocumentFormatConfiguration documentFormatConfiguration) Initializes a new instance of LoadOptions class with specified password.

Method Summary

Modifier and Type	Method and Description
DocumentFormatConfiguration	getDocumentFormatConfiguration() Gets a document format configuration.
String	getPassword() Gets a password for password-protected documents.
boolean	getPreRasterize() Gets a value, indicating if the file is to be pre-rasterized.
void	setDocumentFormatConfiguration(DocumentFormatConfiguration value) Sets a document format configuration.
void	setPassword(String value) Sets a password for password-protected documents.
void	setPreRasterize(boolean value) Sets a value, indicating if the file is to be pre-rasterized.

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 LoadOptions class.

LoadOptions

public LoadOptions(boolean preRasterize)

Initializes a new instance of LoadOptions class with specified pre-rasterization flag.

Parameters:

preRasterize - If true, force rasteization on loading

LoadOptions

public LoadOptions(String password)

Initializes a new instance of LoadOptions class with specified password.

Parameters:

password - Password for protected files

LoadOptions

public LoadOptions(String password,
                   boolean preRasterize)

Initializes a new instance of LoadOptions class with specified password.

Parameters:

password - Password for protected files

preRasterize - If true, force rasteization on loading

LoadOptions

public LoadOptions(String password,
                   boolean preRasterize,
                   DocumentFormatConfiguration documentFormatConfiguration)

Initializes a new instance of LoadOptions class with specified password.

Parameters:

password - Password for protected files

preRasterize - If true, force rasteization on loading

documentFormatConfiguration - document format configuration

Method Detail

getDocumentFormatConfiguration

public final DocumentFormatConfiguration getDocumentFormatConfiguration()

Gets a document format configuration.

Returns:

A document format configuration.

getPassword

public final String getPassword()

Gets a password for password-protected documents.

Returns:

A password for password-protected documents.

getPreRasterize

public final boolean getPreRasterize()

Gets a value, indicating if the file is to be pre-rasterized.

Returns:

A value, indicating if the file is to be pre-rasterized.

setDocumentFormatConfiguration

public final void setDocumentFormatConfiguration(DocumentFormatConfiguration value)

Sets a document format configuration.

Parameters:

value - A document format configuration.

setPassword

public final void setPassword(String value)

Sets a password for password-protected documents.

Parameters:

value - A password for password-protected documents.

setPreRasterize

public final void setPreRasterize(boolean value)

Sets a value, indicating if the file is to be pre-rasterized.

Parameters:

value - A value, indicating if the file is to be pre-rasterized.