LoadOptions (groupdocs-viewer (25.12) API Reference)

java.lang.Object
- com.groupdocs.viewer.options.LoadOptions

public class LoadOptions
extends Object

Provides options that are used to open a file.

The LoadOptions class encapsulates various settings and parameters that can be used to specify how a file should be opened and loaded in the GroupDocs.Viewer component. For details, see this page and its children.

Example usage:


 LoadOptions options = new LoadOptions();
 options.setPassword("myPassword");
 options.setFileType(PDF);
 options.setCharset(Charset.forName("UTF-8"));

 try (Viewer viewer = new Viewer(pdfFileInputStream, options)) {
     // Use the viewer object for further operations
 }

See Also:: Viewer

Field Summary

Fields
Modifier and Type Field and Description

boolean _tryRepair

static int DEFAULT_URL_CONNECT_TIMEOUT

static int DEFAULT_URL_READ_TIMEOUT

Fields
Modifier and Type	Field and Description
`boolean`	`_tryRepair`
`static int`	`DEFAULT_URL_CONNECT_TIMEOUT`
`static int`	`DEFAULT_URL_READ_TIMEOUT`

Constructor Summary

Constructors
Constructor and Description
`LoadOptions()` Initializes a new instance of the `LoadOptions` class.
`LoadOptions(FileType fileType)` Initializes a new instance of the `LoadOptions` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.groupdocs.viewer.options.ArchiveSecurityOptions`	`getArchiveSecurityOptions()` Gets the security options to control the process of extracting archives.
`Charset`	`getCharset()` The charset used when opening text-based files or email messages such as `FileType.CSV`, `FileType.TXT`, and `FileType.MSG`.
`FileType`	`getFileType()` Gets the type of the file to open.
`String`	`getPassword()` Gets the password for opening an encrypted file.
`int`	`getResourceLoadingTimeout()` Gets the timeout for loading external resources.
`int`	`getUrlConnectTimeout()` Gets the connection timeout for creating a `Viewer` using `URL` to load a document.
`int`	`getUrlReadTimeout()` Gets the read timeout for creating a `Viewer` using `URL` to load a document.
`List<String>`	`getWhitelistedResources()` The list of URL fragments corresponding to external resources that should be loaded when `isSkipExternalResources()` is set to `true`.
`boolean`	`isDetectCharset()` This option enables `FileType.TXT`, `FileType.TSV`, and `FileType.CSV` files charset detection.
`boolean`	`isSkipExternalResources()` When set to true, all external resources such as images will not be loaded except `getWhitelistedResources()`.
`boolean`	`isTryRepair()` When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents.
`void`	`setArchiveSecurityOptions(com.groupdocs.viewer.options.ArchiveSecurityOptions archiveSecurityOptions)` Sets the security options to control the process of extracting archives.
`void`	`setCharset(Charset value)` The charset used when opening text-based files or email messages such as `FileType.CSV`, `FileType.TXT`, and `FileType.MSG`.
`void`	`setDetectCharset(boolean detectCharset)` This option enables `FileType.TXT`, `FileType.TSV`, and `FileType.CSV` files charset detection.
`void`	`setFileType(FileType value)` Sets the type of the file to open.
`void`	`setPassword(String value)` Sets the password for opening an encrypted file.
`void`	`setResourceLoadingTimeout(int resourceLoadingTimeout)` Sets the timeout for loading external resources, such as graphics.
`void`	`setSkipExternalResources(boolean skipExternalResources)` When set to true, all external resources such as images will not be loaded except `getWhitelistedResources()`.
`void`	`setTryRepair(boolean tryRepair)` When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents.
`void`	`setUrlConnectTimeout(int urlConnectTimeout)` Sets the connection timeout for creating a `Viewer` using `URL` to load a document.
`void`	`setUrlReadTimeout(int urlReadTimeout)` Sets the read timeout for creating a `Viewer` using `URL` to load a document.
`void`	`setWhitelistedResources(List<String> whitelistedResources)` Sets the list of URL fragments corresponding to external resources that should be loaded when `isSkipExternalResources()` is set to `true`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _tryRepair
```
public boolean _tryRepair
```
  - DEFAULT_URL_CONNECT_TIMEOUT
```
public static final int DEFAULT_URL_CONNECT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_URL_READ_TIMEOUT
```
public static final int DEFAULT_URL_READ_TIMEOUT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LoadOptions
```
public LoadOptions()
```
    Initializes a new instance of the LoadOptions class.
    
    For code example, see the documentation.
  - LoadOptions
```
public LoadOptions(FileType fileType)
```
    Initializes a new instance of the LoadOptions class.
    
    For code example, see the documentation.
    
    Parameters:
    
    fileType - The type of the file to open.
    
    Throws:
    
    IllegalArgumentException - If the fileType parameter is null.
- Method Detail
  - getArchiveSecurityOptions
```
public com.groupdocs.viewer.options.ArchiveSecurityOptions getArchiveSecurityOptions()
```
    Gets the security options to control the process of extracting archives.
    
    Note: Not each archive type supports all options.
    
    Returns:
    
    the options object to configure the process of extracting archives.
  - getCharset
```
public final Charset getCharset()
```
    The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.
    Default value is StandardCharsets.UTF_8. For code example, see the documentation.
    Learn more
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset

 try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
  - getFileType
```
public final FileType getFileType()
```
    Gets the type of the file to open.
    
    For code example, see the documentation.
    
    Returns:
    
    the file type.
    
    See Also:
    
    FileType
  - getPassword
```
public final String getPassword()
```
    Gets the password for opening an encrypted file.
    
    For code example, see the documentation.
    
    Returns:
    
    the password for opening the file.
  - getResourceLoadingTimeout
```
public int getResourceLoadingTimeout()
```
    Gets the timeout for loading external resources.
    
    Note: The default value is 10 seconds.
    
    This option applies to the following file formats:
    Learn more about options to manage external resources:
    - Set timeout for loading external resources
    The default value is 30 seconds. For code example, see the documentation.
    
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setResourceLoadingTimeout(5000); // Set resource loading timeout to 5 seconds

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
  - getUrlConnectTimeout
```
public int getUrlConnectTimeout()
```
    Gets the connection timeout for creating a Viewer using URL to load a document.
    
    Note: The default value is 5 seconds.
    
    Returns:
    
    the connection timeout.
  - getUrlReadTimeout
```
public int getUrlReadTimeout()
```
    Gets the read timeout for creating a Viewer using URL to load a document.
    
    Note: The default value is 30 seconds.
    
    Returns:
    
    the read timeout.
  - getWhitelistedResources
```
public List<String> getWhitelistedResources()
```
    The list of URL fragments corresponding to external resources that should be loaded when isSkipExternalResources() is set to true.
    This option applies to the following file formats:
    Learn more about options to manage external resources:
    - Set timeout for loading external resources
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources
 loadOptions.getWhitelistedResources().add("avatars.githubusercontent.com"); // Enable loading of external resources that have 'avatars.githubusercontent.com' fragment in resource URL.
 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
  - isDetectCharset
```
public boolean isDetectCharset()
```
    This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. In case the charset can't be detected the default getCharset() is used.
    Learn more about rendering text and tab/comma delimited files
    - Render text documents as HTML, PDF, and image files
    - Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files
    If the encoding cannot be detected, the default is used. For code example, see the documentation.
    
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDetectCharset(true); // Enable encoding detection

 try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
  - isSkipExternalResources
```
public boolean isSkipExternalResources()
```
    When set to true, all external resources such as images will not be loaded except getWhitelistedResources().
    This option applies to the following file formats:
    Learn more about options to manage external resources:
    - Set timeout for loading external resources
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
  - isTryRepair
```
public boolean isTryRepair()
```
    When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is `false`.
    This feature addresses the following issues in a PDF document:
    - Broken references within the document (incorrect object offsets in the Cross-reference list).
    - Missing critical elements like root object, page object, or page content.
    - Circular references (Form X-object referencing itself).
  - setArchiveSecurityOptions
```
public void setArchiveSecurityOptions(com.groupdocs.viewer.options.ArchiveSecurityOptions archiveSecurityOptions)
```
    Sets the security options to control the process of extracting archives.
    
    Note: Not each archive type supports all options.
    
    Parameters:
    
    archiveSecurityOptions - The options object to configure the process of extracting archives.
  - setCharset
```
public final void setCharset(Charset value)
```
    The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.
    Default value is StandardCharsets.UTF_8. For code example, see the documentation.
    Learn more
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset

 try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
  - setDetectCharset
```
public void setDetectCharset(boolean detectCharset)
```
    This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. In case the charset can't be detected the default getCharset() is used.
    Learn more about rendering text and tab/comma delimited files
    - Render text documents as HTML, PDF, and image files
    - Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files
    If the encoding cannot be detected, the default is used. For code example, see the documentation.
    
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDetectCharset(true); // Enable encoding detection

 try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
  - setFileType
```
public final void setFileType(FileType value)
```
    Sets the type of the file to open.
    
    For code example, see the documentation.
    
    Parameters:
    
    value - The file type.
    
    See Also:
    
    FileType
  - setPassword
```
public final void setPassword(String value)
```
    Sets the password for opening an encrypted file.
    
    For code example, see the documentation.
    
    Parameters:
    
    value - The password for opening the file.
  - setResourceLoadingTimeout
```
public void setResourceLoadingTimeout(int resourceLoadingTimeout)
```
    Sets the timeout for loading external resources, such as graphics.
    
    Note: The default value is 30 seconds.
    
    This option is supported for Word Processing documents that contain external resources. The default value is 30 seconds. For code example, see the documentation.
    
    Parameters:
    
    resourceLoadingTimeout - The loading timeout, milliseconds.
  - setSkipExternalResources
```
public void setSkipExternalResources(boolean skipExternalResources)
```
    When set to true, all external resources such as images will not be loaded except getWhitelistedResources().
    
    This option applies to the following file formats:
    Learn more about options to manage external resources:
    - Set timeout for loading external resources
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
    Parameters:
    
    skipExternalResources - The flag to enable or disable loading of external resources.
  - setTryRepair
```
public void setTryRepair(boolean tryRepair)
```
    When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is `false`.
    This feature addresses the following issues in a PDF document:
    - Broken references within the document (incorrect object offsets in the Cross-reference list).
    - Missing critical elements like root object, page object, or page content.
    - Circular references (Form X-object referencing itself).
  - setUrlConnectTimeout
```
public void setUrlConnectTimeout(int urlConnectTimeout)
```
    Sets the connection timeout for creating a Viewer using URL to load a document.
    
    Note: The default value is 5 seconds.
    
    Parameters:
    
    urlConnectTimeout - The connection timeout.
  - setUrlReadTimeout
```
public void setUrlReadTimeout(int urlReadTimeout)
```
    Sets the read timeout for creating a Viewer using URL to load a document.
    
    Note: The default value is 30 seconds.
    
    Parameters:
    
    urlReadTimeout - The read timeout.
  - setWhitelistedResources
```
public void setWhitelistedResources(List<String> whitelistedResources)
```
    Sets the list of URL fragments corresponding to external resources that should be loaded when isSkipExternalResources() is set to true.
    
    This option applies to the following file formats:
    Learn more about options to manage external resources:
    - Set timeout for loading external resources
    Example:
```
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources
 loadOptions.setWhitelistedResources(Arrays.asList("avatars.githubusercontent.com")); // Enable loading of external resources that have 'avatars.githubusercontent.com' fragment in resource URL.
 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
 
```
    Parameters:
    
    whitelistedResources - The list of URL fragments corresponding to external resources that should be loaded.

Class LoadOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_tryRepair

DEFAULT_URL_CONNECT_TIMEOUT

DEFAULT_URL_READ_TIMEOUT

Constructor Detail

LoadOptions

LoadOptions

Method Detail

getArchiveSecurityOptions

getCharset

getFileType

getPassword

getResourceLoadingTimeout

getUrlConnectTimeout

getUrlReadTimeout

getWhitelistedResources

isDetectCharset

isSkipExternalResources

isTryRepair

setArchiveSecurityOptions

setCharset

setDetectCharset

setFileType

setPassword

setResourceLoadingTimeout

setSkipExternalResources

setTryRepair

setUrlConnectTimeout

setUrlReadTimeout

setWhitelistedResources