- Field - Enum in com.groupdocs.viewer.options
-
Represents email message fields e.g. From, To, Subject etc.
- FILE_PATH_FORMAT - Static variable in class com.groupdocs.viewer.options.HtmlViewOptions
-
- FILE_READER - Static variable in class com.groupdocs.viewer.Viewer
-
- FileCache - Class in com.groupdocs.viewer.caching
-
Represents a local on-disk cache.
- FileCache(String) - Constructor for class com.groupdocs.viewer.caching.FileCache
-
Creates a new instance of the FileCache class.
- FileCache(Path) - Constructor for class com.groupdocs.viewer.caching.FileCache
-
Creates a new instance of the FileCache class.
- FileCache(String, String) - Constructor for class com.groupdocs.viewer.caching.FileCache
-
Creates a new instance of the FileCache class.
- FileCache(Path, String) - Constructor for class com.groupdocs.viewer.caching.FileCache
-
Creates a new instance of the FileCache class.
- FileInfo - Interface in com.groupdocs.viewer.results
-
Contains information about a file.
- FileLogger - Class in com.groupdocs.viewer.logging
-
Writes log messages to a file.
- FileLogger(String) - Constructor for class com.groupdocs.viewer.logging.FileLogger
-
Creates a logger that logs messages to a file specified by the provided file name.
- FileLogger(String, boolean, boolean, boolean, boolean) - Constructor for class com.groupdocs.viewer.logging.FileLogger
-
Creates a logger that logs messages to a file with specified logging levels.
- FileName - Class in com.groupdocs.viewer.options
-
Represents the name of a file in an archive.
- FileName(String) - Constructor for class com.groupdocs.viewer.options.FileName
-
Initializes a new instance of the FileName class.
- FileNotFoundException - Exception in com.groupdocs.viewer.exception
-
This exception is thrown when a file or directory is not found.
- FileNotFoundException(String) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
-
Creates an instance of the FileNotFoundException class with the specified message.
- FileNotFoundException(Path) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
-
Initializes a new instance of the FileNotFoundException class with a specified file path.
- FileNotFoundException(String, Object...) - Constructor for exception com.groupdocs.viewer.exception.FileNotFoundException
-
Creates 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 an interface for reading a file stream.
- FileStreamFactory - Interface in com.groupdocs.viewer.interfaces
-
Defines methods that are required for instantiating and releasing an output file stream.
- FileType - Enum in com.groupdocs.viewer
-
Represents the file type.
- FolderFontSource - Class in com.groupdocs.viewer.fonts
-
Represents a folder that contains TrueType fonts.
- FolderFontSource(String, SearchOption) - Constructor for class com.groupdocs.viewer.fonts.FolderFontSource
-
Initializes a new instance of the 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 a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.
- forEmbeddedResources(CreatePageStream, ReleasePageStream) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.
- forEmbeddedResources(PageStreamFactory) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources.
- forEmbeddedResources() - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Initializes a new instance of the HtmlViewOptions class.
- forEmbeddedResources(String) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Initializes a new instance of the HtmlViewOptions class.
- forEmbeddedResources(Path) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Initializes a new instance of the HtmlViewOptions class.
- forExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Initializes a new instance of the 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 a new instance of the HtmlViewOptions class for rendering into HTML with external resources.
- forExternalResources(PageStreamFactory, ResourceStreamFactory) - Static method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Initializes a new instance of the 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 a new instance of the HtmlViewOptions class.
- forHtmlView() - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML.
- forHtmlView(boolean) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML.
- forJpgView() - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG.
- forJpgView(boolean) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG.
- forOnePagePerSheet() - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Creates a new instance of SpreadsheetOptions class for rendering one sheet into one page.
- forPdfView() - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the ViewInfoOptions class to retrieve information about view when rendering into PDF.
- forPngView() - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG.
- forPngView(boolean) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG.
- forRenderingByHeight(int) - Static method in class com.groupdocs.viewer.options.CadOptions
-
Initializes a new instance of the CadOptions class for rendering by height.
- forRenderingByPageBreaks() - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Initializes a new instance of the SpreadsheetOptions class for rendering print areas only.
- forRenderingByScaleFactor(double) - Static method in class com.groupdocs.viewer.options.CadOptions
-
Initializes a new instance of the CadOptions class for rendering by scale factor.
- forRenderingByWidth(int) - Static method in class com.groupdocs.viewer.options.CadOptions
-
Initializes a new instance of the CadOptions class for rendering by width.
- forRenderingByWidthAndHeight(int, int) - Static method in class com.groupdocs.viewer.options.CadOptions
-
Initializes a new instance of the CadOptions class for rendering by width and height.
- forRenderingPrintArea() - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Initializes a new instance of the SpreadsheetOptions class for rendering print areas only.
- forRenderingPrintAreaAndPageBreaks() - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Initializes a new instance of SpreadsheetOptions for rendering print areas and page breaks.
- forSplitSheetIntoPages(int) - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Creates a new instance of SpreadsheetOptions class for rendering a sheet into multiple pages.
- forSplitSheetIntoPages(int, int) - Static method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Initializes a new instance of the SpreadsheetOptions class for rendering a sheet into pages.
- fromArgb(int) - Static method in class com.groupdocs.viewer.drawing.Argb32Color
-
Create an Argb32Color from a 32-bit ARGB int value (same as System.Drawing.Color.ToArgb()).
- fromExtension(String) - Static method in enum com.groupdocs.viewer.FileType
-
Maps a file extension to a file type.
- fromFilePath(String) - Static method in enum com.groupdocs.viewer.FileType
-
Extracts the file extension from a file name or file path and maps it to a file type.
- fromHtmlViewOptions(HtmlViewOptions) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the
ViewInfoOptions class based on the
HtmlViewOptions object.
- fromJpgViewOptions(JpgViewOptions) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the
ViewInfoOptions class based on the
JpgViewOptions object.
- fromMediaType(String) - Static method in enum com.groupdocs.viewer.FileType
-
Maps a file media type to a file type.
- fromPdfViewOptions(PdfViewOptions) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the
ViewInfoOptions class based on a PdfViewOptions object.
- fromPngViewOptions(PngViewOptions) - Static method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Initializes a new instance of the
ViewInfoOptions class based on the
PngViewOptions object.
- fromRgb(int, int, int) - Static method in class com.groupdocs.viewer.drawing.Argb32Color
-
Create an opaque Argb32Color from RGB channels (alpha = 255).
- fromRgb(int, int, int) - Static method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Creates a new Rgb24Color from specified red, green, and blue channel values.
- fromRgb24Color(Rgb24Color) - Static method in class com.groupdocs.viewer.drawing.Argb32Color
-
Create Argb32Color from Rgb24Color with alpha set to 255.
- fromRgba(int, int, int, int) - Static method in class com.groupdocs.viewer.drawing.Argb32Color
-
Create an Argb32Color from individual RGBA channels.
- fromSingleValueRgb(int) - Static method in class com.groupdocs.viewer.drawing.Argb32Color
-
Create a grayscale opaque Argb32Color from a single value applied to R, G, B.
- fromStream(InputStream) - Static method in enum com.groupdocs.viewer.FileType
-
Detects the file type by reading the file signature.
- fromStream(InputStream, String) - Static method in enum com.groupdocs.viewer.FileType
-
Detects the file type by reading the file signature.
- fromStream(InputStream, ILogger) - Static method in enum com.groupdocs.viewer.FileType
-
Detects the file type by reading the file signature.
- fromStream(InputStream, String, ILogger) - Static method in enum com.groupdocs.viewer.FileType
-
Detects the file type by reading the file signature.
- FULL_SIZE - Static variable in class com.groupdocs.viewer.options.Size
-
Represents the maximum size of watermark text that fits the page.
- get(String, Class<T>) - Method in interface com.groupdocs.viewer.caching.Cache
-
Retrieves the entry associated with the specified key if it is present, and returns null otherwise.
- get(String, Class<T>) - 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
-
Gets the email address used to filter messages by sender or recipient.
- getAddressFilter() - Method in class com.groupdocs.viewer.options.OutlookOptions
-
Gets the email address used to filter messages by sender or recipient.
- getAllFonts() - Method in class com.groupdocs.viewer.Viewer
-
Returns all fonts used in the loaded documents, including those embedded
inside the document itself and those system fonts installed in the OS and used in the document.
- getAlpha() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Returns the alpha channel [0..255]
- getAlphaFraction() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Returns the alpha channel as fraction [0..1]
- getArchiveOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the archive files view options.
- getArchiveSecurityOptions() - Method in class com.groupdocs.viewer.options.LoadOptions
-
Gets the security options to control the process of extracting archives.
- getArgbValue() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Returns the 32-bit ARGB integer value
- getAttachmentKey(String) - Static method in class com.groupdocs.viewer.caching.CacheKeys
-
Retrieves the unique identifier for the cache entry representing an 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 the unique identifier for the cache entry that represents a collection of
Attachment objects.
- getB() - Method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Gets the blue channel value.
- getBackgroundColor() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the background color of the image.
- getBackgroundColorAsHex() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the background color of the image.
- getBlue() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Returns the blue channel [0..255]
- getBottomMargin() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set bottom margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
If the parameter is less than 0, then the default value is used.
- getBottomMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Bottom page margin (for HTML rendering only)
- getBrightness() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Calculates brightness/lightness of the color (HSL model).
- getBrightness() - Method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Calculates the brightness (lightness) of this color in HSL color space.
- getCache() - Method in class com.groupdocs.viewer.ViewerSettings
-
Gets the cache implementation used for storing rendering results.
- getCachePath() - Method in class com.groupdocs.viewer.caching.FileCache
-
Gets 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 cache path.
- getCadOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the CAD drawing view options.
- getCharacters() - Method in interface com.groupdocs.viewer.results.Word
-
Retrieves the characters contained by the word.
- getCharset() - Method in class com.groupdocs.viewer.options.LoadOptions
-
- getColor() - Method in class com.groupdocs.viewer.options.Watermark
-
Returns the watermark color.
- getColorAsHex() - Method in class com.groupdocs.viewer.options.Watermark
-
Returns the watermark color in hex format.
- getConsumptionCredit() - Static method in class com.groupdocs.viewer.Metered
-
Retrieves the count of credits consumed.
- getConsumptionQuantity() - Static method in class com.groupdocs.viewer.Metered
-
Retrieves the amount of megabytes (MB) processed.
- getCountColumnsPerPage() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Gets the count of columns to include into each page when splitting the worksheet into pages.
- getCountRowsPerPage() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Gets the count of rows to include into each page when splitting the worksheet into pages.
- getDateTimeFormat() - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the time format for the date and time values.
- getDefaultFontName() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Default font to be used when a particular font used in the document can't be found.
- getDocumentOpenPassword() - Method in class com.groupdocs.viewer.options.Security
-
Gets the password required to open the PDF document.
- getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Retrieves the callback used to estimate the saving progress of a Words or Email document.
- getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Gets the callback to estimate the saving progress of a Words or Email document.
- getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Retrieves the callback used to estimate the progress of saving a Words or Email document.
- getDocumentSavingCallback() - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Retrieves the callback for estimating the saving progress of a document.
- getEmailOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the email messages view options.
- getEndDate() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Retrieves the end date of the Gantt Chart View to be included in the output.
- getEndDate() - Method in interface com.groupdocs.viewer.results.ProjectManagementViewInfo
-
Retrieves the date and 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
-
Gets the file extension suffix (including the period "."), e.g., ".doc".
- getFieldTextMap() - Method in class com.groupdocs.viewer.options.EmailOptions
-
Retrieves the mapping between email message fields and their text representations.
- getFigureWidth() - Method in class com.groupdocs.viewer.options.VisioRenderingOptions
-
Retrieves the width of the figure.
- getFileExtension() - Method in class com.groupdocs.viewer.drawing.Image2DFormat
-
Returns lowercase file extension (without dot) for this format.
- getFileFormat() - Method in enum com.groupdocs.viewer.FileType
-
Gets the name of the file format, e.g., "Microsoft Word Document".
- getFileInfo() - Method in class com.groupdocs.viewer.Viewer
-
Returns information about the file, such as file type and a flag that indicates if the file is encrypted.
- getFileInfoKey() - Static method in class com.groupdocs.viewer.caching.CacheKeys
-
Retrieves the unique identifier for the cache entry that represents a
ViewInfo object.
- getFileKey(String) - Static method in class com.groupdocs.viewer.caching.CacheKeys
-
Retrieves the unique identifier for the cache entry that represents a file.
- getFileName() - Method in class com.groupdocs.viewer.options.ArchiveOptions
-
Gets the filename to be displayed in the header.
- getFileName() - Method in interface com.groupdocs.viewer.results.Attachment
-
Retrieves the file name of the attachment.
- getFileName() - Method in class com.groupdocs.viewer.results.Resource
-
Returns the file name of the resource.
- getFileName(String) - Static method in class com.groupdocs.viewer.utils.PathUtils
-
Gets file name.
- getFilePath() - Method in interface com.groupdocs.viewer.results.Attachment
-
Retrieves the relative path of the attachment.
- getFileType() - Method in class com.groupdocs.viewer.options.LoadOptions
-
Gets the type of the file to open.
- getFileType() - Method in interface com.groupdocs.viewer.results.Attachment
-
Retrieves the file type of the attachment.
- getFileType() - Method in interface com.groupdocs.viewer.results.FileInfo
-
Retrieves the type of the file.
- getFileType() - Method in interface com.groupdocs.viewer.results.ViewInfo
-
Retrieves the type of the file.
- getFolder() - Method in class com.groupdocs.viewer.options.ArchiveOptions
-
Gets the folder inside the archive that will be used for rendering.
- getFolder() - Method in class com.groupdocs.viewer.options.OutlookOptions
-
Gets the name of the folder to render.
- getFolderPath() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
-
Gets the path to the folder that contains TrueType fonts.
- getFolders() - Method in interface com.groupdocs.viewer.results.ArchiveViewInfo
-
Retrieves the list of folders contained within the archive file.
- getFolders() - Method in interface com.groupdocs.viewer.results.OutlookViewInfo
-
Retrieves the list of folders contained in the Outlook Data file.
- getFontName() - Method in class com.groupdocs.viewer.options.Watermark
-
Returns the font name used for the watermark.
- getFontsToExclude() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Retrieves the list of font names to exclude from the HTML document.
- getFormalName() - Method in class com.groupdocs.viewer.drawing.Image2DFormat
-
Returns a formal name of this image format.
- getG() - Method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Gets the green channel value.
- getGreen() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Returns the green channel [0..255]
- getHeight() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the height of the output result in pixels.
- getHeight() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Gets the height of the output image in pixels.
- getHeight() - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Returns the height of the output image in pixels.
- getHeight() - Method in class com.groupdocs.viewer.options.Tile
-
Gets the height of the tile in pixels.
- getHeight() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
The height of the output image (in pixels, for rendering to PNG/JPG only).
- getHeight() - Method in interface com.groupdocs.viewer.results.Layout
-
Retrieves the height of the layout.
- getHeight() - Method in interface com.groupdocs.viewer.results.Page
-
Retrieves the height of the page in pixels when viewing as JPG or PNG.
- getHeight() - Method in interface com.groupdocs.viewer.results.TextElement
-
Retrieves the height of the rectangle that contains the element (in pixels).
- getHue() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Calculates hue of the color in degrees [0..360].
- getHue() - Method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Calculates the hue of this color in degrees (HSL color space).
- getId() - Method in interface com.groupdocs.viewer.results.Attachment
-
Retrieves the unique identifier of the attachment within the context of a single file that contains this attachment.
- getImageHeight() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Gets the height of the output image in pixels when converting a single image to HTML.
- getImageHeight() - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Retrieves the height of the output image in pixels.
- getImageMaxHeight() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Gets the maximum height of an output image in pixels.
- getImageMaxHeight() - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Retrieves the maximum height of an output image in pixels.
- getImageMaxWidth() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Returns the maximum width of an output image in pixels.
- getImageMaxWidth() - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Retrieves the maximum width of an output image in pixels.
- getImageQuality() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
If the source PDF file contains images, consider compressing the images and setting their quality.
- getImageQuality() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Retrieves the output image quality for image resources when rendering into HTML.
- getImageWidth() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Gets the width of the output image in pixels.
- getImageWidth() - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Retrieves the width of the output image in pixels.
- getInstance() - Static method in class com.groupdocs.viewer.caching.extra.CacheableFactory
-
Gets an instance of CacheableFactory that can be used to create cacheable objects.
- getKeys(String) - Method in interface com.groupdocs.viewer.caching.Cache
-
Returns all keys that match the specified filter.
- getKeys(String) - Method in class com.groupdocs.viewer.caching.FileCache
-
Returns all file names that contain the filter in the filename.
- getLayers() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the CAD drawing layers to render.
- getLayers() - Method in interface com.groupdocs.viewer.results.CadViewInfo
-
Retrieves the list of layers in the CAD drawing.
- getLayoutName() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the name of the specific layout to render.
- getLayouts() - Method in interface com.groupdocs.viewer.results.CadViewInfo
-
Retrieves the list of layouts contained within the CAD drawing.
- getLeftMargin() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set left margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
- getLeftMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Retrieves the left page margin for HTML rendering.
- getLines() - Method in interface com.groupdocs.viewer.results.Page
-
Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.
- getLogger() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
-
Gets the logger instance that will be used for logging messages.
- getLogger() - Method in class com.groupdocs.viewer.ViewerSettings
-
Gets the logger implementation used for logging (Errors, Warnings, Traces).
- getMailStorageOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the Lotus Notes storage data files view options.
- getMaxCharsPerRow() - Method in class com.groupdocs.viewer.options.TextOptions
-
Gets the maximum number of characters per row on a page.
- getMaxHeight() - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
-
Retrieves the maximum height of an output image in pixels.
- getMaxHeight() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Gets the maximum height of an output image in pixels.
- getMaxHeight() - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Returns the maximum height of an output image in pixels.
- getMaxHeight() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Returns the maximum height of the output image for rendering to PNG/JPG.
- getMaxItems() - Method in class com.groupdocs.viewer.options.MailStorageOptions
-
Gets the maximum number of messages or items to render.
- getMaxItemsInFolder() - Method in class com.groupdocs.viewer.options.OutlookOptions
-
Gets the maximum number of messages or items that can be rendered from one folder.
- getMaxResolution() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Can be used with CompressImages option to resize the images with a lower resolution.
- getMaxRowsPerPage() - Method in class com.groupdocs.viewer.options.TextOptions
-
Gets the maximum number of rows per page.
- getMaxWidth() - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
-
Retrieves the maximum width of an output image in pixels.
- getMaxWidth() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Gets the maximum width of an output image in pixels.
- getMaxWidth() - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Returns the maximum width of an output image in pixels.
- getMaxWidth() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Returns the maximum width of the output image for rendering to PNG/JPG.
- getMimeCode() - Method in class com.groupdocs.viewer.drawing.Image2DFormat
-
MIME code of the image format.
- getName() - Method in class com.groupdocs.viewer.drawing.Image2DFormat
-
Returns a formal name of this image format.
- getName() - Method in enum com.groupdocs.viewer.options.Field
-
Field name.
- getName() - Method in interface com.groupdocs.viewer.results.Layer
-
Retrieves the name of the layer.
- getName() - Method in interface com.groupdocs.viewer.results.Layout
-
Retrieves the name of the layout.
- getName() - Method in interface com.groupdocs.viewer.results.Page
-
Retrieves the name of the worksheet or page.
- getNotesCount() - Method in interface com.groupdocs.viewer.results.LotusNotesViewInfo
-
Retrieves the count of notes in the storage.
- getNumber() - Method in interface com.groupdocs.viewer.results.Page
-
Retrieves the page number.
- getOutlookOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the MS Outlook data files view options.
- getPageKey(int, String) - Static method in class com.groupdocs.viewer.caching.CacheKeys
-
Retrieves the unique identifier for the cache entry that represents a page file.
- getPageRotations() - Method in class com.groupdocs.viewer.options.ViewOptions
-
Retrieves the page rotations.
- getPages() - Method in interface com.groupdocs.viewer.results.ViewInfo
-
Retrieves the list of pages to view.
- getPageSize() - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the size of the output page.
- getPageSize() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Retrieves the output page size.
- getPageSize() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Retrieves the page size for rendering HTM and HTML files.
- getPageStreamFactory() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Gets the factory that implements methods for creating and releasing the output page stream.
- getPassword() - Method in class com.groupdocs.viewer.options.LoadOptions
-
Gets the password for opening an encrypted file.
- getPc3File() - Method in class com.groupdocs.viewer.options.CadOptions
-
Retrieves the PC3 (Plotter Configuration) file associated with the plotter.
- getPdfOptimizationOptions() - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Reduce output PDF file size applying optimization techniques with different options.
- getPdfOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the PDF documents view options.
- getPermissions() - Method in class com.groupdocs.viewer.options.Security
-
Gets the PDF document permissions such as printing, modification, and data extraction.
- getPermissionsPassword() - Method in class com.groupdocs.viewer.options.Security
-
Gets the password required to change permission settings.
- getPosition() - Method in class com.groupdocs.viewer.options.Watermark
-
Returns the watermark position.
- getPresentationOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the view options for processing presentation documents.
- getProjectManagementOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the project management files view options.
- getQuality() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Gets the quality of the output image.
- getR() - Method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Gets the red channel value.
- getRed() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Returns the red channel [0..255]
- getRelativeSize() - Method in class com.groupdocs.viewer.options.Size
-
Returns the watermark text size in percentages in relation to the page width.
- getResourceFilter(int) - Static method in class com.groupdocs.viewer.caching.CacheKeys
-
Returns a filter string to search for cache entries that represent
Resource objects.
- getResourceKey(int, Resource) - Static method in class com.groupdocs.viewer.caching.CacheKeys
-
Returns a unique identifier for the cache entry that represents a
Resource object.
- getResourceLoadingTimeout() - Method in class com.groupdocs.viewer.options.LoadOptions
-
Gets the timeout for loading external resources.
- getRightMargin() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set right margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
If the parameter is less than 0, then the default value is used.
- getRightMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Gets the right page margin for HTML rendering.
- getSaturation() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Calculates saturation of the color (HSL model).
- getSaturation() - Method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Calculates the saturation of this color in HSL color space.
- getScaleFactor() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the scale factor for rendering.
- getSearchOption() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
-
Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders.
- getSecurity() - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Retrieves the security options for the output PDF document.
- getSize() - Method in class com.groupdocs.viewer.options.Watermark
-
Returns the watermark size.
- getSize() - Method in interface com.groupdocs.viewer.results.Attachment
-
Retrieves the file size of the attachment in bytes.
- getSpreadsheetOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the spreadsheet files view options.
- getStartDate() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Retrieves the start date of the Gantt Chart View to be included in the output.
- getStartDate() - Method in interface com.groupdocs.viewer.results.ProjectManagementViewInfo
-
Retrieves the date and time from which the project started.
- getStartPointX() - Method in class com.groupdocs.viewer.options.Tile
-
Gets the X coordinate of the lowest left point on the drawing where the tile begins.
- getStartPointY() - Method in class com.groupdocs.viewer.options.Tile
-
Gets 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 the supported file types.
- getText() - Method in class com.groupdocs.viewer.options.FileName
-
- getText() - Method in class com.groupdocs.viewer.options.Watermark
-
Returns the watermark text.
- getTextFilter() - Method in class com.groupdocs.viewer.options.MailStorageOptions
-
Gets the keywords used to filter messages.
- getTextFilter() - Method in class com.groupdocs.viewer.options.OutlookOptions
-
Gets the keywords used to filter messages.
- getTextOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the options for splitting text files into pages.
- getTextOverflowMode() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Returns the text overflow mode for rendering spreadsheet documents into HTML.
- getTiles() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the drawing regions to render.
- getTimeUnit() - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Retrieves the time unit.
- getTimeZoneOffset() - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the time zone offset for the message.
- getTimeZoneOffsetMinutes() - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the time zone minutes offset minutes for the message.
- getTopMargin() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set top margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
If the parameter is less than 0, then the default value is used.
- getTopMargin() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Retrieves the top page margin for HTML rendering.
- getUrlConnectTimeout() - Method in class com.groupdocs.viewer.options.LoadOptions
-
Gets the connection timeout for creating a
Viewer using
URL to load a document.
- getUrlReadTimeout() - Method in class com.groupdocs.viewer.options.LoadOptions
-
Gets the read timeout for creating a
Viewer using
URL to load a document.
- getValue() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Gets the 32-bit signed integer representation of this color.
- getValue() - Method in interface com.groupdocs.viewer.results.TextElement
-
Retrieves the value of the text element.
- getViewInfo(ViewInfoOptions) - Method in class com.groupdocs.viewer.Viewer
-
Returns information about the view and document specific information.
- getViewInfoKey() - Static method in class com.groupdocs.viewer.caching.CacheKeys
-
Retrieves the unique identifier for the cache entry that represents a
ViewInfo object.
- getVisioRenderingOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the rendering options for processing Visio files when viewing documents.
- getWatermark() - Method in class com.groupdocs.viewer.options.ViewOptions
-
Gets the text watermark applied to each page.
- getWebDocumentOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG
when rendering Web documents.
- getWhitelistedResources() - Method in class com.groupdocs.viewer.options.LoadOptions
-
- getWidth() - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the width of the output result in pixels.
- getWidth() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Gets the width of the output image in pixels.
- getWidth() - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Returns the width of the output image in pixels.
- getWidth() - Method in class com.groupdocs.viewer.options.Tile
-
Gets the width of the tile in pixels.
- getWidth() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
The width of the output image (in pixels, for rendering to PNG/JPG only).
- getWidth() - Method in interface com.groupdocs.viewer.results.Layout
-
Retrieves the width of the layout.
- getWidth() - Method in interface com.groupdocs.viewer.results.Page
-
Retrieves the width of the page in pixels when viewing as JPG or PNG.
- getWidth() - Method in interface com.groupdocs.viewer.results.TextElement
-
Retrieves the width of the rectangle that contains the element (in pixels).
- getWordProcessingOptions() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
The Word processing files view options.
- getWords() - Method in interface com.groupdocs.viewer.results.Line
-
Retrieves the words contained in the line.
- getX() - Method in interface com.groupdocs.viewer.results.TextElement
-
Retrieves the X coordinate of the highest left point on the page layout where the rectangle that contains the element begins.
- getY() - Method in interface com.groupdocs.viewer.results.TextElement
-
Retrieves the Y coordinate of the highest left point on the page layout where the rectangle that contains the element begins.
- GIF - Static variable in class com.groupdocs.viewer.drawing.Image2DFormat
-
- GroupDocsViewerException - Exception in com.groupdocs.viewer.exception
-
This exception represents generic errors that can 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
-
Initializes a new instance of the GroupDocsViewerException class with a cause of the 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.
- ICON - Static variable in class com.groupdocs.viewer.drawing.Image2DFormat
-
- Image2DFormat - Class in com.groupdocs.viewer.drawing
-
Represents a 2D image format — raster or vector.
- 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
-
This exception is thrown when the 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.
- initViewerFromUrl(URL, int, int) - Method in class com.groupdocs.viewer.Viewer
-
- invoke() - Method in interface com.groupdocs.viewer.interfaces.CreateFileStream
-
Returns an
OutputStream that will be used to write output file data.
- invoke(int) - Method in interface com.groupdocs.viewer.interfaces.CreatePageStream
-
Returns an
OutputStream that will be used to write output page data.
- invoke(int, Resource) - Method in interface com.groupdocs.viewer.interfaces.CreateResourceStream
-
Returns an
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 a URL for an HTML resource.
- invoke(Closeable) - Method in interface com.groupdocs.viewer.interfaces.ReleaseFileStream
-
Releases the stream created by the method associated with the
CreateFileStream interface.
- invoke(int, Closeable) - Method in interface com.groupdocs.viewer.interfaces.ReleasePageStream
-
Releases the stream created by the method associated with the
CreatePageStream interface.
- invoke(int, Resource, OutputStream) - Method in interface com.groupdocs.viewer.interfaces.ReleaseResourceStream
-
- isAllowReusePageContent() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
If this property is set to true, the page content will be reused when optimizing the document for identical pages.
- isAnalyzeFonts() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Replaces fonts as necessary to ensure all characters in the text can be displayed.
- isCadOptionsInitialized_Internal() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
- isCompressImages() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
If the source PDF file contains images, consider compressing the images and setting their quality.
- isConvertToGrayScale() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
PDF file is composed of Text, Image, Attachment, Annotations, Graphs and other objects.
- isDebugEnabled() - Method in class com.groupdocs.viewer.logging.FileLogger
-
Checks if the debug level is enabled for logging.
- isDebugEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
-
Checks if the debug level is enabled for logging.
- isDefault() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Indicates if instance is default (Transparent) - all 4 channels are set to 0.
- isDefault() - Method in class com.groupdocs.viewer.drawing.Rgb24Color
-
Returns true if the color is the default black color (all channels are zero).
- isDetectCharset() - Method in class com.groupdocs.viewer.options.LoadOptions
-
- isDetectSeparator() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Detects the separator for CSV/TSV files.
- isDisableCharsGrouping() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Checks if character grouping is disabled to maintain maximum precision during character positioning when rendering the page.
- isDisableCopyProtection() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Turns off content copy protection when rendering to HTML.
- isDisableFontLicenseVerifications() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Disable any license restrictions for all fonts in current XPS/OXPS document.
- isEmpty() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Indicates if this color is empty (all channels 0)
- isEnableFontHinting() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Determines whether font hinting is enabled.
- isEnableLayeredRendering() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Checks whether rendering of text and graphics should follow the z-order in the original PDF document when rendering into HTML.
- isEnableOpenTypeFeatures() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.
- isEnablePerformanceConversionMode() - Method in class com.groupdocs.viewer.options.CadOptions
-
Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family.
- isEncrypted() - Method in interface com.groupdocs.viewer.results.FileInfo
-
Checks if the 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
-
Checks if error-level logging is enabled.
- isErrorEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
-
Checks if error-level logging is enabled.
- isExcludeFonts() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Determines whether to exclude fonts from the HTML document.
- isExtractText() - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Enables text extraction.
- isExtractText() - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Determines whether text extraction is enabled.
- isExtractText() - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Indicates whether text extraction is enabled.
- isFixedLayout() - Method in class com.groupdocs.viewer.options.PdfOptions
-
PDF is a fixed format so all of the elements have a specific place on a page.
- isFixLinkIssue() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Tries to fix the issue when whole HTML page content is a link.
- isForPrinting() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Checks if the output HTML should be optimized for printing.
- isFullyOpaque() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Indicates if this color is fully opaque (alpha == 255)
- isFullyTransparent() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Indicates if this color is fully transparent (alpha == 0)
- isLicensed() - Method in class com.groupdocs.viewer.License
-
- isLinearize() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Enables optimization the output PDF file for viewing online with a web browser.
- isLinkDuplicateStreams() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sometimes a document contains several identical resource streams (for example images).
- isMinify() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Checks if HTML content and HTML resources minification is enabled.
- isNested() - Method in class com.groupdocs.viewer.results.Resource
-
Returns whether the resource resides inside another resource, e.g. a font resource that resides in a 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 whether one sheet is rendered into one page.
- isOptimizeSpreadsheets() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Optimize Excel spreadsheets border lines and fonts for smaller output file size.
- 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
-
Checks if printing of the document is allowed.
- isRecursive() - Method in class com.groupdocs.viewer.fonts.FolderFontSource
-
Checks if the fonts would be searched recursively.
- isRemoveAnnotations() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Annotations can be deleted when they are unnecessary.
- isRemoveComments() - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Disables rendering comments when set to true.
- isRemoveFormFields() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields.
- isRemoveJavaScript() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts.
- isRemovePrivateInfo() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Remove private information (page piece info) if set to true.
- isRemoveUnusedObjects() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
A PDF document sometimes contains the PDF objects that are not referenced
from any other object in the document.
- isRemoveUnusedStreams() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sometimes a document contains unused resource streams.
- isRenderByPageBreaks() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Determines whether the worksheet should 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, excluding the diagram.
- isRenderGridLines() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Enables rendering of grid lines.
- isRenderHeadings() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Checks if headings rendering is 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
-
Determines whether hidden rows should be rendered.
- isRenderingPrintAreaAndPageBreaks() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area.
- isRenderLayouts() - Method in class com.groupdocs.viewer.options.CadOptions
-
Indicates whether layouts from the 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
-
Enables rendering of pages with the same size in pixels as the page size in the source PDF document.
- isRenderPrintAreaOnly() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Indicates whether only the print areas are rendered.
- isRenderResponsive() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Determines whether responsive rendering is enabled.
- isRenderTextAsImage() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Determines whether the text from the source is rendered as an image in HTML.
- isRenderToSinglePage() - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Enables rendering an entire document to one HTML file.
- isRenderTrackedChanges() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Indicates whether tracked changes (revisions) rendering is enabled.
- isResizeImages() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Can be used with CompressImages option to resize the images with a lower resolution.
- isSkipEmptyColumns() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Indicates whether empty columns should be skipped during rendering.
- isSkipEmptyRows() - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Indicates whether empty rows should be skipped during rendering.
- isSkipExternalResources() - Method in class com.groupdocs.viewer.options.LoadOptions
-
- isSubsetFonts() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Every font used to display text on the page contains set of glyphs for font characters.
- isTraceEnabled() - Method in class com.groupdocs.viewer.logging.FileLogger
-
Checks if the trace level is enabled for logging.
- isTraceEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
-
Checks if the trace level is enabled for logging.
- isTranslucent() - Method in class com.groupdocs.viewer.drawing.Argb32Color
-
Indicates if this color is translucent (alpha between 1 and 254)
- isTryRepair() - Method in class com.groupdocs.viewer.options.LoadOptions
-
When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents.
- isUnembedFonts() - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
If the document uses embedded fonts it means that all font data is placed in the document.
- isUnlinkTableOfContents() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Indicates whether table of contents navigation should be disabled when rendering to HTML or PDF.
- isUpdateFields() - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Gets a value determining if fields of certain types should be updated before saving the input WordProcessing
document to the HTML, PDF, PNG, or JPEG output formats.
- isVector() - Method in class com.groupdocs.viewer.drawing.Image2DFormat
-
Indicates whether this format is vector (true) or raster (false).
- isVisible() - Method in interface com.groupdocs.viewer.results.Layer
-
Checks the visibility of the layer.
- isVisible() - Method in interface com.groupdocs.viewer.results.Page
-
Retrieves the page visibility indicator.
- isWarningEnabled() - Method in class com.groupdocs.viewer.logging.FileLogger
-
Checks if the warning level is enabled for logging.
- isWarningEnabled() - Static method in class com.groupdocs.viewer.logging.ViewerLogger
-
Checks if the warning level is enabled for logging.
- isWrapImagesInSvg() - Method in class com.groupdocs.viewer.options.PdfOptions
-
Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality.
- saveAttachment(Attachment, OutputStream) - Method in class com.groupdocs.viewer.Viewer
-
Saves an attachment file to the destination stream.
- search(SearchHighlightOptions) - Method in class com.groupdocs.viewer.Viewer
-
Performs a text search and highlights matches (if found) in the loaded document
according to the provided options.
- 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 a new instance of the 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 the email address used to filter messages by sender or recipient.
- setAddressFilter(String) - Method in class com.groupdocs.viewer.options.OutlookOptions
-
Sets the email address used to filter messages by sender or recipient.
- setAllowReusePageContent(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to allow reusing page content in the PDF.
- setAnalyzeFonts(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Replaces fonts as necessary to ensure all characters in the text can be displayed.
- setArchiveOptions(ArchiveOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the archive files view options.
- setArchiveSecurityOptions(ArchiveSecurityOptions) - Method in class com.groupdocs.viewer.options.LoadOptions
-
Sets the security options to control the process of extracting archives.
- setBackgroundColor(Color) - Method in class com.groupdocs.viewer.options.CadOptions
-
Sets the background color of the image.
- setBackgroundColor(String) - Method in class com.groupdocs.viewer.options.CadOptions
-
Sets the background color of the image.
- setBottomMargin(double) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set bottom margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
If the parameter is less than 0, then the default value is used.
- setBottomMargin(Double) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets the bottom page margin for HTML rendering.
- setCache(Cache) - Method in class com.groupdocs.viewer.ViewerSettings
-
Sets the cache implementation used for storing rendering results.
- setCadOptions(CadOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the CAD drawing view options.
- setCharacters(List<Character>) - Method in interface com.groupdocs.viewer.results.Word
-
Sets the characters contained by the word.
- setCharset(Charset) - Method in class com.groupdocs.viewer.options.LoadOptions
-
- setColor(Color) - Method in class com.groupdocs.viewer.options.Watermark
-
Sets the watermark color.
- setColor(String) - Method in class com.groupdocs.viewer.options.Watermark
-
Sets the watermark color.
- setCompressImages(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to compress the images in the PDF.
- setConvertToGrayScale(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to convert the PDF to grayscale.
- setCountColumnsPerPage(int) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Sets the count of columns to include into each page when splitting the worksheet into pages.
- setDateTimeFormat(String) - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the time format for the date and time values.
- setDefaultFontName(String) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Default font to be used when a particular font used in the document can't be found.
- setDetectCharset(boolean) - Method in class com.groupdocs.viewer.options.LoadOptions
-
- setDetectSeparator(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Sets whether to detect the separator for CSV/TSV files.
- setDisableCharsGrouping(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Sets the option to disable character grouping, ensuring maximum precision during character positioning when rendering the page.
- setDisableCopyProtection(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Turns off content copy protection when rendering to HTML.
- setDisableFontLicenseVerifications(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Set the flag to disable any license restrictions for all fonts in current XPS/OXPS document.
- setDocumentOpenPassword(String) - Method in class com.groupdocs.viewer.options.Security
-
Sets the password required to open the PDF document.
- setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets the callback used to estimate the saving progress of a Words or Email document.
- setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Sets the callback to estimate the saving progress of a Words or Email document.
- setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Sets the callback used to estimate the progress of saving a Words or Email document.
- setDocumentSavingCallback(IDocumentSavingCallback) - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Sets the callback for estimating the saving progress of a document.
- setEmailOptions(EmailOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets 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 or disables rendering of text and graphics according to the z-order in the original PDF document when rendering into HTML.
- setEnableOpenTypeFeatures(boolean) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.
- setEnablePerformanceConversionMode(boolean) - Method in class com.groupdocs.viewer.options.CadOptions
-
Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family.
- setEncrypted(boolean) - Method in interface com.groupdocs.viewer.results.FileInfo
-
Sets the encryption status of the file.
- setEndDate(Date) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Sets the end date of the Gantt Chart View to be included in the output.
- setEndDate(Date) - Method in interface com.groupdocs.viewer.results.ProjectManagementViewInfo
-
Sets the end date and time for the project.
- setExcludeFonts(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets whether to exclude fonts from the HTML document.
- setExtractText(boolean) - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Enables or disables text extraction.
- setExtractText(boolean) - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Enables or disables text extraction.
- setExtractText(boolean) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Sets the flag indicating whether text extraction is enabled.
- setFieldTextMap(Map<Field, String>) - Method in class com.groupdocs.viewer.options.EmailOptions
-
Sets the mapping between email message fields and their text representations.
- setFigureWidth(int) - Method in class com.groupdocs.viewer.options.VisioRenderingOptions
-
Sets the width of the figure.
- setFileName(FileName) - Method in class com.groupdocs.viewer.options.ArchiveOptions
-
Sets the filename to be displayed in the header.
- setFileName(String) - Method in interface com.groupdocs.viewer.results.Attachment
-
Sets the file name of the attachment.
- setFileName(String) - Method in class com.groupdocs.viewer.results.Resource
-
Sets the file name of the resource.
- setFilePath(String) - Method in interface com.groupdocs.viewer.results.Attachment
-
Sets the relative path of the attachment.
- setFileType(FileType) - Method in class com.groupdocs.viewer.options.LoadOptions
-
Sets the type of the file to open.
- setFileType(FileType) - Method in interface com.groupdocs.viewer.results.Attachment
-
Sets the file type of the attachment.
- setFileType(FileType) - Method in interface com.groupdocs.viewer.results.FileInfo
-
Sets the type of the file.
- setFileType(FileType) - Method in interface com.groupdocs.viewer.results.ViewInfo
-
Sets the file type.
- setFixedLayout(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
PDF is a fixed format so all of the elements have a specific place on a page.
- setFixLinkIssue(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Tries to fix the issue when whole HTML page content is a link.
- setFolder(String) - Method in class com.groupdocs.viewer.options.ArchiveOptions
-
Sets the folder inside the archive that will be used for rendering.
- setFolder(String) - Method in class com.groupdocs.viewer.options.OutlookOptions
-
Sets the name of the folder to render.
- setFolders(List<String>) - Method in interface com.groupdocs.viewer.results.ArchiveViewInfo
-
Sets the list of folders contained within the archive file.
- setFolders(List<String>) - Method in interface com.groupdocs.viewer.results.OutlookViewInfo
-
Sets the list of folders contained in the Outlook Data file.
- setFontName(String) - Method in class com.groupdocs.viewer.options.Watermark
-
Sets the font name used for the watermark.
- setFontSources(FontSource...) - Static method in class com.groupdocs.viewer.fonts.FontSettings
-
Sets the sources to look for TrueType fonts when rendering documents.
- setFontsToExclude(List<String>) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets the list of font names to exclude from the HTML document.
- setForPrinting(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets whether the output HTML should be optimized for printing.
- setHeight(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Sets the height of the output image in pixels.
- setHeight(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Sets the height of the output image in pixels.
- setHeight(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
The height of the output image (in pixels, for rendering to PNG/JPG only).
- setHeight(double) - Method in interface com.groupdocs.viewer.results.Layout
-
Sets the height of the layout.
- setHeight(int) - Method in interface com.groupdocs.viewer.results.Page
-
Sets the height of the page in pixels when viewing as JPG or PNG.
- setHeight(double) - Method in interface com.groupdocs.viewer.results.TextElement
-
Sets the height of the rectangle that contains the element (in pixels).
- setId(String) - Method in interface com.groupdocs.viewer.results.Attachment
-
Sets the unique identifier of the attachment.
- setImageHeight(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets the height of the output image in pixels when converting a single image to HTML.
- setImageHeight(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Sets the height of the output image in pixels.
- setImageMaxHeight(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets the maximum height of an output image in pixels.
- setImageMaxHeight(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Sets the maximum height of an output image in pixels.
- setImageMaxWidth(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets the maximum width of an output image in pixels.
- setImageMaxWidth(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Sets the maximum width of an output image in pixels.
- setImageQuality(int) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets the image quality for compressing the images in the PDF.
- setImageQuality(ImageQuality) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Sets the output image quality for image resources when rendering into HTML.
- setImageWidth(int) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets the width of the output image in pixels.
- setImageWidth(int) - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Sets the width of the output image in pixels.
- setInstance(CacheableFactory) - Static method in class com.groupdocs.viewer.caching.extra.CacheableFactory
-
Sets the instance of CacheableFactory to be used.
- setLayers(List<Layer>) - Method in class com.groupdocs.viewer.options.CadOptions
-
Gets the CAD drawing layers to render.
- setLayers(List<Layer>) - Method in interface com.groupdocs.viewer.results.CadViewInfo
-
Sets the list of layers in the CAD drawing.
- setLayoutName(String) - Method in class com.groupdocs.viewer.options.CadOptions
-
Sets the name of the specific layout to render.
- setLayouts(List<Layout>) - Method in interface com.groupdocs.viewer.results.CadViewInfo
-
Sets the list of layouts contained within the CAD drawing.
- setLeftMargin(double) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set left margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
- setLeftMargin(Double) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets the left page margin for HTML rendering.
- 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.
- setLicense(URL) - Method in class com.groupdocs.viewer.License
-
Licenses the component.
- setLinearize(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to optimize output PDF for online browsing with a web browser.
- setLines(List<Line>) - Method in interface com.groupdocs.viewer.results.Page
-
Sets the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.
- setLinkDuplicateStreams(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to link duplicate streams in the PDF.
- setLogger(ILogger) - Static method in class com.groupdocs.viewer.logging.ViewerLogger
-
Sets the logger instance that will be used for logging messages.
- setLogger(ILogger) - Method in class com.groupdocs.viewer.ViewerSettings
-
Sets the logger implementation used for logging (Errors, Warnings, Traces).
- setMailStorageOptions(MailStorageOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the Lotus Notes storage data files view options.
- setMaxCharsPerRow(int) - Method in class com.groupdocs.viewer.options.TextOptions
-
Sets the maximum number of characters per row on a page.
- setMaxHeight(int) - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
-
Sets the maximum height of an output image in pixels.
- setMaxHeight(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Sets the maximum height of an output image in pixels.
- setMaxHeight(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Sets the maximum height of an output image in pixels.
- setMaxHeight(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only).
- setMaxItems(int) - Method in class com.groupdocs.viewer.options.MailStorageOptions
-
Sets the maximum number of messages or items to render.
- setMaxItemsInFolder(int) - Method in class com.groupdocs.viewer.options.OutlookOptions
-
Sets the maximum number of messages or items that can be rendered from one folder.
- setMaxResolution(int) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets the maximum resolution for resizing the images in the PDF.
- setMaxRowsPerPage(int) - Method in class com.groupdocs.viewer.options.TextOptions
-
Sets the maximum number of rows per page.
- setMaxWidth(int) - Method in interface com.groupdocs.viewer.options.IMaxSizeOptions
-
Sets the maximum width of an output image in pixels.
- setMaxWidth(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Sets the maximum width of an output image in pixels.
- setMaxWidth(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Sets the maximum width of an output image in pixels.
- setMaxWidth(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only).
- setMeteredKey(String, String) - Method in class com.groupdocs.viewer.Metered
-
Activates the product with Metered keys.
- setMinify(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets whether HTML content and HTML resources minification is enabled.
- setName(String) - Method in interface com.groupdocs.viewer.results.Layer
-
Sets the name of the layer.
- setName(String) - Method in interface com.groupdocs.viewer.results.Layout
-
Sets the name of the layout.
- setName(String) - Method in interface com.groupdocs.viewer.results.Page
-
Sets the name of the worksheet or page.
- setNested(boolean) - Method in class com.groupdocs.viewer.results.Resource
-
Sets whether the resource resides inside another resource.
- setNotesCount(int) - Method in interface com.groupdocs.viewer.results.LotusNotesViewInfo
-
Sets the count of notes in the storage.
- setNumber(int) - Method in interface com.groupdocs.viewer.results.Page
-
Sets the page number.
- setOptimizeSpreadsheets(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to optimize the spreadsheets in the PDF.
- setOutlookOptions(OutlookOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the MS Outlook data files view options.
- setPages(List<Page>) - Method in interface com.groupdocs.viewer.results.ViewInfo
-
Sets the list of pages.
- setPageSize(PageSize) - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the size of the output page.
- setPageSize(PageSize) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Sets the output page size.
- setPageSize(PageSize) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets the page size for rendering HTM and HTML files.
- setPassword(String) - Method in class com.groupdocs.viewer.options.LoadOptions
-
Sets the password for opening an encrypted file.
- setPc3File(String) - Method in class com.groupdocs.viewer.options.CadOptions
-
Sets the PC3 (Plotter Configuration) file associated with the plotter.
- setPdfOptimizationOptions(PdfOptimizationOptions) - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Reduce output PDF file size applying optimization techniques with different options.
- setPdfOptions(PdfOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Retrieves the PDF documents view options.
- setPermissions(int) - Method in class com.groupdocs.viewer.options.Security
-
Sets the PDF document permissions such as printing, modification, and data extraction.
- setPermissionsPassword(String) - Method in class com.groupdocs.viewer.options.Security
-
Sets the password required to change permission settings.
- setPosition(Position) - Method in class com.groupdocs.viewer.options.Watermark
-
Sets the watermark position.
- setPresentationOptions(PresentationOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the view options for processing presentation documents.
- setPrintingAllowed(boolean) - Method in interface com.groupdocs.viewer.results.PdfViewInfo
-
Sets whether printing of the document is allowed.
- setProjectManagementOptions(ProjectManagementOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the project management files view options.
- setQuality(byte) - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Sets the quality of the output image.
- setRemoveAnnotations(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to remove unnecessary annotations from the PDF.
- setRemoveComments(boolean) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Disables rendering comments when set to true.
- setRemoveFormFields(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to remove form fields from the PDF.
- setRemoveJavaScript(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets permission to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts.
- setRemovePrivateInfo(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to remove private information from the PDF.
- setRemoveUnusedObjects(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to remove unused objects from the PDF.
- setRemoveUnusedStreams(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to remove unused streams from the PDF.
- setRenderByPageBreaks(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Sets whether the worksheet should 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
-
Sets the flag to render only Visio figures, excluding the diagram.
- setRenderGridLines(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Enables or disables the rendering of grid lines.
- 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
-
Sets whether hidden rows should be rendered.
- setRenderingPrintAreaAndPageBreaks(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Sets whether to render a worksheet by page breaks that fall within the print area.
- setRenderLayouts(boolean) - Method in class com.groupdocs.viewer.options.CadOptions
-
Sets whether layouts from the 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
-
Enables rendering of pages with the same size in pixels as the page size in the source PDF document.
- setRenderResponsive(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Sets whether responsive rendering is enabled.
- setRenderTextAsImage(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Sets whether the text from the source is rendered as an image in HTML.
- setRenderToSinglePage(boolean) - Method in class com.groupdocs.viewer.options.HtmlViewOptions
-
Enables rendering an entire document to one HTML file.
- setRenderTrackedChanges(boolean) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets whether tracked changes (revisions) rendering is enabled.
- setResizeImages(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to resize the images in the PDF.
- setResourceLoadingTimeout(int) - Method in class com.groupdocs.viewer.options.LoadOptions
-
Sets the timeout for loading external resources, such as graphics.
- setRightMargin(double) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set right margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
If the parameter is less than 0, then the default value is used.
- setRightMargin(Double) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets the right page margin for HTML rendering.
- setSecurity(Security) - Method in class com.groupdocs.viewer.options.PdfViewOptions
-
Sets the security options for the output PDF document.
- setSize(Size) - Method in class com.groupdocs.viewer.options.Watermark
-
Sets the watermark size.
- setSize(long) - Method in interface com.groupdocs.viewer.results.Attachment
-
Sets the file size of the attachment in bytes.
- setSkipEmptyColumns(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Sets whether empty columns should be skipped during rendering.
- setSkipEmptyRows(boolean) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Sets whether empty rows should be skipped during rendering.
- setSkipExternalResources(boolean) - Method in class com.groupdocs.viewer.options.LoadOptions
-
- setSpreadsheetOptions(SpreadsheetOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the spreadsheet files view options.
- setStartDate(Date) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Sets the start date of the Gantt Chart View to be included in the output.
- setStartDate(Date) - Method in interface com.groupdocs.viewer.results.ProjectManagementViewInfo
-
Sets the start date and time for the project.
- setSubsetFonts(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to subset the fonts in the PDF.
- 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
-
Gets the keywords used to filter messages.
- setTextOptions(TextOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the options for splitting text files into pages.
- setTextOverflowMode(TextOverflowMode) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
Sets the text overflow mode for rendering spreadsheet documents into HTML.
- setTiles(List<Tile>) - Method in class com.groupdocs.viewer.options.CadOptions
-
Sets the drawing regions to render.
- setTimeUnit(TimeUnit) - Method in class com.groupdocs.viewer.options.ProjectManagementOptions
-
Retrieves the time unit.
- setTimeZoneOffset(TimeZone) - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the time zone offset for the message.
- setTimeZoneOffset(int) - Method in class com.groupdocs.viewer.options.EmailOptions
-
Gets the time zone offset minutes offset for the message.
- SETTINGS - Static variable in class com.groupdocs.viewer.Viewer
-
- setTopMargin(double) - Method in class com.groupdocs.viewer.options.SpreadsheetOptions
-
To set top margin of the worksheet when converting to pdf
if less than 0 then default convert value is used
If the parameter is less than 0, then the default value is used.
- setTopMargin(Double) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets the top page margin for HTML rendering.
- setTryRepair(boolean) - Method in class com.groupdocs.viewer.options.LoadOptions
-
When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents.
- setUnembedFonts(boolean) - Method in class com.groupdocs.viewer.options.PdfOptimizationOptions
-
Sets whether to unembed the embedded fonts in the PDF.
- setUnlinkTableOfContents(boolean) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets whether table of contents navigation should be disabled when rendering to HTML or PDF.
- setUpdateFields(boolean) - Method in class com.groupdocs.viewer.options.WordProcessingOptions
-
Sets a value determining if fields of certain types should be updated before saving the input WordProcessing
document to the HTML, PDF, PNG, or JPEG output formats.
- setUrlConnectTimeout(int) - Method in class com.groupdocs.viewer.options.LoadOptions
-
Sets the connection timeout for creating a
Viewer using
URL to load a document.
- setUrlReadTimeout(int) - Method in class com.groupdocs.viewer.options.LoadOptions
-
Sets the read timeout for creating a
Viewer using
URL to load a document.
- setValue(T) - Method in interface com.groupdocs.viewer.results.TextElement
-
Sets the value of the text element.
- setVisible(boolean) - Method in interface com.groupdocs.viewer.results.Layer
-
Sets the visibility of the layer.
- setVisible(boolean) - Method in interface com.groupdocs.viewer.results.Page
-
Sets the page visibility indicator.
- setVisioRenderingOptions(VisioRenderingOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the rendering options for processing Visio files when viewing documents.
- setWatermark(Watermark) - Method in class com.groupdocs.viewer.options.ViewOptions
-
Sets the text watermark to be applied to each page.
- setWebDocumentOptions(WebDocumentOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG
when rendering Web documents.
- setWhitelistedResources(List<String>) - Method in class com.groupdocs.viewer.options.LoadOptions
-
- setWidth(int) - Method in class com.groupdocs.viewer.options.JpgViewOptions
-
Sets the width of the output image in pixels.
- setWidth(int) - Method in class com.groupdocs.viewer.options.PngViewOptions
-
Sets the width of the output image in pixels.
- setWidth(int) - Method in class com.groupdocs.viewer.options.ViewInfoOptions
-
The width of the output image (in pixels, for rendering to PNG/JPG only).
- setWidth(double) - Method in interface com.groupdocs.viewer.results.Layout
-
Sets the width of the layout.
- setWidth(int) - Method in interface com.groupdocs.viewer.results.Page
-
Sets the width of the page in pixels when viewing as JPG or PNG.
- setWidth(double) - Method in interface com.groupdocs.viewer.results.TextElement
-
Sets the width of the rectangle that contains the element (in pixels).
- setWordProcessingOptions(WordProcessingOptions) - Method in class com.groupdocs.viewer.options.BaseViewOptions
-
The Word processing files view options.
- setWords(List<Word>) - Method in interface com.groupdocs.viewer.results.Line
-
Sets the words contained in the line.
- setWrapImagesInSvg(boolean) - Method in class com.groupdocs.viewer.options.PdfOptions
-
Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality.
- setX(double) - Method in interface com.groupdocs.viewer.results.TextElement
-
Sets the X coordinate of the highest left point on the page layout where the rectangle that contains the element begins.
- setY(double) - Method in interface com.groupdocs.viewer.results.TextElement
-
Sets the Y coordinate of the highest left point on the page layout where the rectangle that contains the element begins.
- Size - Class in com.groupdocs.viewer.options
-
Contains the watermark size.
- Size(byte) - Constructor for class com.groupdocs.viewer.options.Size
-
Initializes a new instance of the Size class.
- SOURCE - Static variable in class com.groupdocs.viewer.options.FileName
-
Represents the name of the source file.
- SpreadsheetOptions - Class in com.groupdocs.viewer.options
-
Provides options for rendering spreadsheets.
- SVG - Static variable in class com.groupdocs.viewer.drawing.Image2DFormat
-
- 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 a view of all document pages.
- view(ViewOptions, int...) - Method in class com.groupdocs.viewer.Viewer
-
Creates a view of specific document pages.
- Viewer - Class in com.groupdocs.viewer
-
Represents the main class that controls the document rendering process.
- Viewer(InputStream) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(InputStream, boolean) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(InputStream, LoadOptions) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(InputStream, LoadOptions, boolean) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(InputStream, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(InputStream, ViewerSettings, boolean) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(InputStream, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(InputStream, LoadOptions, ViewerSettings, boolean) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes new instance of Viewer class.
- Viewer(URL) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(URL, LoadOptions) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(URL, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(URL, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(FileReader, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(FileReader, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(String) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(Path) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(String, LoadOptions) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(Path, LoadOptions) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(String, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(Path, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(String, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- Viewer(Path, LoadOptions, ViewerSettings) - Constructor for class com.groupdocs.viewer.Viewer
-
Initializes a new instance of the Viewer class.
- ViewerLogger - Class in com.groupdocs.viewer.logging
-
Global viewer logger.
- ViewerLogger() - Constructor for class com.groupdocs.viewer.logging.ViewerLogger
-
- ViewerSettings - Class in com.groupdocs.viewer
-
Defines settings for customizing the behavior of the Viewer component.
- ViewerSettings(Cache, ILogger) - Constructor for class com.groupdocs.viewer.ViewerSettings
-
Initializes a new instance of the ViewerSettings class.
- ViewerSettings(ILogger) - Constructor for class com.groupdocs.viewer.ViewerSettings
-
Initializes a new instance of the ViewerSettings class.
- ViewerSettings(Cache) - Constructor for class com.groupdocs.viewer.ViewerSettings
-
Initializes a new instance of the ViewerSettings class.
- ViewerSettings() - Constructor for class com.groupdocs.viewer.ViewerSettings
-
Initializes a new instance of the ViewerSettings class.
- ViewInfo - Interface in com.groupdocs.viewer.results
-
Represents view information for a generic document.
- ViewInfoOptions - Class in com.groupdocs.viewer.options
-
Provides options used for retrieving information about view.
- ViewOptions - Class in com.groupdocs.viewer.options
-
Contains the rendering options.
- ViewOptions() - Constructor for class com.groupdocs.viewer.options.ViewOptions
-
- VisioRenderingOptions - Class in com.groupdocs.viewer.options
-
Contains options for rendering Visio documents.
- VisioRenderingOptions() - Constructor for class com.groupdocs.viewer.options.VisioRenderingOptions
-
Initializes a new instance of the VisioRenderingOptions class.