com.groupdocs.viewer.options

Class ArchiveOptions

java.lang.Object

com.groupdocs.viewer.options.ArchiveOptions

public class ArchiveOptions
extends Object

Provides options for rendering archive files.

The ArchiveOptions class represents a set of options that can be used to configure the rendering of archive files in the viewer module. It allows you to customize various aspects of the rendering process, such as the count of items on each page and so on.

Example usage:

 // Create an instance of ArchiveOptions
 ArchiveOptions options = new ArchiveOptions();

 // Set the count of items to be shown on each page
 options.setItemsPerPage(16);

 // Create a Viewer instance with the specified options
 try (final Viewer viewer = new Viewer(documentPath, options)) {
     // Use the viewer object for document rendering
 }
 

Note: The ArchiveOptions class provides a range of customization options for rendering archive files. You can configure these options based on your specific requirements to achieve the desired output.

See Also:

Viewer

Constructor Summary

Constructors

Constructor and Description
ArchiveOptions() Creates a new instance of the ArchiveOptions class with default settings.

Method Summary

Modifier and Type	Method and Description
FileName	getFileName() Gets the filename to be displayed in the header.
String	getFolder() Gets the folder inside the archive that will be used for rendering.
int	getItemsPerPage() Gets the number of records per page for rendering to HTML.
void	setFileName(FileName fileName) Sets the filename to be displayed in the header.
void	setFolder(String value) Sets the folder inside the archive that will be used for rendering.
void	setItemsPerPage(int itemsPerPage) Sets the number of records per page for rendering to HTML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchiveOptions

public ArchiveOptions()

Creates a new instance of the ArchiveOptions class with default settings.

Method Detail

getFileName

public FileName getFileName()

Gets the filename to be displayed in the header.

By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property. For more information and code example, see the documentation.

Returns:

the filename to be displayed.

getFolder

public final String getFolder()

Gets the folder inside the archive that will be used for rendering.

By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property. For code example, see the documentation.

Returns:

the folder to be rendered.

getItemsPerPage

public int getItemsPerPage()

Gets the number of records per page for rendering to HTML.

Use this property to set the number of archive items to display on each HTML page. The default value is 16. This option is available for rendering to HTML format. For more information and code example, see the documentation.

Returns:

the number of records per page.

setFileName

public void setFileName(FileName fileName)

Sets the filename to be displayed in the header.

By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property. For more information and code example, see the documentation.

Parameters:

fileName - The filename to be displayed.

setFolder

public final void setFolder(String value)

Sets the folder inside the archive that will be used for rendering.

By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property. For code example, see the documentation.

Parameters:

value - The folder to be rendered.

setItemsPerPage

public void setItemsPerPage(int itemsPerPage)

Sets the number of records per page for rendering to HTML.

Use this property to set the number of archive items to display on each HTML page. The default value is 16. This option is available for rendering to HTML format. For more information and code example, see the documentation.

Parameters:

itemsPerPage - The number of records per page.