Skip navigation links
A B C D E F G H I J L M N O P R S T V W 

A

ALLOW_ALL - Static variable in class com.groupdocs.viewer.options.Permissions
Allow printing, modification and data extraction.
ArchiveOptions - Class in com.groupdocs.viewer.options
Provides options for rendering archive files.
ArchiveOptions() - Constructor for class com.groupdocs.viewer.options.ArchiveOptions
 
ArchiveViewInfo - Interface in com.groupdocs.viewer.results
Represents view information for archive file.
Attachment - Interface in com.groupdocs.viewer.results
Represents attachment file contained by email message, archive, PDF document or Outlook data file.

B

BaseViewOptions - Class in com.groupdocs.viewer.options
Provides base rendering options.
BaseViewOptions() - Constructor for class com.groupdocs.viewer.options.BaseViewOptions
 

C

Cache - Interface in com.groupdocs.viewer.caching
Defines methods required for storing rendered document and document resources сache.
CacheableFactory - Class in com.groupdocs.viewer.caching.extra
This class helps customising Cache.
CacheableFactory() - Constructor for class com.groupdocs.viewer.caching.extra.CacheableFactory
 
CacheKeys - Class in com.groupdocs.viewer.caching
Provides methods to retrieve unique identifier for the cache entry.
CacheKeys() - Constructor for class com.groupdocs.viewer.caching.CacheKeys
 
CadOptions - Class in com.groupdocs.viewer.options
Provides options for rendering CAD drawings.
CadViewInfo - Interface in com.groupdocs.viewer.results
Represents view information for CAD drawing.
Character - Interface in com.groupdocs.viewer.results
Represents relatively positioned rectangle which contains single character.
clear() - Static method in class com.groupdocs.viewer.utils.MemoryCleaner
Clears Heap memory from static PDF instances (static and threadLocal) and deletes all temp files.
clearAllTempFiles() - Static method in class com.groupdocs.viewer.utils.MemoryCleaner
Clears temp files, created by PDF in system temp directory.
clearCurrentThreadLocals() - Static method in class com.groupdocs.viewer.utils.MemoryCleaner
Safely clears Heap memory from ThreadLocal instances for current thread
clearFontRegistry() - Static method in class com.groupdocs.viewer.utils.MemoryCleaner
Clears FontRegistry information from the Heap memory.
clearKeepingFontSettings() - Static method in class com.groupdocs.viewer.utils.MemoryCleaner
Clears Heap memory from static PDF instances (static and threadLocal) and deletes all temp files.
clearStaticInstances() - Static method in class com.groupdocs.viewer.utils.MemoryCleaner
Clears Heap memory from static PDF instances.
close() - Method in interface com.groupdocs.viewer.interfaces.FileReader
Disposes the object and releases any system resources associated with it.
close() - Method in class com.groupdocs.viewer.Viewer
Releases file stream and managed internal resources.
closeFileStream(OutputStream) - Method in interface com.groupdocs.viewer.interfaces.FileStreamFactory
Releases the stream created by FileStreamFactory.createFileStream() method.
closePageStream(int, OutputStream) - Method in interface com.groupdocs.viewer.interfaces.PageStreamFactory
Releases the stream created by PageStreamFactory.createPageStream(int) method.
closeResourceStream(int, Resource, OutputStream) - Method in interface com.groupdocs.viewer.interfaces.ResourceStreamFactory
Releases the stream created by ResourceStreamFactory.createResourceStream(int, Resource) method.
com.groupdocs.viewer - package com.groupdocs.viewer
The package provides classes for rendering documents in HTML5, Image or PDF modes fast and with high quality.
com.groupdocs.viewer.caching - package com.groupdocs.viewer.caching
The package provides classes for customizing caching behaviour.
com.groupdocs.viewer.caching.extra - package com.groupdocs.viewer.caching.extra
The package provides functionality for using custom models in cache implementation.
com.groupdocs.viewer.exception - package com.groupdocs.viewer.exception
The package provides classes for exceptions which can occur while working with a document.
com.groupdocs.viewer.fonts - package com.groupdocs.viewer.fonts
The package provides classes classes and enumerations to manage fonts used during rendering process.
com.groupdocs.viewer.interfaces - package com.groupdocs.viewer.interfaces
The package provides interfaces to instantiate and release output document and it's resources.
com.groupdocs.viewer.logging - package com.groupdocs.viewer.logging
The package provides classes for configuring logging system.
com.groupdocs.viewer.options - package com.groupdocs.viewer.options
The package provides classes to specify additional options when rendering documents.
com.groupdocs.viewer.results - package com.groupdocs.viewer.results
The package provides classes which represent document rendering results.
com.groupdocs.viewer.utils - package com.groupdocs.viewer.utils
The package provides helpers and utils classes.
combine(String...) - Static method in class com.groupdocs.viewer.utils.PathUtils
Combine paths parts using separator.
CreateFileStream - Interface in com.groupdocs.viewer.interfaces
Represents interface that instantiates stream used to write output file data.
createFileStream() - Method in interface com.groupdocs.viewer.interfaces.FileStreamFactory
The method that returns readable stream.
CreatePageStream - Interface in com.groupdocs.viewer.interfaces
Represents interface that instantiates stream used to write output page data.
createPageStream(int) - Method in interface com.groupdocs.viewer.interfaces.PageStreamFactory
Creates the stream used to write output page data.
CreateResourceStream - Interface in com.groupdocs.viewer.interfaces
Represents interface that instantiates stream used to write output HTML resource data.
createResourceStream(int, Resource) - Method in interface com.groupdocs.viewer.interfaces.ResourceStreamFactory
Creates the stream used to write output HTML resource data.
CreateResourceUrl - Interface in com.groupdocs.viewer.interfaces
Represents interface that creates URL for HTML resource.
createResourceUrl(int, Resource) - Method in interface com.groupdocs.viewer.interfaces.ResourceStreamFactory
Creates the URL for HTML resource.

D

