LoadOptions Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.merger.domain.options.interfaces.ILoadOptions
public class LoadOptions implements ILoadOptions
Provides options for the document loading.
| Constructor | Description |
|---|---|
| LoadOptions(FileType fileType) | Initializes new instance of LoadOptions class. |
| LoadOptions(String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType fileType, String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(String extension, FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType, String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType) | Initializes new instance of LoadOptions class. |
| Method | Description |
|---|---|
| getType() | The type of the file to load. |
| getExtension() | The extension of the file to init. |
| getPassword() | The password for opening password-protected file. |
| getEncoding() | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
public LoadOptions(FileType fileType)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileType | FileType | The type of the file to load. |
public LoadOptions(String password)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| password | java.lang.String | The password for opening password-protected file. |
public LoadOptions(String password, Charset encoding)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
public LoadOptions(FileType fileType, String password)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
public LoadOptions(FileType fileType, String password, Charset encoding)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
public LoadOptions(String extension, FileType fileType, String password, Charset encoding)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extension | java.lang.String | The extension of the file to load. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
public LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
public LoadOptions(FileType iniFileType, FileType fileType, String password)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
public LoadOptions(FileType iniFileType, FileType fileType)
Initializes new instance of LoadOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
public final FileType getType()
The type of the file to load.
Returns: FileType
public final String getExtension()
The extension of the file to init.
Returns: java.lang.String
public final String getPassword()
The password for opening password-protected file.
Returns: java.lang.String
public final Charset getEncoding()
The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. Default value is System.Text.Encoding.Default (java.nio.charset.Charset).
Returns: java.nio.charset.Charset
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
