ArchiveOptions - GroupDocs.Viewer for Java - API Reference

Packages

Skip navigation links

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

public class ArchiveOptions
extends Object

Provides options for rendering archive files.

Constructor Summary

Constructors
Constructor and Description

ArchiveOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FileName`	`getFileName()` The filename to display in the header.
`String`	`getFolder()` The folder inside the archive to be rendered.
`int`	`getItemsPerPage()` Number of records per page (for rendering to HTML only)
`void`	`setFileName(FileName mFileName)` The filename to display in the header.
`void`	`setFolder(String value)` The folder inside the archive to be rendered.
`void`	`setItemsPerPage(int itemsPerPage)` Number of records per page (for rendering to HTML only)

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

- Constructor Detail
  - ArchiveOptions
```
public ArchiveOptions()
```
- Method Detail
  - getFileName
```
public FileName getFileName()
```
    The filename to display in the header. By default the name of the source file is displayed.
    
    Returns:
    
    The filename
  - getFolder
```
public final String getFolder()
```
    The folder inside the archive to be rendered.
  - getItemsPerPage
```
public int getItemsPerPage()
```
    Number of records per page (for rendering to HTML only)
  - setFileName
```
public void setFileName(FileName mFileName)
```
    The filename to display in the header. By default the name of the source file is displayed.
    
    Parameters:
    
    mFileName - The filename
  - setFolder
```
public final void setFolder(String value)
```
    The folder inside the archive to be rendered.
  - setItemsPerPage
```
public void setItemsPerPage(int itemsPerPage)
```
    Number of records per page (for rendering to HTML only)