debug(String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes a debug message to the console.
debug(Throwable, String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes a debug message to the console.
debug(String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Debug message
debug(Throwable, String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Debug message
DENY_ALL - Static variable in class com.groupdocs.viewer.options.Permissions
Deny printing, modification and data extraction.
DENY_DATA_EXTRACTION - Static variable in class com.groupdocs.viewer.options.Permissions
Deny text and graphics extraction.
DENY_MODIFICATION - Static variable in class com.groupdocs.viewer.options.Permissions
Deny to modify content, fill in forms, add or modify annotations.
DENY_PRINTING - Static variable in class com.groupdocs.viewer.options.Permissions
Deny printing

E

EmailOptions - Class in com.groupdocs.viewer.options
Provides options for rendering email messages.
EmailOptions() - Constructor for class com.groupdocs.viewer.options.EmailOptions
Initializes new instance of EmailOptions class.
EMPTY - Static variable in class com.groupdocs.viewer.options.FileName
The empty filename.
equals(FolderFontSource) - Method in class com.groupdocs.viewer.fonts.FolderFontSource
Determines whether the current FolderFontSource is the same as specified FolderFontSource object.
equals(Object) - Method in class com.groupdocs.viewer.fonts.FolderFontSource
Determines whether the current FolderFontSource is the same as specified object.
equals(Object) - Method in class com.groupdocs.viewer.options.CadOptions
 
equals(Object) - Method in class com.groupdocs.viewer.options.EmailOptions
 
equals(Object) - Method in interface com.groupdocs.viewer.results.Layer
Checks equality
equals(Object) - Method in interface com.groupdocs.viewer.results.Layout
Checks equality
error(String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes an error message to the console.
error(Throwable, String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes an error message to the console.
error(String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Error message
error(Throwable, String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Error message

F

Field - Enum in com.groupdocs.viewer.options
Represents email message fields e.g. From, To, Subject etc.
FileCache - Class in com.groupdocs.viewer.caching
Represents a local on-disk cache.
FileCache(String) - Constructor for class com.groupdocs.viewer.caching.FileCache
Creates new instance of FileCache class.
FileCache(String, String) - Constructor for class com.groupdocs.viewer.caching.FileCache
Creates new instance of FileCache class.
FileInfo - Interface in com.groupdocs.viewer.results
Contains information about file.
FileLogger - Class in com.groupdocs.viewer.logging
Writes log messages to the file.
FileLogger(String) - Constructor for class com.groupdocs.viewer.logging.FileLogger
Create logger to file.
FileLogger(String, boolean, boolean, boolean, boolean) - Constructor for class com.groupdocs.viewer.logging.FileLogger
Create logger to file.
FileName - Class in com.groupdocs.viewer.options
Represents name of simple file
FileName(String) - Constructor for class com.groupdocs.viewer.options.FileName
Initializes new instance of FileName class.
FileNotFoundException - Exception in com.groupdocs.viewer.exception
Represents the the exception that throws when file or directory was not found.
FileNotFoundException(String) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
Initializes a new instance of the FileNotFoundException class with a specified error message.
FileNotFoundException(Path) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
Initializes a new instance of the FileNotFoundException class with a specified error message.
FileNotFoundException(String, Object...) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
Initializes a new instance of the FileNotFoundException class with a specified error message.
FileNotFoundException(Throwable) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
Instantiates a new instance of the FileNotFoundException class.
FileNotFoundException(String, Throwable) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
Initializes a new instance of the FileNotFoundException class with a specified error message.
FileReader - Interface in com.groupdocs.viewer.interfaces
Declares method for reading file stream.
FileStreamFactory - Interface in com.groupdocs.viewer.interfaces
Defines methods which are required for instantiating and releasing output file stream.
FileType - Enum in com.groupdocs.viewer
Represents file type.
FolderFontSource - Class in com.groupdocs.viewer.fonts
Represents the folder that contains TrueType fonts.
FolderFontSource(String, SearchOption) - Constructor for class com.groupdocs.viewer.fonts.FolderFontSource
Initializes new instance of FolderFontSource class.
FontSettings - Class in com.groupdocs.viewer.fonts
Provides methods for working with sources to look for TrueType fonts.
FontSettings() - Constructor for class com.groupdocs.viewer.fonts.FontSettings
 
FontSource - Interface in com.groupdocs.viewer.fonts
Marker interface for the font sources.
forEmbeddedResources(CreatePageStream) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class for rendering into HTML with embedded resources.
forEmbeddedResources(CreatePageStream, ReleasePageStream) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class for rendering into HTML with embedded resources.
forEmbeddedResources(PageStreamFactory) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class for rendering into HTML with embedded resources.
forEmbeddedResources() - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class.
forEmbeddedResources(String) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class.
forExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class for rendering into HTML with external resources.
forExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl, ReleasePageStream, ReleaseResourceStream) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class for rendering into HTML with external resources.
forExternalResources(PageStreamFactory, ResourceStreamFactory) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class for rendering into HTML with external resources.
forExternalResources() - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class.
forExternalResources(String, String, String) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
Initializes new instance of HtmlViewOptions class.
forHtmlView() - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class to retrieve information about view when rendering into HTML.
forHtmlView(boolean) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class to retrieve information about view when rendering into HTML.
forJpgView() - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class to retrieve information about view when rendering into JPG.
forJpgView(boolean) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class to retrieve information about view when rendering into JPG.
forOnePagePerSheet() - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
Initializes new instance of SpreadsheetOptions class for rendering whole sheet into page.
forPngView() - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class to retrieve information about view when rendering into PNG.
forPngView(boolean) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class to retrieve information about view when rendering into PNG.
forRenderingByHeight(int) - Static method in class com.groupdocs.viewer.options.CadOptions
Initializes new instance of CadOptions class for rendering by height.
forRenderingByPageBreaks() - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
Initializes new instance of for rendering print areas only.
forRenderingByScaleFactor(float) - Static method in class com.groupdocs.viewer.options.CadOptions
Initializes new instance of CadOptions class for rendering by scale factor.
forRenderingByWidth(int) - Static method in class com.groupdocs.viewer.options.CadOptions
Initializes new instance of CadOptions class for rendering by width.
forRenderingByWidthAndHeight(int, int) - Static method in class com.groupdocs.viewer.options.CadOptions
Initializes new instance of CadOptions class for rendering by width and height.
forRenderingPrintArea() - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
Initializes new instance of SpreadsheetOptions for rendering print areas only.
forSplitSheetIntoPages(int) - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
Initializes new instance of SpreadsheetOptions for rendering sheet into pages.
forSplitSheetIntoPages(int, int) - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
Initializes new instance of for rendering sheet into pages.
fromExtension(String) - Static method in enum com.groupdocs.viewer.FileType
Maps file extension to file type.
fromFilePath(String) - Static method in enum com.groupdocs.viewer.FileType
Extracts file extension and maps it to file type.
fromHtmlViewOptions(HtmlViewOptions) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class based on HtmlViewOptions object.
fromJpgViewOptions(JpgViewOptions) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class based on JpgViewOptions object.
fromMediaType(String) - Static method in enum com.groupdocs.viewer.FileType
Maps file media type to file type e.g. 'application/pdf' will be mapped to FileType.PDF.
fromPngViewOptions(PngViewOptions) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
Initializes new instance of ViewInfoOptions class based on PngViewOptions object.
fromStream(InputStream) - Static method in enum com.groupdocs.viewer.FileType
Detects file type by reading the file signature.
fromStream(InputStream, String) - Static method in enum com.groupdocs.viewer.FileType
Detects file type by reading the file signature.
fromStream(InputStream, ILogger) - Static method in enum com.groupdocs.viewer.FileType
Detects file type by reading the file signature.
fromStream(InputStream, String, ILogger) - Static method in enum com.groupdocs.viewer.FileType
Detects file type by reading the file signature.
FULL_SIZE - Static variable in class com.groupdocs.viewer.options.Size
The maximum size of watermark text that fits page.

G

get(String) - Method in interface com.groupdocs.viewer.caching.Cache
Gets the entry associated with this key if present and null otherwise.
get(String) - Method in class com.groupdocs.viewer.caching.FileCache
Deserializes data associated with this key if present.
getAddressFilter() - Method in class com.groupdocs.viewer.options.MailStorageOptions
The email-address used to filter messages by sender or recipient.
getAddressFilter() - Method in class com.groupdocs.viewer.options.OutlookOptions
The email-address used to filter messages by sender or recipient.
getArchiveOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The archive files view options.
getAttachmentKey(String) - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns unique identifier for the cache entry that represents attachment file.
getAttachments() - Method in class com.groupdocs.viewer.Viewer
Returns attachments contained by the document.
getAttachmentsKey() - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns unique identifier for the cache entry that represents collection of Attachment objects.
getBackgroundColor() - Method in class com.groupdocs.viewer.options.CadOptions
Gets image background color
getBottomMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Bottom page margin (for HTML rendering only)
getCache() - Method in class com.groupdocs.viewer.ViewerSettings
The cache implementation used for storing rendering results.
getCachePath() - Method in class com.groupdocs.viewer.caching.FileCache
The Relative or absolute path to the cache folder.
getCacheSubFolder() - Method in class com.groupdocs.viewer.caching.FileCache
The sub-folder to append to the FileCache.getCachePath().
getCadOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The CAD drawing view options.
getCharacters() - Method in interface com.groupdocs.viewer.results.Word
The characters contained by the word.
getCharset() - Method in class com.groupdocs.viewer.options.LoadOptions
The Charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.
getColor() - Method in class com.groupdocs.viewer.options.Watermark
The watermark color.
getConsumptionCredit() - Static method in class com.groupdocs.viewer.Metered
Retrieves count of credits consumed.
getConsumptionQuantity() - Static method in class com.groupdocs.viewer.Metered
Retrieves amount of MBs processed.
getCountColumnsPerPage() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
The columns count to include into each page when splitting worksheet into pages.
getCountRowsPerPage() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
The rows count to include into each page when splitting worksheet into pages.
getDateTimeFormat() - Method in class com.groupdocs.viewer.options.EmailOptions
Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used
getDefaultFontName() - Method in class com.groupdocs.viewer.options.BaseViewOptions
Default font to be used when particular font used in document can't be found.
getDocumentOpenPassword() - Method in class com.groupdocs.viewer.options.Security
The password required to open the PDF document.
getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Callback to estimate Words or Email document saving progress
getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.JpgViewOptions
Callback to estimate Words or Email document saving progress
getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.PdfViewOptions
Callback to estimate Words or Email document saving progress
getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.PngViewOptions
Callback to estimate Words or Email document saving progress
getEmailOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The email messages view options.
getEndDate() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The end date of the Gantt Chart View to be included into the output.
getEndDate() - Method in interface com.groupdocs.viewer.results.ProjectManagementViewInfo
The date time when the project is to be completed.
getEndPointX() - Method in class com.groupdocs.viewer.options.Tile
Returns the X coordinate of the highest right point on the drawing where the tile ends.
getEndPointY() - Method in class com.groupdocs.viewer.options.Tile
Returns the Y coordinate of the highest right point on the drawing where the tile ends.
getExtension() - Method in enum com.groupdocs.viewer.FileType
Filename suffix (including the period ".") e.g. ".doc".
getFieldTextMap() - Method in class com.groupdocs.viewer.options.EmailOptions
The mapping between email message Field and field text representation.
getFigureWidth() - Method in class com.groupdocs.viewer.options.VisioRenderingOptions
Figure width, height will be calculated automatically
getFileFormat() - Method in enum com.groupdocs.viewer.FileType
File type name e.g. "Microsoft Word Document".
getFileInfo() - Method in class com.groupdocs.viewer.Viewer
Returns information about file such as file-type and flag that indicates if file is encrypted.
getFileInfoKey() - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns unique identifier for the cache entry that represents ViewInfo object.
getFileKey(String) - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns unique identifier for the cache entry that represents file.
getFileName() - Method in class com.groupdocs.viewer.options.ArchiveOptions
The filename to display in the header.
getFileName() - Method in interface com.groupdocs.viewer.results.Attachment
Attachment file name.
getFileName() - Method in class com.groupdocs.viewer.results.Resource
The resource file name.
getFileName(String) - Static method in class com.groupdocs.viewer.utils.PathUtils
Gets file name.
getFilePath() - Method in interface com.groupdocs.viewer.results.Attachment
Attachment relative path e.g. "folder/file.docx"" or filename when the file is located in the root of an archive, in e-mail message or data file.
getFileType() - Method in class com.groupdocs.viewer.options.LoadOptions
The type of the file to open.
getFileType() - Method in interface com.groupdocs.viewer.results.Attachment
Attachment file type.
getFileType() - Method in interface com.groupdocs.viewer.results.FileInfo
The type of the file.
getFileType() - Method in interface com.groupdocs.viewer.results.ViewInfo
The type of the file.
getFolder() - Method in class com.groupdocs.viewer.options.ArchiveOptions
The folder inside the archive to be rendered.
getFolder() - Method in class com.groupdocs.viewer.options.OutlookOptions
The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render.
getFolderPath() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
Path to the folder that contains TrueType fonts.
getFolders() - Method in interface com.groupdocs.viewer.results.ArchiveViewInfo
The folders contained by the archive file.
getFolders() - Method in interface com.groupdocs.viewer.results.OutlookViewInfo
The list of folders contained by the Outlook Data file.
getFontName() - Method in class com.groupdocs.viewer.options.Watermark
The font name used for the watermark.
getFontsToExclude() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
The list of font names, to exclude from HTML document.
getHeight() - Method in class com.groupdocs.viewer.options.CadOptions
The height of the output result in pixels.
getHeight() - Method in class com.groupdocs.viewer.options.JpgViewOptions
The height of an output image in pixels.
getHeight() - Method in class com.groupdocs.viewer.options.PngViewOptions
The height of an output image in pixels.
getHeight() - Method in class com.groupdocs.viewer.options.Tile
The height of the tile in pixels.
getHeight() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Image height (for rendering to PNG/JPG only)
getHeight() - Method in interface com.groupdocs.viewer.results.Layout
The height of the layout.
getHeight() - Method in interface com.groupdocs.viewer.results.Page
The height of the page in pixels when viewing as JPG or PNG.
getHeight() - Method in interface com.groupdocs.viewer.results.TextElement
The height of the rectangle which contains the element (in pixels).
getId() - Method in interface com.groupdocs.viewer.results.Attachment
Unique identifier of the attachment in context of a single file that contains this attachment.
getImageHeight() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
The height of an output image in pixels.
getImageHeight() - Method in class com.groupdocs.viewer.options.PdfViewOptions
The height of an output image in pixels.
getImageMaxHeight() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Max height of an output image in pixels.
getImageMaxHeight() - Method in class com.groupdocs.viewer.options.PdfViewOptions
Max height of an output image in pixels.
getImageMaxWidth() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Max width of an output image in pixels.
getImageMaxWidth() - Method in class com.groupdocs.viewer.options.PdfViewOptions
Max width of an output image in pixels.
getImageQuality() - Method in class com.groupdocs.viewer.options.PdfOptions
Specifies output image quality for image resources when rendering into HTML.
getImageWidth() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
The width of the output image in pixels.
getImageWidth() - Method in class com.groupdocs.viewer.options.PdfViewOptions
The width of the output image in pixels.
getInstance() - Static method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Gets instance of CacheableFactory
getItemsPerPage() - Method in class com.groupdocs.viewer.options.ArchiveOptions
Number of records per page (for rendering to HTML only)
getJpgQuality() - Method in class com.groupdocs.viewer.options.PdfViewOptions
The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90.
getKeys(String) - Method in interface com.groupdocs.viewer.caching.Cache
Returns all keys matching filter.
getKeys(String) - Method in class com.groupdocs.viewer.caching.FileCache
Returns all file names that contains filter in filename.
getLayers() - Method in class com.groupdocs.viewer.options.CadOptions
The CAD drawing layers to render.
getLayers() - Method in interface com.groupdocs.viewer.results.CadViewInfo
The list of layers contained by the CAD drawing.
getLayoutName() - Method in class com.groupdocs.viewer.options.CadOptions
The name of the specific layout to render.
getLayouts() - Method in interface com.groupdocs.viewer.results.CadViewInfo
The list of layouts contained by the CAD drawing.
getLeftMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Left page margin (for HTML rendering only)
getLines() - Method in interface com.groupdocs.viewer.results.Page
The lines contained by the page when viewing as JPG or PNG with enabled Text Extraction.
getLoadOptionsInternal() - Method in class com.groupdocs.viewer.Viewer
 
getLogger() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
 
getLogger() - Method in class com.groupdocs.viewer.ViewerSettings
The logger implementation used for logging (Errors, Warnings, Traces).
getMailStorageOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
Lotus Notes storage data files view options.
getMaxCharsPerRow() - Method in class com.groupdocs.viewer.options.TextOptions
Max chars per row on page.
getMaxHeight() - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
Max height of an output image in pixels.
getMaxHeight() - Method in class com.groupdocs.viewer.options.JpgViewOptions
Max height of an output image in pixels.
getMaxHeight() - Method in class com.groupdocs.viewer.options.PngViewOptions
Max height of an output image in pixels.
getMaxHeight() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Max height of the output image (for rendering to PNG/JPG only)
getMaxItems() - Method in class com.groupdocs.viewer.options.MailStorageOptions
The maximum number of messages or items for render.
getMaxItemsInFolder() - Method in class com.groupdocs.viewer.options.OutlookOptions
The maximum number of messages or items, that can be rendered from one folder.
getMaxRowsPerPage() - Method in class com.groupdocs.viewer.options.TextOptions
Max rows per page.
getMaxWidth() - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
Max width of an output image in pixels.
getMaxWidth() - Method in class com.groupdocs.viewer.options.JpgViewOptions
Max width of an output image in pixels.
getMaxWidth() - Method in class com.groupdocs.viewer.options.PngViewOptions
Max width of an output image in pixels.
getMaxWidth() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Max width of the output image (for rendering to PNG/JPG only)
getName() - Method in enum com.groupdocs.viewer.options.Field
Field name.
getName() - Method in interface com.groupdocs.viewer.results.Layer
The name of the layer.
getName() - Method in interface com.groupdocs.viewer.results.Layout
The name of the layout.
getName() - Method in interface com.groupdocs.viewer.results.Page
The worksheet or page name.
getNotesCount() - Method in interface com.groupdocs.viewer.results.LotusNotesViewInfo
Notes count in storage
getNumber() - Method in interface com.groupdocs.viewer.results.Page
The page number.
getOutlookOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The MS Outlook data files view options.
getPageKey(int, String) - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns unique identifier for the cache entry that represents page file.
getPageRotations() - Method in class com.groupdocs.viewer.options.ViewOptions
The page rotations.
getPages() - Method in interface com.groupdocs.viewer.results.ViewInfo
The list of pages to view.
getPageSize() - Method in class com.groupdocs.viewer.options.EmailOptions
The size of the output page.
getPageSize() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The output page size.
getPageStreamFactory() - Method in class com.groupdocs.viewer.options.JpgViewOptions
The factory which implements methods for creating and releasing output page stream.
getPassword() - Method in class com.groupdocs.viewer.options.LoadOptions
The password for opening encrypted file.
getPc3File() - Method in class com.groupdocs.viewer.options.CadOptions
PC3 - plotter configuration file
getPdfOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The PDF documents view options.
getPermissions() - Method in class com.groupdocs.viewer.options.Security
The PDF document permissions such as printing, modification and data extraction.
getPermissionsPassword() - Method in class com.groupdocs.viewer.options.Security
The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction.
getPosition() - Method in class com.groupdocs.viewer.options.Watermark
The watermark position.
getPresentationOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The presentation processing documents view options.
getProjectManagementOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The project management files view options.
getQuality() - Method in class com.groupdocs.viewer.options.JpgViewOptions
Quality of the output image; Valid values are between 1 and 100; Default value is 90.
getRelativeSize() - Method in class com.groupdocs.viewer.options.Size
The watermark text size in percentages in relation to page width.
getResourceFilter(int) - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns filter string to search for cache entries that represents Resource objects.
getResourceKey(int, Resource) - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns unique identifier for the cache entry that represents Resource object.
getResourceLoadingTimeout() - Method in class com.groupdocs.viewer.options.LoadOptions
The external resources e.g. graphics loading timeout.
getRightMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Right page margin (for HTML rendering only)
getScaleFactor() - Method in class com.groupdocs.viewer.options.CadOptions
Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller.
getSearchOption() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
Specifies whether to search the current folder, or the current folder and all subfolders.
getSecurity() - Method in class com.groupdocs.viewer.options.PdfViewOptions
The output PDF document security options.
getSize() - Method in class com.groupdocs.viewer.options.Watermark
The watermark size.
getSize() - Method in interface com.groupdocs.viewer.results.Attachment
Attachment file size in bytes.
getSpreadsheetOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The spreadsheet files view options.
getStartDate() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The start date of the Gantt Chart View to be included into the output.
getStartDate() - Method in interface com.groupdocs.viewer.results.ProjectManagementViewInfo
The date time from which the project started.
getStartPointX() - Method in class com.groupdocs.viewer.options.Tile
The X coordinate of the lowest left point on the drawing where the tile begins.
getStartPointY() - Method in class com.groupdocs.viewer.options.Tile
The Y coordinate of the lowest left point on the drawing where the tile begins.
getSupportedFileTypes() - Static method in enum com.groupdocs.viewer.FileType
Retrieves supported file types
getText() - Method in class com.groupdocs.viewer.options.FileName
 
getText() - Method in class com.groupdocs.viewer.options.Watermark
The watermark text.
getTextFilter() - Method in class com.groupdocs.viewer.options.MailStorageOptions
The keywords used to filter messages.
getTextFilter() - Method in class com.groupdocs.viewer.options.OutlookOptions
The keywords used to filter messages.
getTextOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
Text files splitting to pages options.
getTextOverflowMode() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
The text overflow mode for rendering spreadsheet documents into HTML.
getTiles() - Method in class com.groupdocs.viewer.options.CadOptions
The drawing regions to render.
getTimeUnit() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The time unit.
getTimeZoneOffset() - Method in class com.groupdocs.viewer.options.EmailOptions
Message time zone offset
getTopMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Top page margin (for HTML rendering only)
getValue() - Method in interface com.groupdocs.viewer.results.TextElement
The element value.
getViewInfo(ViewInfoOptions) - Method in class com.groupdocs.viewer.Viewer
Returns information about view and document specific information.
getViewInfoKey() - Static method in class com.groupdocs.viewer.caching.CacheKeys
Returns unique identifier for the cache entry that represents ViewInfo object.
getVisioRenderingOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The Visio files processing documents view options.
getWaitTimeout() - Method in class com.groupdocs.viewer.caching.FileCache
 
getWatermark() - Method in class com.groupdocs.viewer.options.ViewOptions
The text watermark applied to each page.
getWidth() - Method in class com.groupdocs.viewer.options.CadOptions
The width of the output result in pixels.
getWidth() - Method in class com.groupdocs.viewer.options.JpgViewOptions
The width of the output image in pixels.
getWidth() - Method in class com.groupdocs.viewer.options.PngViewOptions
The width of the output image in pixels.
getWidth() - Method in class com.groupdocs.viewer.options.Tile
The width of the tile in pixels.
getWidth() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Image width (for rendering to PNG/JPG only)
getWidth() - Method in interface com.groupdocs.viewer.results.Layout
The width of the layout.
getWidth() - Method in interface com.groupdocs.viewer.results.Page
The width of the page in pixels when viewing as JPG or PNG.
getWidth() - Method in interface com.groupdocs.viewer.results.TextElement
The width of the rectangle which contains the element (in pixels).
getWordProcessingOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
The word processing documents view options.
getWords() - Method in interface com.groupdocs.viewer.results.Line
The words contained by the line.
getX() - Method in interface com.groupdocs.viewer.results.TextElement
The X coordinate of the highest left point on the page layout where the rectangle that contains element begins.
getY() - Method in interface com.groupdocs.viewer.results.TextElement
The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins.
GroupDocsViewerException - Exception in com.groupdocs.viewer.exception
Represents the generic errors that occur during document processing.
GroupDocsViewerException(String) - Constructor for exception com.groupdocs.viewer.exception.GroupDocsViewerException
Initializes a new instance of the GroupDocsViewerException class with a specified error message.
GroupDocsViewerException(Throwable) - Constructor for exception com.groupdocs.viewer.exception.GroupDocsViewerException
Instantiates a new Group docs exception.
GroupDocsViewerException(String, Throwable) - Constructor for exception com.groupdocs.viewer.exception.GroupDocsViewerException
Initializes a new instance of the GroupDocsViewerException class with a specified error message.

H

HALF_SIZE - Static variable in class com.groupdocs.viewer.options.Size
The half of the maximum size of watermark text that fits page.
hashCode() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
Returns the hash code for the current FolderFontSource object.
hashCode() - Method in class com.groupdocs.viewer.options.CadOptions
 
hashCode() - Method in class com.groupdocs.viewer.options.EmailOptions
 
HtmlViewOptions - Class in com.groupdocs.viewer.options
Provides options for rendering documents into HTML format.

I

ImageQuality - Enum in com.groupdocs.viewer.options
The quality of images in the output HTML contained by the PDF documents.
IMaxSizeOptions - Interface in com.groupdocs.viewer.options
Limits of image size options interface.
IncorrectPasswordException - Exception in com.groupdocs.viewer.exception
The exception that is thrown when specified password is incorrect.
IncorrectPasswordException() - Constructor for exception com.groupdocs.viewer.exception.IncorrectPasswordException
Initializes a new instance of the IncorrectPasswordException class.
IncorrectPasswordException(String, Throwable) - Constructor for exception com.groupdocs.viewer.exception.IncorrectPasswordException
Initializes a new instance of the IncorrectPasswordException class with a specified error message.
invoke() - Method in interface com.groupdocs.viewer.interfaces.CreateFileStream
The method must return OutputStream that will be used to write output file data.
invoke(int) - Method in interface com.groupdocs.viewer.interfaces.CreatePageStream
The method must return OutputStream that will be used to write output page data.
invoke(int, Resource) - Method in interface com.groupdocs.viewer.interfaces.CreateResourceStream
The method must return OutputStream that will be used to write output HTML resource data.
invoke(int, Resource) - Method in interface com.groupdocs.viewer.interfaces.CreateResourceUrl
Represents the method that creates URL for HTML resource.
invoke(Closeable) - Method in interface com.groupdocs.viewer.interfaces.ReleaseFileStream
Releases stream which was instantiated by the method associated with CreateFileStream interface.
invoke(int, Closeable) - Method in interface com.groupdocs.viewer.interfaces.ReleasePageStream
Releases stream which was instantiated by the method associated with CreatePageStream interface.
invoke(int, Resource, OutputStream) - Method in interface com.groupdocs.viewer.interfaces.ReleaseResourceStream
Releases stream which was instantiated by the method associated with CreateResourceStream interface.
isCadOptionsInitialized_Internal() - Method in class com.groupdocs.viewer.options.BaseViewOptions
 
isDebugEnabled() - Method in class com.groupdocs.viewer.logging.FileLogger
 
isDebugEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Checks is debug logging enabled
isDetectSeparator() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Detect separator (for CSV/TSV files).
isDisableCharsGrouping() - Method in class com.groupdocs.viewer.options.PdfOptions
If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML.
isEmailOptionsInitialized_Internal() - Method in class com.groupdocs.viewer.options.BaseViewOptions
 
isEnableFontHinting() - Method in class com.groupdocs.viewer.options.PdfOptions
Enables font hinting.
isEnableLayeredRendering() - Method in class com.groupdocs.viewer.options.PdfOptions
Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML.
isEncrypted() - Method in interface com.groupdocs.viewer.results.FileInfo
Indicates that file is encrypted.
isEqualTo(FolderFontSource, FolderFontSource) - Static method in class com.groupdocs.viewer.fonts.FolderFontSource
Determines whether two FolderFontSource objects are the same.
isErrorEnabled() - Method in class com.groupdocs.viewer.logging.FileLogger
 
isErrorEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Checks is error logging enabled
isExcludeFonts() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
When enabled prevents adding any fonts into HTML document.
isExtractText() - Method in class com.groupdocs.viewer.options.JpgViewOptions
Enables text extraction.
isExtractText() - Method in class com.groupdocs.viewer.options.PngViewOptions
Enables text extraction.
isExtractText() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Indicates that text extraction is enabled.
isForPrinting() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Indicates whether to optimize output HTML for printing.
isMinify() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Enables HTML content and HTML resources minification.
isNested() - Method in class com.groupdocs.viewer.results.Resource
Indicates whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource.
isNotEqualTo(FolderFontSource, FolderFontSource) - Static method in class com.groupdocs.viewer.fonts.FolderFontSource
Determines whether two FolderFontSource objects are not the same.
isOnePagePerSheet() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Indicates that one sheet is rendered into one page.
isPageRotationsInitialized_Internal() - Method in class com.groupdocs.viewer.options.ViewOptions
To prevent creating the instance just to check that it is empty
isPrintingAllowed() - Method in interface com.groupdocs.viewer.results.PdfViewInfo
Indicates if printing of the document is allowed.
isRecursive() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
Checks if fonts would be searched recursively
isRenderByPageBreaks() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
When this option is enabled a worksheet will be rendered by page breaks.
isRenderComments() - Method in class com.groupdocs.viewer.options.BaseViewOptions
Enables rendering comments.
isRenderFiguresOnly() - Method in class com.groupdocs.viewer.options.VisioRenderingOptions
Render only Visio figures, not a diagram
isRenderGridLines() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Enables grid lines rendering.
isRenderHeadings() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Is headings rendering enabled.
isRenderHiddenColumns() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Enables hidden columns rendering.
isRenderHiddenPages() - Method in class com.groupdocs.viewer.options.BaseViewOptions
Enables rendering of hidden pages.
isRenderHiddenRows() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Enables hidden rows rendering.
isRenderLayouts() - Method in class com.groupdocs.viewer.options.CadOptions
Indicates whether layouts from CAD document should be rendered.
isRenderNotes() - Method in class com.groupdocs.viewer.options.BaseViewOptions
Enables rendering notes.
isRenderOriginalPageSize() - Method in class com.groupdocs.viewer.options.PdfOptions
When this option enabled the output pages will have the same size in pixels as page size in a source PDF document.
isRenderPrintAreaOnly() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Indicates that only print areas are rendered.
isRenderResponsive() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Enables responsive rendering; Responsive web-pages render well on a devices with different screen size.
isRenderTextAsImage() - Method in class com.groupdocs.viewer.options.PdfOptions
If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML.
isRenderToSinglePage() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Enables HTML content will be rendered to single page
isRenderTrackedChanges() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Enables tracked changes (revisions) rendering.
isSkipEmptyColumns() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Disables empty columns rendering.
isSkipEmptyRows() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Disables empty rows rendering.
isTraceEnabled() - Method in class com.groupdocs.viewer.logging.FileLogger
 
isTraceEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Checks is trace logging enabled
isVisible() - Method in interface com.groupdocs.viewer.results.Layer
The layer visibility indicator.
isVisible() - Method in interface com.groupdocs.viewer.results.Page
The page visibility indicator.
isWarningEnabled() - Method in class com.groupdocs.viewer.logging.FileLogger
 
isWarningEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Checks is warning logging enabled

J

JpgViewOptions - Class in com.groupdocs.viewer.options
Provides options for rendering documents into JPG format.
JpgViewOptions(CreatePageStream) - Constructor for class com.groupdocs.viewer.options.JpgViewOptions
Initializes new instance of JpgViewOptions class.
JpgViewOptions(CreatePageStream, ReleasePageStream) - Constructor for class com.groupdocs.viewer.options.JpgViewOptions
Initializes new instance of JpgViewOptions class.
JpgViewOptions(PageStreamFactory) - Constructor for class com.groupdocs.viewer.options.JpgViewOptions
Initializes new instance of JpgViewOptions class.
JpgViewOptions() - Constructor for class com.groupdocs.viewer.options.JpgViewOptions
Initializes new instance of JpgViewOptions class.
JpgViewOptions(String) - Constructor for class com.groupdocs.viewer.options.JpgViewOptions
Initializes new instance of JpgViewOptions class.

L

Layer - Interface in com.groupdocs.viewer.results
Represents layer contained by the CAD drawing.
Layout - Interface in com.groupdocs.viewer.results
Represents layout contained by the CAD drawing.
License - Class in com.groupdocs.viewer
Provides methods to license the component.
License() - Constructor for class com.groupdocs.viewer.License
 
Line - Interface in com.groupdocs.viewer.results
Represents relatively positioned rectangle which contains single line.
LoadOptions - Class in com.groupdocs.viewer.options
Provides options that used to open the file.
LoadOptions() - Constructor for class com.groupdocs.viewer.options.LoadOptions
Initializes new instance of LoadOptions class.
LoadOptions(FileType) - Constructor for class com.groupdocs.viewer.options.LoadOptions
Initializes new instance of LoadOptions class.
LotusNotesViewInfo - Interface in com.groupdocs.viewer.results
Represents view information for Lotus notes database storage Default implementation is LotusNotesViewInfoImpl

M

MailStorageOptions - Class in com.groupdocs.viewer.options
Provides options for rendering Mail storage (Lotus Notes, MBox) data files.
MailStorageOptions() - Constructor for class com.groupdocs.viewer.options.MailStorageOptions
 
MemoryCleaner - Class in com.groupdocs.viewer.utils
Cleanes different resources to free memory
MemoryCleaner() - Constructor for class com.groupdocs.viewer.utils.MemoryCleaner
 
Metered - Class in com.groupdocs.viewer
Provides methods for applying Metered license.
Metered() - Constructor for class com.groupdocs.viewer.Metered
 

N

newArchiveViewInfo(FileType, List<Page>, List<String>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of ArchiveViewInfo interface
newAttachment(String, String) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newAttachment(String, String, String, long) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newAttachment(String, String, String, FileType, long) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newCadViewInfo(FileType, List<Page>, List<Layer>, List<Layout>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newCharacter(char, double, double, double, double) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newFileInfo(FileType) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newLayer(String, boolean) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newLayer(String) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newLayout(String, double, double) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newLine(String, double, double, double, double, List<Word>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of Line interface
newLotusNotesViewInfo(FileType, List<Page>, int) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newMboxViewInfo(FileType, List<Page>, int) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of TextElement interface
newOutlookViewInfo(FileType, List<Page>, List<String>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newPage(int, boolean) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newPage(int, String, boolean) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newPage(int, String, boolean, int, int) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newPage(int, boolean, int, int) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newPage(int, String, boolean, int, int, List<Line>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newPage(int, boolean, int, int, List<Line>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newPdfViewInfo(FileType, List<Page>, boolean) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newProjectManagementViewInfo(FileType, List<Page>, Date, Date) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
newTextElement(T, double, double, double, double) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of TextElement interface
newViewInfo(FileType, List<Page>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of ViewInfo interface
newWord(String, double, double, double, double, List<Character>) - Method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Creates implementation of LotusNotesViewInfo interface
NotSupportedException - Exception in com.groupdocs.viewer.exception
The exception that is thrown when the operation is not supported.
NotSupportedException(String) - Constructor for exception com.groupdocs.viewer.exception.NotSupportedException
 
NotSupportedException(String, Throwable) - Constructor for exception com.groupdocs.viewer.exception.NotSupportedException
Initializes a new instance of the NotSupportedException class with a specified error message.

O

ONE_THIRD - Static variable in class com.groupdocs.viewer.options.Size
The one third of the maximum size of watermark text that fits page.
OutlookOptions - Class in com.groupdocs.viewer.options
Provides options for rendering Outlook data files.
OutlookOptions() - Constructor for class com.groupdocs.viewer.options.OutlookOptions
 
OutlookViewInfo - Interface in com.groupdocs.viewer.results
Represents view information for Outlook Data file.

P

Page - Interface in com.groupdocs.viewer.results
Represents single page that can be viewed.
PageSize - Enum in com.groupdocs.viewer.options
The size of the page.
PageStreamFactory - Interface in com.groupdocs.viewer.interfaces
Defines the methods that are required for instantiating and releasing output page stream.
PasswordRequiredException - Exception in com.groupdocs.viewer.exception
The exception that is thrown when password is required to load the document.
PasswordRequiredException() - Constructor for exception com.groupdocs.viewer.exception.PasswordRequiredException
Initializes a new instance of the PasswordRequiredException class.
PasswordRequiredException(String, Throwable) - Constructor for exception com.groupdocs.viewer.exception.PasswordRequiredException
Initializes a new instance of the PasswordRequiredException class with a specified error message.
PathUtils - Class in com.groupdocs.viewer.utils
The type Path.
PdfOptions - Class in com.groupdocs.viewer.options
Provides options for rendering PDF documents.
PdfOptions() - Constructor for class com.groupdocs.viewer.options.PdfOptions
Initializes new instance of PdfOptions class.
PdfViewInfo - Interface in com.groupdocs.viewer.results
Represents view information for PDF document.
PdfViewOptions - Class in com.groupdocs.viewer.options
Provides options for rendering documents into PDF format.
PdfViewOptions(CreateFileStream) - Constructor for class com.groupdocs.viewer.options.PdfViewOptions
Initializes new instance of PdfViewOptions class.
PdfViewOptions(CreateFileStream, ReleaseFileStream) - Constructor for class com.groupdocs.viewer.options.PdfViewOptions
Initializes new instance of PdfViewOptions class.
PdfViewOptions(FileStreamFactory) - Constructor for class com.groupdocs.viewer.options.PdfViewOptions
Initializes new instance of PdfViewOptions class.
PdfViewOptions() - Constructor for class com.groupdocs.viewer.options.PdfViewOptions
Initializes new instance of PdfViewOptions class.
PdfViewOptions(String) - Constructor for class com.groupdocs.viewer.options.PdfViewOptions
Initializes new instance of PdfViewOptions class.
Permissions - Class in com.groupdocs.viewer.options
Defines PDF document permissions.
Permissions() - Constructor for class com.groupdocs.viewer.options.Permissions
 
PngViewOptions - Class in com.groupdocs.viewer.options
Provides options for rendering documents into PNG format.
PngViewOptions(CreatePageStream) - Constructor for class com.groupdocs.viewer.options.PngViewOptions
Initializes new instance of PngViewOptions class.
PngViewOptions(CreatePageStream, ReleasePageStream) - Constructor for class com.groupdocs.viewer.options.PngViewOptions
Initializes new instance of PngViewOptions class.
PngViewOptions(PageStreamFactory) - Constructor for class com.groupdocs.viewer.options.PngViewOptions
Initializes new instance of PngViewOptions class.
PngViewOptions() - Constructor for class com.groupdocs.viewer.options.PngViewOptions
Initializes new instance of PngViewOptions class.
PngViewOptions(String) - Constructor for class com.groupdocs.viewer.options.PngViewOptions
Initializes new instance of PngViewOptions class.
Position - Enum in com.groupdocs.viewer.options
Defines watermark position.
ProjectManagementOptions - Class in com.groupdocs.viewer.options
Provides options for rendering project management files.
ProjectManagementOptions() - Constructor for class com.groupdocs.viewer.options.ProjectManagementOptions
Creates new instance of ProjectManagementOptions class.
ProjectManagementViewInfo - Interface in com.groupdocs.viewer.results
Represents view information for MS Project document.

R

read() - Method in interface com.groupdocs.viewer.interfaces.FileReader
The method that returns file stream.
ReleaseFileStream - Interface in com.groupdocs.viewer.interfaces
Releases interface which was instantiated by the method associated with CreateFileStream interface.
ReleasePageStream - Interface in com.groupdocs.viewer.interfaces
Releases stream which was instantiated by the method associated with CreatePageStream interface.
ReleaseResourceStream - Interface in com.groupdocs.viewer.interfaces
Releases stream which was instantiated by the method associated with CreateResourceStream interface.
resetFontSources() - Static method in class com.groupdocs.viewer.fonts.FontSettings
Resets font sources that have been set before.
resetLicense() - Static method in class com.groupdocs.viewer.License
 
Resource - Class in com.groupdocs.viewer.results
Represents HTML resource such as font, style, image or graphics.
Resource(String, boolean) - Constructor for class com.groupdocs.viewer.results.Resource
Creates new instance of Resource class.
ResourceStreamFactory - Interface in com.groupdocs.viewer.interfaces
Defines the methods that are required for creating resource URL, instantiating and releasing output HTML resource stream.
rotatePage(int, Rotation) - Method in class com.groupdocs.viewer.options.ViewOptions
Applies clockwise rotation to the page.
Rotation - Enum in com.groupdocs.viewer.options
Defines page rotation in degrees.

S

saveAttachment(Attachment, OutputStream) - Method in class com.groupdocs.viewer.Viewer
Saves attachment file to destination stream.
SearchOption - Enum in com.groupdocs.viewer.fonts
Specifies whether to search the current folder, or the current folder and all subfolders.
Security - Class in com.groupdocs.viewer.options
Provides PDF document security options.
Security() - Constructor for class com.groupdocs.viewer.options.Security
Initializes new instance of Security class.
set(String, Object) - Method in interface com.groupdocs.viewer.caching.Cache
Inserts a cache entry into the cache.
set(String, Object) - Method in class com.groupdocs.viewer.caching.FileCache
Serializes data to the local disk.
setAddressFilter(String) - Method in class com.groupdocs.viewer.options.MailStorageOptions
Sets email-address used to filter messages by sender or recipient.
setAddressFilter(String) - Method in class com.groupdocs.viewer.options.OutlookOptions
The email-address used to filter messages by sender or recipient.
setArchiveOptions(ArchiveOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The archive files view options.
setBackgroundColor(Color) - Method in class com.groupdocs.viewer.options.CadOptions
Sets image background color
setBottomMargin(float) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Bottom page margin (for HTML rendering only)
setCadOptions(CadOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The CAD drawing view options.
setCharset(Charset) - Method in class com.groupdocs.viewer.options.LoadOptions
The Charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.
setColor(Color) - Method in class com.groupdocs.viewer.options.Watermark
The watermark color.
setCountColumnsPerPage(int) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
The columns count to include into each page when splitting worksheet into pages.
setDateTimeFormat(String) - Method in class com.groupdocs.viewer.options.EmailOptions
Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used
setDefaultFontName(String) - Method in class com.groupdocs.viewer.options.BaseViewOptions
Default font to be used when particular font used in document can't be found.
setDetectSeparator(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Detect separator (for CSV/TSV files).
setDisableCharsGrouping(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
Disables chars grouping to keep maximum precision during chars positioning when rendering the page.
setDocumentOpenPassword(String) - Method in class com.groupdocs.viewer.options.Security
The password required to open the PDF document.
setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Callback to estimate Words or Email document saving progress
setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.JpgViewOptions
Callback to estimate Words or Email document saving progress
setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.PdfViewOptions
Callback to estimate Words or Email document saving progress
setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.PngViewOptions
Callback to estimate Words or Email document saving progress
setEmailOptions(EmailOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The email messages view options.
setEnableFontHinting(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
Enables font hinting.
setEnableLayeredRendering(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML.
setEncrypted(boolean) - Method in interface com.groupdocs.viewer.results.FileInfo
Indicates that file is encrypted.
setEndDate(Date) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The end date of the Gantt Chart View to be included into the output.
setExcludeFonts(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
When enabled prevents adding any fonts into HTML document.
setExtractText(boolean) - Method in class com.groupdocs.viewer.options.JpgViewOptions
Enables text extraction.
setExtractText(boolean) - Method in class com.groupdocs.viewer.options.PngViewOptions
Enables text extraction.
setExtractText(boolean) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Indicates that text extraction is enabled.
setFieldTextMap(Map<Field, String>) - Method in class com.groupdocs.viewer.options.EmailOptions
The mapping between email message Field and field text representation.
setFigureWidth(int) - Method in class com.groupdocs.viewer.options.VisioRenderingOptions
Figure width, height will be calculated automatically.
setFileName(FileName) - Method in class com.groupdocs.viewer.options.ArchiveOptions
The filename to display in the header.
setFileType(FileType) - Method in class com.groupdocs.viewer.options.LoadOptions
The type of the file to open.
setFolder(String) - Method in class com.groupdocs.viewer.options.ArchiveOptions
The folder inside the archive to be rendered.
setFolder(String) - Method in class com.groupdocs.viewer.options.OutlookOptions
The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render.
setFontName(String) - Method in class com.groupdocs.viewer.options.Watermark
The font name used for the watermark.
setFontSources(FontSource...) - Static method in class com.groupdocs.viewer.fonts.FontSettings
Set the sources to look for TrueType fonts when rendering documents.
setFontsToExclude(List<String>) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
The list of font names, to exclude from HTML document.
setForPrinting(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Indicates whether to optimize output HTML for printing.
setHeight(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
The height of an output image in pixels.
setHeight(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
The height of an output image in pixels.
setHeight(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Image height (for rendering to PNG/JPG only)
setImageHeight(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
The height of an output image in pixels.
setImageHeight(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
The height of an output image in pixels.
setImageMaxHeight(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Max height of an output image in pixels.
setImageMaxHeight(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
Max height of an output image in pixels.
setImageMaxWidth(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Max width of an output image in pixels.
setImageMaxWidth(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
Max width of an output image in pixels.
setImageQuality(ImageQuality) - Method in class com.groupdocs.viewer.options.PdfOptions
Specifies output image quality for image resources when rendering into HTML.
setImageWidth(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
The width of the output image in pixels.
setImageWidth(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
The width of the output image in pixels.
setInstance(CacheableFactory) - Static method in class com.groupdocs.viewer.caching.extra.CacheableFactory
Sets instance of CacheableFactory
setItemsPerPage(int) - Method in class com.groupdocs.viewer.options.ArchiveOptions
Number of records per page (for rendering to HTML only)
setJpgQuality(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90.
setLayers(List<Layer>) - Method in class com.groupdocs.viewer.options.CadOptions
The CAD drawing layers to render.
setLayoutName(String) - Method in class com.groupdocs.viewer.options.CadOptions
The name of the specific layout to render.
setLeftMargin(float) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Left page margin (for HTML rendering only)
setLicense(InputStream) - Method in class com.groupdocs.viewer.License
Licenses the component.
setLicense(Path) - Method in class com.groupdocs.viewer.License
Licenses the component.
setLicense(String) - Method in class com.groupdocs.viewer.License
Licenses the component.
setLoadOptionsInternal(LoadOptions) - Method in class com.groupdocs.viewer.Viewer
 
setLogger(ILogger) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Sets the logger.
setMailStorageOptions(MailStorageOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
Lotus Notes storage data files view options.
setMaxCharsPerRow(int) - Method in class com.groupdocs.viewer.options.TextOptions
Max chars per row on page.
setMaxHeight(int) - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
Max height of an output image in pixels.
setMaxHeight(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
Max height of an output image in pixels.
setMaxHeight(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
Max height of an output image in pixels.
setMaxHeight(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Max height of the output image (for rendering to PNG/JPG only)
setMaxItems(int) - Method in class com.groupdocs.viewer.options.MailStorageOptions
Sets maximum number of messages or items for render.
setMaxItemsInFolder(int) - Method in class com.groupdocs.viewer.options.OutlookOptions
The maximum number of messages or items, that can be rendered from one folder.
setMaxRowsPerPage(int) - Method in class com.groupdocs.viewer.options.TextOptions
Max rows per page.
setMaxWidth(int) - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
Max width of an output image in pixels.
setMaxWidth(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
Max width of an output image in pixels.
setMaxWidth(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
Max width of an output image in pixels.
setMaxWidth(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Max width of the output image (for rendering to PNG/JPG only)
setMeteredKey(String, String) - Method in class com.groupdocs.viewer.Metered
Activates product with Metered keys.
setMinify(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Enables HTML content and HTML resources minification.
setOutlookOptions(OutlookOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The MS Outlook data files view options.
setPageSize(PageSize) - Method in class com.groupdocs.viewer.options.EmailOptions
The size of the output page.
setPageSize(PageSize) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The output page size.
setPassword(String) - Method in class com.groupdocs.viewer.options.LoadOptions
The password for opening encrypted file.
setPc3File(String) - Method in class com.groupdocs.viewer.options.CadOptions
PC3 - plotter configuration file
setPdfOptions(PdfOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The PDF documents view options.
setPermissions(int) - Method in class com.groupdocs.viewer.options.Security
The PDF document permissions such as printing, modification and data extraction.
setPermissionsPassword(String) - Method in class com.groupdocs.viewer.options.Security
The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction.
setPosition(Position) - Method in class com.groupdocs.viewer.options.Watermark
The watermark position.
setPresentationOptions(PresentationOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The presentation processing documents view options.
setProjectManagementOptions(ProjectManagementOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The project management files view options.
setQuality(byte) - Method in class com.groupdocs.viewer.options.JpgViewOptions
Quality of the output image; Valid values are between 1 and 100; Default value is 90.
setRenderByPageBreaks(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
When this option is enabled a worksheet will be rendered by page breaks.
setRenderComments(boolean) - Method in class com.groupdocs.viewer.options.BaseViewOptions
Enables rendering comments.
setRenderFiguresOnly(boolean) - Method in class com.groupdocs.viewer.options.VisioRenderingOptions
Render only Visio figures, not a diagram
setRenderGridLines(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Enables grid lines rendering.
setRenderHeadings(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Enables headings rendering.
setRenderHiddenColumns(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Enables hidden columns rendering.
setRenderHiddenPages(boolean) - Method in class com.groupdocs.viewer.options.BaseViewOptions
Enables rendering of hidden pages.
setRenderHiddenRows(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Enables hidden rows rendering.
setRenderLayouts(boolean) - Method in class com.groupdocs.viewer.options.CadOptions
Indicates whether layouts from CAD document should be rendered.
setRenderNotes(boolean) - Method in class com.groupdocs.viewer.options.BaseViewOptions
Enables rendering notes.
setRenderOriginalPageSize(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
When this option enabled the output pages will have the same size in pixels as page size in a source PDF document.
setRenderResponsive(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Enables responsive rendering; Responsive web-pages render well on a devices with different screen size.
setRenderTextAsImage(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML.
setRenderToSinglePage(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
Enables HTML content will be rendered to single page
setRenderTrackedChanges(boolean) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Enables tracked changes (revisions) rendering.
setResourceLoadingTimeout(int) - Method in class com.groupdocs.viewer.options.LoadOptions
The external resources e.g. graphics loading timeout.
setRightMargin(float) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Right page margin (for HTML rendering only)
setSecurity(Security) - Method in class com.groupdocs.viewer.options.PdfViewOptions
The output PDF document security options.
setSize(Size) - Method in class com.groupdocs.viewer.options.Watermark
The watermark size.
setSkipEmptyColumns(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Disables empty columns rendering.
setSkipEmptyRows(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
Disables empty rows rendering.
setSpreadsheetOptions(SpreadsheetOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The spreadsheet files view options.
setStartDate(Date) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The start date of the Gantt Chart View to be included into the output.
setTextFilter(String) - Method in class com.groupdocs.viewer.options.MailStorageOptions
Sets the keywords used to filter messages.
setTextFilter(String) - Method in class com.groupdocs.viewer.options.OutlookOptions
The keywords used to filter messages.
setTextOptions(TextOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
Text files splitting to pages options.
setTextOverflowMode(TextOverflowMode) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
The text overflow mode for rendering spreadsheet documents into HTML.
setTiles(List<Tile>) - Method in class com.groupdocs.viewer.options.CadOptions
The drawing regions to render.
setTimeUnit(TimeUnit) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
The time unit.
setTimeZoneOffset(TimeZone) - Method in class com.groupdocs.viewer.options.EmailOptions
Message time zone offset
setTopMargin(float) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
Top page margin (for HTML rendering only)
setVisioRenderingOptions(VisioRenderingOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
Sets the Visio files processing documents view options.
setWaitTimeout(TimeSpan) - Method in class com.groupdocs.viewer.caching.FileCache
 
setWatermark(Watermark) - Method in class com.groupdocs.viewer.options.ViewOptions
The text watermark applied to each page.
setWidth(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
The width of the output image in pixels.
setWidth(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
The width of the output image in pixels.
setWidth(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
Image width (for rendering to PNG/JPG only)
setWordProcessingOptions(WordProcessingOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
The word processing documents view options.
Size - Class in com.groupdocs.viewer.options
Watermark size.
Size(byte) - Constructor for class com.groupdocs.viewer.options.Size
Initializes new instance of Size class.
SOURCE - Static variable in class com.groupdocs.viewer.options.FileName
The name of the source file.
SpreadsheetOptions - Class in com.groupdocs.viewer.options
Provides options for rendering spreadsheets.

T

TextElement<T> - Interface in com.groupdocs.viewer.results
Represents generic text element.
TextOptions - Class in com.groupdocs.viewer.options
Text files splitting to pages options.
TextOptions() - Constructor for class com.groupdocs.viewer.options.TextOptions
 
TextOverflowMode - Enum in com.groupdocs.viewer.options
Defines text overflow mode for rendering spreadsheet documents into HTML.
Tile - Class in com.groupdocs.viewer.options
Represents drawing region.
Tile(int, int, int, int) - Constructor for class com.groupdocs.viewer.options.Tile
Initializes a new instance of the Tile class.
TimeUnit - Enum in com.groupdocs.viewer.options
Time unit of the project duration.
toString() - Method in exception com.groupdocs.viewer.exception.GroupDocsViewerException
 
toString() - Method in enum com.groupdocs.viewer.FileType
Returns a String that represents the current object.
toString() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
Returns a string that represents the current object.
toString() - Method in class com.groupdocs.viewer.options.CadOptions
 
toString(ToStringStyle) - Method in class com.groupdocs.viewer.options.CadOptions
 
toString() - Method in class com.groupdocs.viewer.options.EmailOptions
 
toString(ToStringStyle) - Method in class com.groupdocs.viewer.options.EmailOptions
 
toString() - Method in enum com.groupdocs.viewer.options.Field
Returns a string that represents the current object.
toString() - Method in class com.groupdocs.viewer.options.FileName
Returns a string that represents the current object.
toString() - Method in class com.groupdocs.viewer.results.Resource
Returns a string that represents the current object.
trace(String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes a trace message to the console.
trace(Throwable, String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes a trace message to the console.
trace(String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Trace message
trace(Throwable, String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Trace message

V

valueOf(String) - Static method in enum com.groupdocs.viewer.FileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.fonts.SearchOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.options.Field
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.options.ImageQuality
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.options.PageSize
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.options.Position
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.options.Rotation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.options.TextOverflowMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.groupdocs.viewer.options.TimeUnit
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.groupdocs.viewer.FileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.fonts.SearchOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.options.Field
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.options.ImageQuality
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.options.PageSize
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.options.Position
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.options.Rotation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.options.TextOverflowMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.groupdocs.viewer.options.TimeUnit
Returns an array containing the constants of this enum type, in the order they are declared.
view(ViewOptions) - Method in class com.groupdocs.viewer.Viewer
Creates view of all document pages.
view(ViewOptions, int...) - Method in class com.groupdocs.viewer.Viewer
Creates view of specific document pages.
Viewer - Class in com.groupdocs.viewer
Represents main class that controls document rendering process.
Viewer(InputStream) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(InputStream, boolean) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(InputStream, LoadOptions) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(InputStream, LoadOptions, boolean) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(InputStream, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(InputStream, LoadOptions, ViewerSettings, boolean) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(InputStream, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(InputStream, ViewerSettings, boolean) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of class.
Viewer(FileReader, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(FileReader, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(String) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(Path) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(String, LoadOptions) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(Path, LoadOptions) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(String, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(Path, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(String, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
Viewer(Path, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
Initializes new instance of Viewer class.
ViewerLogger - Class in com.groupdocs.viewer.logging
Global viewer logger Implements logging messages to integrated or user defined logger.
ViewerLogger() - Constructor for class com.groupdocs.viewer.logging.ViewerLogger
 
ViewerSettings - Class in com.groupdocs.viewer
Defines settings for customizing Viewer behaviour.
ViewerSettings(Cache, ILogger) - Constructor for class com.groupdocs.viewer.ViewerSettings
Initializes new instance of ViewerSettings class.
ViewerSettings(ILogger) - Constructor for class com.groupdocs.viewer.ViewerSettings
Initializes new instance of ViewerSettings class.
ViewerSettings(Cache) - Constructor for class com.groupdocs.viewer.ViewerSettings
Initializes new instance of ViewerSettings class.
ViewInfo - Interface in com.groupdocs.viewer.results
Represents view information for generic document.
ViewInfoOptions - Class in com.groupdocs.viewer.options
Provides options used for retrieving information about view.
ViewOptions - Class in com.groupdocs.viewer.options
Provides rendering options.
ViewOptions() - Constructor for class com.groupdocs.viewer.options.ViewOptions
 
VisioRenderingOptions - Class in com.groupdocs.viewer.options
The Visio files processing documents view options.
VisioRenderingOptions() - Constructor for class com.groupdocs.viewer.options.VisioRenderingOptions
Initializes new instance of class.

W

warning(String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes a warning message to the console.
warning(Throwable, String, Object...) - Method in class com.groupdocs.viewer.logging.FileLogger
Writes a warning message to the console.
warning(String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Warning message
warning(Throwable, String, Object...) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
Warning message
Watermark - Class in com.groupdocs.viewer.options
Represents text watermark.
Watermark(String) - Constructor for class com.groupdocs.viewer.options.Watermark
Initializes new instance of Watermark class.
Word - Interface in com.groupdocs.viewer.results
Represents relatively positioned rectangle which contains single word.
WordProcessingOptions - Class in com.groupdocs.viewer.options
Provides options for rendering word processing documents.
WordProcessingOptions() - Constructor for class com.groupdocs.viewer.options.WordProcessingOptions
Provides options for rendering word processing documents.
A B C D E F G H I J L M N O P R S T V W 
Skip navigation links

Copyright © 2023. All rights reserved.