From 0cf7e692621661fded33d1d04ef07a378cdbd8e0 Mon Sep 17 00:00:00 2001 From: yevgen-nykytenko Date: Fri, 14 Jul 2023 07:36:22 -0500 Subject: [PATCH] Update content 2023-07-14 07:36:22 --- english/java/_index.md | 16 +- .../_index.md | 9 +- .../cacheablefactory/_index.md | 369 +++--- .../com.groupdocs.viewer.caching/_index.md | 20 +- .../cache/_index.md | 46 +- .../cachekeys/_index.md | 74 +- .../filecache/_index.md | 94 +- .../com.groupdocs.viewer.exception/_index.md | 27 +- .../archivesecurityexception/_index.md | 8 +- .../filenotfoundexception/_index.md | 34 +- .../groupdocsviewerexception/_index.md | 22 +- .../incorrectpasswordexception/_index.md | 12 +- .../notsupportedexception/_index.md | 14 +- .../passwordrequiredexception/_index.md | 12 +- .../java/com.groupdocs.viewer.fonts/_index.md | 17 +- .../folderfontsource/_index.md | 80 +- .../fontsettings/_index.md | 20 +- .../fontsource/_index.md | 4 + .../searchoption/_index.md | 12 + .../com.groupdocs.viewer.interfaces/_index.md | 39 +- .../createfilestream/_index.md | 23 +- .../createpagestream/_index.md | 23 +- .../createresourcestream/_index.md | 24 +- .../createresourceurl/_index.md | 23 +- .../filereader/_index.md | 33 +- .../filestreamfactory/_index.md | 39 +- .../pagestreamfactory/_index.md | 34 +- .../releasefilestream/_index.md | 25 +- .../releasepagestream/_index.md | 27 +- .../releaseresourcestream/_index.md | 29 +- .../resourcestreamfactory/_index.md | 58 +- .../com.groupdocs.viewer.logging/_index.md | 20 +- .../filelogger/_index.md | 136 ++- .../viewerlogger/_index.md | 131 +- .../com.groupdocs.viewer.options/_index.md | 21 +- .../archiveoptions/_index.md | 65 +- .../archivesecurityoptions/_index.md | 92 +- .../baseviewoptions/_index.md | 228 ++-- .../cadoptions/_index.md | 203 +-- .../emailoptions/_index.md | 108 +- .../field/_index.md | 215 ++-- .../filename/_index.md | 41 +- .../htmlviewoptions/_index.md | 278 +++-- .../imagequality/_index.md | 23 +- .../imaxsizeoptions/_index.md | 26 +- .../jpgviewoptions/_index.md | 159 +-- .../loadoptions/_index.md | 135 +- .../mailstorageoptions/_index.md | 60 +- .../outlookoptions/_index.md | 76 +- .../pagesize/_index.md | 47 +- .../pdfoptions/_index.md | 135 +- .../pdfviewoptions/_index.md | 148 ++- .../permissions/_index.md | 35 +- .../pngviewoptions/_index.md | 147 ++- .../position/_index.md | 35 +- .../projectmanagementoptions/_index.md | 82 +- .../rotation/_index.md | 24 +- .../security/_index.md | 64 +- .../size/_index.md | 45 +- .../spreadsheetoptions/_index.md | 190 +-- .../textoptions/_index.md | 54 +- .../textoverflowmode/_index.md | 30 +- .../tile/_index.md | 54 +- .../timeunit/_index.md | 33 +- .../viewinfooptions/_index.md | 143 +-- .../viewoptions/_index.md | 36 +- .../visiorenderingoptions/_index.md | 47 +- .../watermark/_index.md | 91 +- .../wordprocessingoptions/_index.md | 129 +- .../com.groupdocs.viewer.results/_index.md | 49 +- .../archiveviewinfo/_index.md | 26 +- .../attachment/_index.md | 50 +- .../cadviewinfo/_index.md | 32 +- .../character/_index.md | 22 +- .../fileinfo/_index.md | 38 +- .../layer/_index.md | 46 +- .../layout/_index.md | 48 +- .../line/_index.md | 28 +- .../lotusnotesviewinfo/_index.md | 25 +- .../outlookviewinfo/_index.md | 25 +- .../page/_index.md | 58 +- .../pdfviewinfo/_index.md | 25 +- .../projectmanagementviewinfo/_index.md | 31 +- .../resource/_index.md | 41 +- .../textelement/_index.md | 38 +- .../viewinfo/_index.md | 35 +- .../word/_index.md | 28 +- .../java/com.groupdocs.viewer.utils/_index.md | 20 +- .../memorycleaner/_index.md | 54 +- .../pathutils/_index.md | 15 +- english/java/com.groupdocs.viewer/_index.md | 25 +- .../com.groupdocs.viewer/filetype/_index.md | 1087 ++++++++++------- .../com.groupdocs.viewer/license/_index.md | 47 +- .../com.groupdocs.viewer/metered/_index.md | 61 +- .../com.groupdocs.viewer/viewer/_index.md | 313 ++--- .../viewersettings/_index.md | 75 +- 96 files changed, 4488 insertions(+), 2707 deletions(-) diff --git a/english/java/_index.md b/english/java/_index.md index 2b2571266..44d46e5ad 100644 --- a/english/java/_index.md +++ b/english/java/_index.md @@ -10,13 +10,13 @@ is_root: true ## Packages | Package | Description | | --- | --- | -| [com.groupdocs.viewer](./com.groupdocs.viewer) | The package provides classes for rendering documents in HTML5, Image or PDF modes fast and with high quality. | -| [com.groupdocs.viewer.caching](./com.groupdocs.viewer.caching) | The package provides classes for customizing caching behaviour. | +| [com.groupdocs.viewer](./com.groupdocs.viewer) | The package provides classes for rendering documents in HTML5, Image, or PDF modes with fast and high-quality results. | +| [com.groupdocs.viewer.caching](./com.groupdocs.viewer.caching) | The package provides classes for customizing caching behavior. | | [com.groupdocs.viewer.caching.extra](./com.groupdocs.viewer.caching.extra) | The package provides functionality for using custom models in cache implementation. | -| [com.groupdocs.viewer.exception](./com.groupdocs.viewer.exception) | The package provides classes for exceptions which can occur while working with a document. | -| [com.groupdocs.viewer.fonts](./com.groupdocs.viewer.fonts) | The package provides classes classes and enumerations to manage fonts used during rendering process. | -| [com.groupdocs.viewer.interfaces](./com.groupdocs.viewer.interfaces) | The package provides interfaces to instantiate and release output document and it's resources. | -| [com.groupdocs.viewer.logging](./com.groupdocs.viewer.logging) | The package provides classes for configuring logging system. | +| [com.groupdocs.viewer.exception](./com.groupdocs.viewer.exception) | The package provides classes for exceptions that can occur while working with a document. | +| [com.groupdocs.viewer.fonts](./com.groupdocs.viewer.fonts) | The package provides classes and enumerations to manage fonts used during the rendering process. | +| [com.groupdocs.viewer.interfaces](./com.groupdocs.viewer.interfaces) | The package provides interfaces for instantiating and releasing the output document and its resources. | +| [com.groupdocs.viewer.logging](./com.groupdocs.viewer.logging) | The package provides classes for configuring the logging system in GroupDocs.Viewer. | | [com.groupdocs.viewer.options](./com.groupdocs.viewer.options) | The package provides classes to specify additional options when rendering documents. | -| [com.groupdocs.viewer.results](./com.groupdocs.viewer.results) | The package provides classes which represent document rendering results. | -| [com.groupdocs.viewer.utils](./com.groupdocs.viewer.utils) | The package provides helpers and utils classes. | +| [com.groupdocs.viewer.results](./com.groupdocs.viewer.results) | The package provides classes and interfaces that represent document rendering results. | +| [com.groupdocs.viewer.utils](./com.groupdocs.viewer.utils) | The package provides helper and utility classes for various functionalities. | diff --git a/english/java/com.groupdocs.viewer.caching.extra/_index.md b/english/java/com.groupdocs.viewer.caching.extra/_index.md index 641566d56..39902a71a 100644 --- a/english/java/com.groupdocs.viewer.caching.extra/_index.md +++ b/english/java/com.groupdocs.viewer.caching.extra/_index.md @@ -9,9 +9,16 @@ url: /java/com.groupdocs.viewer.caching.extra/ The package provides functionality for using custom models in cache implementation. +The main class in this package is [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory), which helps in customizing the cache by providing additional functionality. + +For more details on using custom models in cache implementation in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ + ## Classes | Class | Description | | --- | --- | -| [CacheableFactory](../com.groupdocs.viewer.caching.extra/cacheablefactory) | This class helps customising [Cache](../com.groupdocs.viewer.caching/cache). | +| [CacheableFactory](../com.groupdocs.viewer.caching.extra/cacheablefactory) | This class helps customize [Cache](../com.groupdocs.viewer.caching/cache). | diff --git a/english/java/com.groupdocs.viewer.caching.extra/cacheablefactory/_index.md b/english/java/com.groupdocs.viewer.caching.extra/cacheablefactory/_index.md index 9b30761bb..3cb32ecca 100644 --- a/english/java/com.groupdocs.viewer.caching.extra/cacheablefactory/_index.md +++ b/english/java/com.groupdocs.viewer.caching.extra/cacheablefactory/_index.md @@ -1,7 +1,7 @@ --- title: CacheableFactory second_title: GroupDocs.Viewer for Java API Reference -description: This class helps customising . +description: This class helps customize . type: docs weight: 10 url: /java/com.groupdocs.viewer.caching.extra/cacheablefactory/ @@ -12,10 +12,23 @@ java.lang.Object public class CacheableFactory ``` -This class helps customising [Cache](../../com.groupdocs.viewer.caching/cache). You can implement your custom models for serialization and override methods in this class for return them instead of embedded ones. Just extend CacheableFactory and call: CacheableFactory.setInstance(new YourCustomCacheableFactory()) . More details in [documentation][] +This class helps customize [Cache](../../com.groupdocs.viewer.caching/cache). +Custom models for serialization can be implemented by overriding methods in this class to return them instead of the embedded ones. To achieve this, extend CacheableFactory and activate it passing new instance of custom factory to [setInstance(CacheableFactory)](../../com.groupdocs.viewer.caching.extra/cacheablefactory\#setInstance-CacheableFactory-) method. -[documentation]: https://docs.groupdocs.com/viewer/java/getting-started/ +Example usage: + +``` + + CacheableFactory.setInstance(new YourCustomCacheableFactory()); + // Custom cacheable factory is now in use. You can start rendering documents. + +``` + +For more details, guidelines, and examples on customizing the cache, please refer to the [GroupDocs.Viewer documentation][]. + + +[GroupDocs.Viewer documentation]: https://docs.groupdocs.com/viewer/java/getting-started/ ## Constructors | Constructor | Description | @@ -25,34 +38,34 @@ This class helps customising [Cache](../../com.groupdocs.viewer.caching/cache). | Method | Description | | --- | --- | -| [getInstance()](#getInstance--) | Gets instance of [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) | -| [setInstance(CacheableFactory instance)](#setInstance-com.groupdocs.viewer.caching.extra.CacheableFactory-) | Sets instance of [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) | -| [newViewInfo(FileType fileType, List pages)](#newViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--) | Creates implementation of [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) interface | -| [newLotusNotesViewInfo(FileType fileType, List pages, int notesCount)](#newLotusNotesViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--int-) | Creates implementation of [LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) interface | -| [newArchiveViewInfo(FileType fileType, List pages, List folders)](#newArchiveViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-java.lang.String--) | Creates implementation of ArchiveViewInfo interface | -| [newCharacter(char character, double x, double y, double width, double height)](#newCharacter-char-double-double-double-double-) | Creates implementation of LotusNotesViewInfo interface | -| [newFileInfo(FileType fileType)](#newFileInfo-com.groupdocs.viewer.FileType-) | Creates implementation of LotusNotesViewInfo interface | -| [newLayer(String name, boolean visible)](#newLayer-java.lang.String-boolean-) | Creates implementation of LotusNotesViewInfo interface | -| [newLayer(String name)](#newLayer-java.lang.String-) | Creates implementation of LotusNotesViewInfo interface | -| [newLayout(String name, double width, double height)](#newLayout-java.lang.String-double-double-) | Creates implementation of LotusNotesViewInfo interface | -| [newLine(String line, double x, double y, double width, double height, List words)](#newLine-java.lang.String-double-double-double-double-java.util.List-com.groupdocs.viewer.results.Word--) | Creates implementation of Line interface | -| [newAttachment(String fileName, String filePath)](#newAttachment-java.lang.String-java.lang.String-) | Creates implementation of LotusNotesViewInfo interface | -| [newAttachment(String id, String fileName, String filePath, long size)](#newAttachment-java.lang.String-java.lang.String-java.lang.String-long-) | Creates implementation of LotusNotesViewInfo interface | -| [newAttachment(String id, String fileName, Path filePath, long size)](#newAttachment-java.lang.String-java.lang.String-java.nio.file.Path-long-) | Creates implementation of LotusNotesViewInfo interface | -| [newAttachment(String id, String fileName, String filePath, FileType fileType, long size)](#newAttachment-java.lang.String-java.lang.String-java.lang.String-com.groupdocs.viewer.FileType-long-) | Creates implementation of LotusNotesViewInfo interface | -| [newOutlookViewInfo(FileType fileType, List pages, List folders)](#newOutlookViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-java.lang.String--) | Creates implementation of LotusNotesViewInfo interface | -| [newPage(int number, boolean visible)](#newPage-int-boolean-) | Creates implementation of LotusNotesViewInfo interface | -| [newPage(int number, String name, boolean visible)](#newPage-int-java.lang.String-boolean-) | Creates implementation of LotusNotesViewInfo interface | -| [newPage(int number, String name, boolean visible, int width, int height)](#newPage-int-java.lang.String-boolean-int-int-) | Creates implementation of LotusNotesViewInfo interface | -| [newPage(int number, boolean visible, int width, int height)](#newPage-int-boolean-int-int-) | Creates implementation of LotusNotesViewInfo interface | -| [newPage(int number, String name, boolean visible, int width, int height, List lines)](#newPage-int-java.lang.String-boolean-int-int-java.util.List-com.groupdocs.viewer.results.Line--) | Creates implementation of LotusNotesViewInfo interface | -| [newPage(int number, boolean visible, int width, int height, List lines)](#newPage-int-boolean-int-int-java.util.List-com.groupdocs.viewer.results.Line--) | Creates implementation of LotusNotesViewInfo interface | -| [newPdfViewInfo(FileType fileType, List pages, boolean printingAllowed)](#newPdfViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--boolean-) | Creates implementation of LotusNotesViewInfo interface | -| [newCadViewInfo(FileType fileType, List pages, List layers, List layouts)](#newCadViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-com.groupdocs.viewer.results.Layer--java.util.List-com.groupdocs.viewer.results.Layout--) | Creates implementation of LotusNotesViewInfo interface | -| [newProjectManagementViewInfo(FileType fileType, List pages, Date startDate, Date endDate)](#newProjectManagementViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.Date-java.util.Date-) | Creates implementation of LotusNotesViewInfo interface | -| [newTextElement(T value, double x, double y, double width, double height)](#-T-newTextElement-T-double-double-double-double-) | Creates implementation of TextElement interface | -| [newMboxViewInfo(FileType fileType, List pages, int notesCount)](#newMboxViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--int-) | Creates implementation of TextElement interface | -| [newWord(String word, double x, double y, double width, double height, List characters)](#newWord-java.lang.String-double-double-double-double-java.util.List-com.groupdocs.viewer.results.Character--) | Creates implementation of LotusNotesViewInfo interface | +| [getInstance()](#getInstance--) | Gets an instance of CacheableFactory that can be used to create cacheable objects. | +| [setInstance(CacheableFactory instance)](#setInstance-com.groupdocs.viewer.caching.extra.CacheableFactory-) | Sets the instance of CacheableFactory to be used. | +| [newViewInfo(FileType fileType, List pages)](#newViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--) | Creates an implementation of the [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) interface for the specified file type and pages. | +| [newLotusNotesViewInfo(FileType fileType, List pages, int notesCount)](#newLotusNotesViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--int-) | Creates an implementation of the [LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) interface for the specified file type, pages, and notes count. | +| [newArchiveViewInfo(FileType fileType, List pages, List folders)](#newArchiveViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-java.lang.String--) | Creates an implementation of the [ArchiveViewInfo](../../com.groupdocs.viewer.results/archiveviewinfo) interface for the specified file type, pages, and folders. | +| [newCharacter(char character, double x, double y, double width, double height)](#newCharacter-char-double-double-double-double-) | Creates an implementation of the [Character](../../com.groupdocs.viewer.results/character) interface for the specified character, position, and dimensions. | +| [newFileInfo(FileType fileType)](#newFileInfo-com.groupdocs.viewer.FileType-) | Creates an implementation of the [FileInfo](../../com.groupdocs.viewer.results/fileinfo) interface for the specified file type. | +| [newLayer(String name, boolean visible)](#newLayer-java.lang.String-boolean-) | Creates an implementation of the [Layer](../../com.groupdocs.viewer.results/layer) interface with the specified name and visibility. | +| [newLayer(String name)](#newLayer-java.lang.String-) | Creates an implementation of the [Layer](../../com.groupdocs.viewer.results/layer) interface with the specified name. | +| [newLayout(String name, double width, double height)](#newLayout-java.lang.String-double-double-) | Creates an implementation of the [Layout](../../com.groupdocs.viewer.results/layout) interface with the specified name, width, and height. | +| [newLine(String line, double x, double y, double width, double height, List words)](#newLine-java.lang.String-double-double-double-double-java.util.List-com.groupdocs.viewer.results.Word--) | Creates an implementation of the [Line](../../com.groupdocs.viewer.results/line) interface with the specified line, position, dimensions, and words. | +| [newAttachment(String fileName, String filePath)](#newAttachment-java.lang.String-java.lang.String-) | Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. | +| [newAttachment(String id, String fileName, String filePath, long size)](#newAttachment-java.lang.String-java.lang.String-java.lang.String-long-) | Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. | +| [newAttachment(String id, String fileName, Path filePath, long size)](#newAttachment-java.lang.String-java.lang.String-java.nio.file.Path-long-) | Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. | +| [newAttachment(String id, String fileName, String filePath, FileType fileType, long size)](#newAttachment-java.lang.String-java.lang.String-java.lang.String-com.groupdocs.viewer.FileType-long-) | Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. | +| [newOutlookViewInfo(FileType fileType, List pages, List folders)](#newOutlookViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-java.lang.String--) | Creates an implementation of the [OutlookViewInfo](../../com.groupdocs.viewer.results/outlookviewinfo) interface based on the specified file type, list of pages, and list of folders. | +| [newPage(int number, boolean visible)](#newPage-int-boolean-) | Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number and visibility. | +| [newPage(int number, String name, boolean visible)](#newPage-int-java.lang.String-boolean-) | Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, name, and visibility. | +| [newPage(int number, String name, boolean visible, int width, int height)](#newPage-int-java.lang.String-boolean-int-int-) | Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, name, visibility, width, and height. | +| [newPage(int number, boolean visible, int width, int height)](#newPage-int-boolean-int-int-) | Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, visibility, width, and height. | +| [newPage(int number, String name, boolean visible, int width, int height, List lines)](#newPage-int-java.lang.String-boolean-int-int-java.util.List-com.groupdocs.viewer.results.Line--) | Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, name, visibility, width, height, and lines. | +| [newPage(int number, boolean visible, int width, int height, List lines)](#newPage-int-boolean-int-int-java.util.List-com.groupdocs.viewer.results.Line--) | Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, visibility, width, height, and lines. | +| [newPdfViewInfo(FileType fileType, List pages, boolean printingAllowed)](#newPdfViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--boolean-) | Creates an implementation of the [PdfViewInfo](../../com.groupdocs.viewer.results/pdfviewinfo) interface with the specified file type, pages, and printing allowed flag. | +| [newCadViewInfo(FileType fileType, List pages, List layers, List layouts)](#newCadViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-com.groupdocs.viewer.results.Layer--java.util.List-com.groupdocs.viewer.results.Layout--) | Creates an implementation of the [CadViewInfo](../../com.groupdocs.viewer.results/cadviewinfo) interface with the specified file type, pages, layers, and layouts. | +| [newProjectManagementViewInfo(FileType fileType, List pages, Date startDate, Date endDate)](#newProjectManagementViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.Date-java.util.Date-) | Creates an implementation of the [ProjectManagementViewInfo](../../com.groupdocs.viewer.results/projectmanagementviewinfo) interface with the specified file type, pages, start date, and end date. | +| [newTextElement(T value, double x, double y, double width, double height)](#-T-newTextElement-T-double-double-double-double-) | Creates an implementation of the [TextElement](../../com.groupdocs.viewer.results/textelement) interface with the specified value, coordinates, and dimensions. | +| [newMboxViewInfo(FileType fileType, List pages, int notesCount)](#newMboxViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--int-) | Creates an implementation of the MboxViewInfo interface with the specified file type, pages, and notes count. | +| [newWord(String word, double x, double y, double width, double height, List characters)](#newWord-java.lang.String-double-double-double-double-java.util.List-com.groupdocs.viewer.results.Character--) | Creates an implementation of the [Word](../../com.groupdocs.viewer.results/word) interface with the specified word, coordinates, dimensions, and characters. | ### CacheableFactory() {#CacheableFactory--} ``` public CacheableFactory() @@ -65,22 +78,22 @@ public static CacheableFactory getInstance() ``` -Gets instance of [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) +Gets an instance of CacheableFactory that can be used to create cacheable objects. **Returns:** -[CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) - instance of [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) +[CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) - an instance of CacheableFactory . ### setInstance(CacheableFactory instance) {#setInstance-com.groupdocs.viewer.caching.extra.CacheableFactory-} ``` public static void setInstance(CacheableFactory instance) ``` -Sets instance of [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) +Sets the instance of CacheableFactory to be used. This allows custom implementation of the cacheable factory. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| instance | [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) | instance of [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) | +| instance | [CacheableFactory](../../com.groupdocs.viewer.caching.extra/cacheablefactory) | The instance of CacheableFactory to set. | ### newViewInfo(FileType fileType, List pages) {#newViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--} ``` @@ -88,428 +101,428 @@ public ViewInfo newViewInfo(FileType fileType, List pages) ``` -Creates implementation of [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) interface +Creates an implementation of the [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) interface for the specified file type and pages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| pages | java.util.List | pages | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | +| pages | java.util.List | The list of pages representing the document pages. | **Returns:** -[ViewInfo](../../com.groupdocs.viewer.results/viewinfo) - new instance of [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) implementation +[ViewInfo](../../com.groupdocs.viewer.results/viewinfo) - a new instance of the [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) implementation. ### newLotusNotesViewInfo(FileType fileType, List pages, int notesCount) {#newLotusNotesViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--int-} ``` public LotusNotesViewInfo newLotusNotesViewInfo(FileType fileType, List pages, int notesCount) ``` -Creates implementation of [LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) interface +Creates an implementation of the [LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) interface for the specified file type, pages, and notes count. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| pages | java.util.List | pages | -| notesCount | int | nodes count | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | +| pages | java.util.List | The list of pages representing the document pages. | +| notesCount | int | The count of Lotus Notes in the document. | **Returns:** -[LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) - new instance of [LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) implementation +[LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) - a new instance of the [LotusNotesViewInfo](../../com.groupdocs.viewer.results/lotusnotesviewinfo) implementation. ### newArchiveViewInfo(FileType fileType, List pages, List folders) {#newArchiveViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-java.lang.String--} ``` public ArchiveViewInfo newArchiveViewInfo(FileType fileType, List pages, List folders) ``` -Creates implementation of ArchiveViewInfo interface +Creates an implementation of the [ArchiveViewInfo](../../com.groupdocs.viewer.results/archiveviewinfo) interface for the specified file type, pages, and folders. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| pages | java.util.List | pages | -| folders | java.util.List | folders | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | +| pages | java.util.List | The list of pages representing the document pages. | +| folders | java.util.List | The list of folders in the archive. | **Returns:** -[ArchiveViewInfo](../../com.groupdocs.viewer.results/archiveviewinfo) - new instance of [ArchiveViewInfo](../../com.groupdocs.viewer.results/archiveviewinfo) implementation +[ArchiveViewInfo](../../com.groupdocs.viewer.results/archiveviewinfo) - a new instance of the [ArchiveViewInfo](../../com.groupdocs.viewer.results/archiveviewinfo) implementation. ### newCharacter(char character, double x, double y, double width, double height) {#newCharacter-char-double-double-double-double-} ``` public Character newCharacter(char character, double x, double y, double width, double height) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Character](../../com.groupdocs.viewer.results/character) interface for the specified character, position, and dimensions. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| character | char | character | -| x | double | x | -| y | double | y | -| width | double | width | -| height | double | height | +| character | char | The character. | +| x | double | The x-coordinate of the character position. | +| y | double | The y-coordinate of the character position. | +| width | double | The width of the character. | +| height | double | The height of the character. | **Returns:** -[Character](../../com.groupdocs.viewer.results/character) - new instance of [Character](../../com.groupdocs.viewer.results/character) implementation +[Character](../../com.groupdocs.viewer.results/character) - a new instance of the [Character](../../com.groupdocs.viewer.results/character) implementation. ### newFileInfo(FileType fileType) {#newFileInfo-com.groupdocs.viewer.FileType-} ``` public FileInfo newFileInfo(FileType fileType) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [FileInfo](../../com.groupdocs.viewer.results/fileinfo) interface for the specified file type. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | **Returns:** -[FileInfo](../../com.groupdocs.viewer.results/fileinfo) - new instance of [FileInfo](../../com.groupdocs.viewer.results/fileinfo) implementation +[FileInfo](../../com.groupdocs.viewer.results/fileinfo) - a new instance of the [FileInfo](../../com.groupdocs.viewer.results/fileinfo) implementation. ### newLayer(String name, boolean visible) {#newLayer-java.lang.String-boolean-} ``` public Layer newLayer(String name, boolean visible) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Layer](../../com.groupdocs.viewer.results/layer) interface with the specified name and visibility. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| name | java.lang.String | name | -| visible | boolean | visibility | +| name | java.lang.String | The name of the layer. | +| visible | boolean | The visibility of the layer. | **Returns:** -[Layer](../../com.groupdocs.viewer.results/layer) - new instance of [Layer](../../com.groupdocs.viewer.results/layer) implementation +[Layer](../../com.groupdocs.viewer.results/layer) - a new instance of the [Layer](../../com.groupdocs.viewer.results/layer) implementation. ### newLayer(String name) {#newLayer-java.lang.String-} ``` public Layer newLayer(String name) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Layer](../../com.groupdocs.viewer.results/layer) interface with the specified name. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| name | java.lang.String | name | +| name | java.lang.String | The name of the layer. | **Returns:** -[Layer](../../com.groupdocs.viewer.results/layer) - new instance of [Layer](../../com.groupdocs.viewer.results/layer) implementation +[Layer](../../com.groupdocs.viewer.results/layer) - a new instance of the [Layer](../../com.groupdocs.viewer.results/layer) implementation. ### newLayout(String name, double width, double height) {#newLayout-java.lang.String-double-double-} ``` public Layout newLayout(String name, double width, double height) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Layout](../../com.groupdocs.viewer.results/layout) interface with the specified name, width, and height. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| name | java.lang.String | name | -| width | double | width | -| height | double | height | +| name | java.lang.String | The name of the layout. | +| width | double | The width of the layout. | +| height | double | The height of the layout. | **Returns:** -[Layout](../../com.groupdocs.viewer.results/layout) - new instance of [Layout](../../com.groupdocs.viewer.results/layout) implementation +[Layout](../../com.groupdocs.viewer.results/layout) - a new instance of the [Layout](../../com.groupdocs.viewer.results/layout) implementation. ### newLine(String line, double x, double y, double width, double height, List words) {#newLine-java.lang.String-double-double-double-double-java.util.List-com.groupdocs.viewer.results.Word--} ``` public Line newLine(String line, double x, double y, double width, double height, List words) ``` -Creates implementation of Line interface +Creates an implementation of the [Line](../../com.groupdocs.viewer.results/line) interface with the specified line, position, dimensions, and words. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| line | java.lang.String | The line. | -| x | double | The X coordinate of the highest left point on the page layout where the rectangle that contains line begins. | -| y | double | The Y coordinate of the highest left point on the page layout where the rectangle that contains line begins. | -| width | double | The width of the rectangle which contains the line (in pixels). | -| height | double | The height of the rectangle which contains the line (in pixels). | -| words | java.util.List | The words contained by the line. | +| line | java.lang.String | The line content. | +| x | double | The X coordinate of the top-left point of the rectangle that contains the line. | +| y | double | The Y coordinate of the top-left point of the rectangle that contains the line. | +| width | double | The width of the rectangle that contains the line (in pixels). | +| height | double | The height of the rectangle that contains the line (in pixels). | +| words | java.util.List | The words contained in the line. | **Returns:** -[Line](../../com.groupdocs.viewer.results/line) +[Line](../../com.groupdocs.viewer.results/line) - a new instance of the [Line](../../com.groupdocs.viewer.results/line) implementation. ### newAttachment(String fileName, String filePath) {#newAttachment-java.lang.String-java.lang.String-} ``` public Attachment newAttachment(String fileName, String filePath) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileName | java.lang.String | file name | -| filePath | java.lang.String | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. | +| fileName | java.lang.String | The name of the attachment. | +| filePath | java.lang.String | The relative path of the attachment, e.g., "folder/file.docx". When the file is located in the root of an archive, in an email message, or a data file, specify the filename. | **Returns:** -[Attachment](../../com.groupdocs.viewer.results/attachment) - new instance of [Attachment](../../com.groupdocs.viewer.results/attachment) implementation +[Attachment](../../com.groupdocs.viewer.results/attachment) - a new instance of the [Attachment](../../com.groupdocs.viewer.results/attachment) implementation. ### newAttachment(String id, String fileName, String filePath, long size) {#newAttachment-java.lang.String-java.lang.String-java.lang.String-long-} ``` public Attachment newAttachment(String id, String fileName, String filePath, long size) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| id | java.lang.String | id | -| fileName | java.lang.String | file name | -| filePath | java.lang.String | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. | -| size | long | size | +| id | java.lang.String | The ID of the attachment. | +| fileName | java.lang.String | The name of the attachment. | +| filePath | java.lang.String | The relative path of the attachment, e.g., "folder/file.docx". When the file is located in the root of an archive, in an email message, or a data file, specify the filename. | +| size | long | The size of the attachment. | **Returns:** -[Attachment](../../com.groupdocs.viewer.results/attachment) - new instance of [Attachment](../../com.groupdocs.viewer.results/attachment) implementation +[Attachment](../../com.groupdocs.viewer.results/attachment) - a new instance of the [Attachment](../../com.groupdocs.viewer.results/attachment) implementation. ### newAttachment(String id, String fileName, Path filePath, long size) {#newAttachment-java.lang.String-java.lang.String-java.nio.file.Path-long-} ``` public Attachment newAttachment(String id, String fileName, Path filePath, long size) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| id | java.lang.String | id | -| fileName | java.lang.String | file name | -| filePath | java.nio.file.Path | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. | -| size | long | size | +| id | java.lang.String | The ID of the attachment. | +| fileName | java.lang.String | The name of the attachment. | +| filePath | java.nio.file.Path | The relative or absolute path of the attachment. | +| size | long | The size of the attachment. | **Returns:** -[Attachment](../../com.groupdocs.viewer.results/attachment) - new instance of [Attachment](../../com.groupdocs.viewer.results/attachment) implementation +[Attachment](../../com.groupdocs.viewer.results/attachment) - a new instance of the [Attachment](../../com.groupdocs.viewer.results/attachment) implementation. ### newAttachment(String id, String fileName, String filePath, FileType fileType, long size) {#newAttachment-java.lang.String-java.lang.String-java.lang.String-com.groupdocs.viewer.FileType-long-} ``` public Attachment newAttachment(String id, String fileName, String filePath, FileType fileType, long size) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Attachment](../../com.groupdocs.viewer.results/attachment) interface. The attachment represents a file attached to a document or an email message. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| id | java.lang.String | id | -| fileName | java.lang.String | file name | -| filePath | java.lang.String | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| size | long | size | +| id | java.lang.String | The ID of the attachment. | +| fileName | java.lang.String | The name of the attachment. | +| filePath | java.lang.String | The relative or absolute path of the attachment. It can be a file path within a folder or the filename itself if the file is located in the root of an archive, in an email message, or in a data file. | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The type of the attachment file. | +| size | long | The size of the attachment. | **Returns:** -[Attachment](../../com.groupdocs.viewer.results/attachment) - new instance of [Attachment](../../com.groupdocs.viewer.results/attachment) implementation +[Attachment](../../com.groupdocs.viewer.results/attachment) - a new instance of the [Attachment](../../com.groupdocs.viewer.results/attachment) implementation. ### newOutlookViewInfo(FileType fileType, List pages, List folders) {#newOutlookViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-java.lang.String--} ``` public OutlookViewInfo newOutlookViewInfo(FileType fileType, List pages, List folders) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [OutlookViewInfo](../../com.groupdocs.viewer.results/outlookviewinfo) interface based on the specified file type, list of pages, and list of folders. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| pages | java.util.List | pages | -| folders | java.util.List | folders | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | +| pages | java.util.List | The list of pages. | +| folders | java.util.List | The list of folders. | **Returns:** -[OutlookViewInfo](../../com.groupdocs.viewer.results/outlookviewinfo) - new instance of [OutlookViewInfo](../../com.groupdocs.viewer.results/outlookviewinfo) implementation +[OutlookViewInfo](../../com.groupdocs.viewer.results/outlookviewinfo) - a new instance of the [OutlookViewInfo](../../com.groupdocs.viewer.results/outlookviewinfo) implementation. ### newPage(int number, boolean visible) {#newPage-int-boolean-} ``` public Page newPage(int number, boolean visible) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number and visibility. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| number | int | number | -| visible | boolean | visibility | +| number | int | The page number. | +| visible | boolean | The visibility flag. | **Returns:** -[Page](../../com.groupdocs.viewer.results/page) - new instance of [Page](../../com.groupdocs.viewer.results/page) implementation +[Page](../../com.groupdocs.viewer.results/page) - a new instance of the [Page](../../com.groupdocs.viewer.results/page) implementation. ### newPage(int number, String name, boolean visible) {#newPage-int-java.lang.String-boolean-} ``` public Page newPage(int number, String name, boolean visible) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, name, and visibility. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| number | int | number | -| name | java.lang.String | name | -| visible | boolean | visibility | +| number | int | The page number. | +| name | java.lang.String | The page name. | +| visible | boolean | The visibility flag. | **Returns:** -[Page](../../com.groupdocs.viewer.results/page) - new instance of [Page](../../com.groupdocs.viewer.results/page) implementation +[Page](../../com.groupdocs.viewer.results/page) - a new instance of the [Page](../../com.groupdocs.viewer.results/page) implementation. ### newPage(int number, String name, boolean visible, int width, int height) {#newPage-int-java.lang.String-boolean-int-int-} ``` public Page newPage(int number, String name, boolean visible, int width, int height) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, name, visibility, width, and height. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| number | int | number | -| name | java.lang.String | name | -| visible | boolean | visibility | -| width | int | width | -| height | int | height | +| number | int | The page number. | +| name | java.lang.String | The page name. | +| visible | boolean | The visibility flag. | +| width | int | The width of the page. | +| height | int | The height of the page. | **Returns:** -[Page](../../com.groupdocs.viewer.results/page) - new instance of [Page](../../com.groupdocs.viewer.results/page) implementation +[Page](../../com.groupdocs.viewer.results/page) - a new instance of the [Page](../../com.groupdocs.viewer.results/page) implementation. ### newPage(int number, boolean visible, int width, int height) {#newPage-int-boolean-int-int-} ``` public Page newPage(int number, boolean visible, int width, int height) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, visibility, width, and height. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| number | int | number | -| visible | boolean | visibility | -| width | int | width | -| height | int | height | +| number | int | The page number. | +| visible | boolean | The visibility flag. | +| width | int | The width of the page. | +| height | int | The height of the page. | **Returns:** -[Page](../../com.groupdocs.viewer.results/page) - new instance of [Page](../../com.groupdocs.viewer.results/page) implementation +[Page](../../com.groupdocs.viewer.results/page) - a new instance of the [Page](../../com.groupdocs.viewer.results/page) implementation. ### newPage(int number, String name, boolean visible, int width, int height, List lines) {#newPage-int-java.lang.String-boolean-int-int-java.util.List-com.groupdocs.viewer.results.Line--} ``` public Page newPage(int number, String name, boolean visible, int width, int height, List lines) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, name, visibility, width, height, and lines. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| number | int | number | -| name | java.lang.String | name | -| visible | boolean | visibility | -| width | int | width | -| height | int | height | -| lines | java.util.List | lines | +| number | int | The page number. | +| name | java.lang.String | The page name. | +| visible | boolean | The visibility flag. | +| width | int | The width of the page. | +| height | int | The height of the page. | +| lines | java.util.List | The lines contained in the page. | **Returns:** -[Page](../../com.groupdocs.viewer.results/page) - new instance of [Page](../../com.groupdocs.viewer.results/page) implementation +[Page](../../com.groupdocs.viewer.results/page) - a new instance of the [Page](../../com.groupdocs.viewer.results/page) implementation. ### newPage(int number, boolean visible, int width, int height, List lines) {#newPage-int-boolean-int-int-java.util.List-com.groupdocs.viewer.results.Line--} ``` public Page newPage(int number, boolean visible, int width, int height, List lines) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Page](../../com.groupdocs.viewer.results/page) interface representing a page with the specified number, visibility, width, height, and lines. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| number | int | number | -| visible | boolean | visibility | -| width | int | width | -| height | int | height | -| lines | java.util.List | lines | +| number | int | The page number. | +| visible | boolean | The visibility flag. | +| width | int | The width of the page. | +| height | int | The height of the page. | +| lines | java.util.List | The lines contained in the page. | **Returns:** -[Page](../../com.groupdocs.viewer.results/page) - new instance of [Page](../../com.groupdocs.viewer.results/page) implementation +[Page](../../com.groupdocs.viewer.results/page) - a new instance of the [Page](../../com.groupdocs.viewer.results/page) implementation. ### newPdfViewInfo(FileType fileType, List pages, boolean printingAllowed) {#newPdfViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--boolean-} ``` public PdfViewInfo newPdfViewInfo(FileType fileType, List pages, boolean printingAllowed) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [PdfViewInfo](../../com.groupdocs.viewer.results/pdfviewinfo) interface with the specified file type, pages, and printing allowed flag. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| pages | java.util.List | pages | -| printingAllowed | boolean | printing allowed | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | +| pages | java.util.List | The list of pages. | +| printingAllowed | boolean | The flag indicating whether printing is allowed. | **Returns:** -[PdfViewInfo](../../com.groupdocs.viewer.results/pdfviewinfo) - new instance of [PdfViewInfo](../../com.groupdocs.viewer.results/pdfviewinfo) implementation +[PdfViewInfo](../../com.groupdocs.viewer.results/pdfviewinfo) - a new instance of the [PdfViewInfo](../../com.groupdocs.viewer.results/pdfviewinfo) implementation. ### newCadViewInfo(FileType fileType, List pages, List layers, List layouts) {#newCadViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-com.groupdocs.viewer.results.Layer--java.util.List-com.groupdocs.viewer.results.Layout--} ``` public CadViewInfo newCadViewInfo(FileType fileType, List pages, List layers, List layouts) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [CadViewInfo](../../com.groupdocs.viewer.results/cadviewinfo) interface with the specified file type, pages, layers, and layouts. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| pages | java.util.List | pages | -| layers | java.util.List | layers | -| layouts | java.util.List | layouts | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | +| pages | java.util.List | The list of pages. | +| layers | java.util.List | The list of layers. | +| layouts | java.util.List | The list of layouts. | **Returns:** -[CadViewInfo](../../com.groupdocs.viewer.results/cadviewinfo) - new instance of [CadViewInfo](../../com.groupdocs.viewer.results/cadviewinfo) implementation +[CadViewInfo](../../com.groupdocs.viewer.results/cadviewinfo) - a new instance of the [CadViewInfo](../../com.groupdocs.viewer.results/cadviewinfo) implementation. ### newProjectManagementViewInfo(FileType fileType, List pages, Date startDate, Date endDate) {#newProjectManagementViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.Date-java.util.Date-} ``` public ProjectManagementViewInfo newProjectManagementViewInfo(FileType fileType, List pages, Date startDate, Date endDate) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [ProjectManagementViewInfo](../../com.groupdocs.viewer.results/projectmanagementviewinfo) interface with the specified file type, pages, start date, and end date. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileType | [FileType](../../com.groupdocs.viewer/filetype) | file type | -| pages | java.util.List | pages | -| startDate | java.util.Date | start date | -| endDate | java.util.Date | end date | +| fileType | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | +| pages | java.util.List | The list of pages. | +| startDate | java.util.Date | The start date. | +| endDate | java.util.Date | The end date. | **Returns:** -[ProjectManagementViewInfo](../../com.groupdocs.viewer.results/projectmanagementviewinfo) - new instance of [ProjectManagementViewInfo](../../com.groupdocs.viewer.results/projectmanagementviewinfo) implementation +[ProjectManagementViewInfo](../../com.groupdocs.viewer.results/projectmanagementviewinfo) - a new instance of the [ProjectManagementViewInfo](../../com.groupdocs.viewer.results/projectmanagementviewinfo) implementation. ### newTextElement(T value, double x, double y, double width, double height) {#-T-newTextElement-T-double-double-double-double-} ``` public TextElement newTextElement(T value, double x, double y, double width, double height) ``` -Creates implementation of TextElement interface +Creates an implementation of the [TextElement](../../com.groupdocs.viewer.results/textelement) interface with the specified value, coordinates, and dimensions. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | T | the value | -| x | double | x | -| y | double | y | -| width | double | width | -| height | double | height | +| value | T | The value. | +| x | double | The X coordinate. | +| y | double | The Y coordinate. | +| width | double | The width. | +| height | double | The height. | **Returns:** -[TextElement](../../com.groupdocs.viewer.results/textelement) - new instance of [TextElement](../../com.groupdocs.viewer.results/textelement) implementation +[TextElement](../../com.groupdocs.viewer.results/textelement) - a new instance of the [TextElement](../../com.groupdocs.viewer.results/textelement) implementation. ### newMboxViewInfo(FileType fileType, List pages, int notesCount) {#newMboxViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--int-} ``` public MboxViewInfo newMboxViewInfo(FileType fileType, List pages, int notesCount) ``` -Creates implementation of TextElement interface +Creates an implementation of the MboxViewInfo interface with the specified file type, pages, and notes count. **Parameters:** | Parameter | Type | Description | @@ -519,24 +532,24 @@ Creates implementation of TextElement interface | notesCount | int | The notes count contained by the Lotus database storage file. | **Returns:** -com.groupdocs.viewer.results.MboxViewInfo - new instance of MboxViewInfo implementation +com.groupdocs.viewer.results.MboxViewInfo - a new instance of the MboxViewInfo implementation. ### newWord(String word, double x, double y, double width, double height, List characters) {#newWord-java.lang.String-double-double-double-double-java.util.List-com.groupdocs.viewer.results.Character--} ``` public Word newWord(String word, double x, double y, double width, double height, List characters) ``` -Creates implementation of LotusNotesViewInfo interface +Creates an implementation of the [Word](../../com.groupdocs.viewer.results/word) interface with the specified word, coordinates, dimensions, and characters. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| word | java.lang.String | the word | -| x | double | x | -| y | double | y | -| width | double | width | -| height | double | height | -| characters | java.util.List | characters | +| word | java.lang.String | The word. | +| x | double | The X coordinate of the highest left point on the page layout where the rectangle that contains the word begins. | +| y | double | The Y coordinate of the highest left point on the page layout where the rectangle that contains the word begins. | +| width | double | The width of the rectangle which contains the word (in pixels). | +| height | double | The height of the rectangle which contains the word (in pixels). | +| characters | java.util.List | The characters contained by the word. | **Returns:** -[Word](../../com.groupdocs.viewer.results/word) - new instance of [Word](../../com.groupdocs.viewer.results/word) implementation +[Word](../../com.groupdocs.viewer.results/word) - a new instance of the [Word](../../com.groupdocs.viewer.results/word) implementation. diff --git a/english/java/com.groupdocs.viewer.caching/_index.md b/english/java/com.groupdocs.viewer.caching/_index.md index f8e5e67e7..9f2e7c355 100644 --- a/english/java/com.groupdocs.viewer.caching/_index.md +++ b/english/java/com.groupdocs.viewer.caching/_index.md @@ -1,24 +1,36 @@ --- title: com.groupdocs.viewer.caching second_title: GroupDocs.Viewer for Java API Reference -description: The package provides classes for customizing caching behaviour. +description: The package provides classes for customizing caching behavior. type: docs weight: 11 url: /java/com.groupdocs.viewer.caching/ --- -The package provides classes for customizing caching behaviour. +The package provides classes for customizing caching behavior. + +The main classes and interfaces in this package are: + + * [CacheKeys](../../com.groupdocs.viewer.caching/cachekeys) - Provides methods to retrieve unique identifiers for the cache entry. + * [FileCache](../../com.groupdocs.viewer.caching/filecache) - Represents a local on-disk cache. + +The [Cache](../../com.groupdocs.viewer.caching/cache) interface defines methods required for storing rendered documents and document resources in the cache. + +For more details on customizing caching behavior in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Classes | Class | Description | | --- | --- | -| [CacheKeys](../com.groupdocs.viewer.caching/cachekeys) | Provides methods to retrieve unique identifier for the cache entry. | +| [CacheKeys](../com.groupdocs.viewer.caching/cachekeys) | Provides methods to retrieve the unique identifier for a cache entry. | | [FileCache](../com.groupdocs.viewer.caching/filecache) | Represents a local on-disk cache. | ## Interfaces | Interface | Description | | --- | --- | -| [Cache](../com.groupdocs.viewer.caching/cache) | Defines methods required for storing rendered document and document resources \\u0441ache. | +| [Cache](../com.groupdocs.viewer.caching/cache) | Defines methods required for storing rendered documents and document resources cache. | diff --git a/english/java/com.groupdocs.viewer.caching/cache/_index.md b/english/java/com.groupdocs.viewer.caching/cache/_index.md index 5f7a871b8..83a87e48b 100644 --- a/english/java/com.groupdocs.viewer.caching/cache/_index.md +++ b/english/java/com.groupdocs.viewer.caching/cache/_index.md @@ -1,7 +1,7 @@ --- title: Cache second_title: GroupDocs.Viewer for Java API Reference -description: Defines methods required for storing rendered document and document resources u0441ache. +description: Defines methods required for storing rendered documents and document resources cache. type: docs weight: 12 url: /java/com.groupdocs.viewer.caching/cache/ @@ -9,14 +9,42 @@ url: /java/com.groupdocs.viewer.caching/cache/ public interface Cache ``` -Defines methods required for storing rendered document and document resources \\u0441ache. +Defines methods required for storing rendered documents and document resources cache. + +The Cache interface defines the methods required for storing rendered documents and document resources cache in the GroupDocs.Viewer component. It provides a contract for implementing different cache mechanisms to enhance the performance of document rendering by caching frequently accessed data. + +Example usage: + +``` + + // Implement a custom cache by implementing the Cache interface + public class MyCustomCache implements Cache { + // Implement the methods of the Cache interface based on your caching mechanism + // ... + } + + // Create an instance of your custom cache + Cache myCache = new MyCustomCache(); + + final ViewerSettings viewerSettings = new ViewerSettings(); + // Set the custom cache to viewerSettings + viewerSettings.setCache(myCache); + + // Use the viewerSettings object for creating Viewer object to render document with custom cache + try (Viewer viewer = new Viewer(documentPath, viewerSettings)) { + // Use the viewer object for document rendering + } + +``` + +***Note:** The Cache interface allows you to implement custom cache mechanisms tailored to your specific requirements. GroupDocs.Viewer also provides built-in cache implementation such as [FileCache](../../com.groupdocs.viewer.caching/filecache).* ## Methods | Method | Description | | --- | --- | | [set(String key, Object value)](#set-java.lang.String-java.lang.Object-) | Inserts a cache entry into the cache. | -| [get(String key, Class clazz)](#-T-get-java.lang.String-java.lang.Class-T--) | Gets the entry associated with this key if present and null otherwise. | -| [getKeys(String filter)](#getKeys-java.lang.String-) | Returns all keys matching filter. | +| [get(String key, Class clazz)](#-T-get-java.lang.String-java.lang.Class-T--) | Retrieves the entry associated with the specified key if it is present, and returns null otherwise. | +| [getKeys(String filter)](#getKeys-java.lang.String-) | Returns all keys that match the specified filter. | ### set(String key, Object value) {#set-java.lang.String-java.lang.Object-} ``` public abstract void set(String key, Object value) @@ -37,23 +65,23 @@ public abstract T get(String key, Class clazz) ``` -Gets the entry associated with this key if present and null otherwise. +Retrieves the entry associated with the specified key if it is present, and returns null otherwise. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | key | java.lang.String | A key identifying the requested entry. | -| clazz | java.lang.Class | | +| clazz | java.lang.Class | The class type of the expected entry. | **Returns:** -T - Object if the key was found and null otherwise. +T - the entry associated with the key if found, or null otherwise. ### getKeys(String filter) {#getKeys-java.lang.String-} ``` public abstract List getKeys(String filter) ``` -Returns all keys matching filter. +Returns all keys that match the specified filter. **Parameters:** | Parameter | Type | Description | @@ -61,4 +89,4 @@ Returns all keys matching filter. | filter | java.lang.String | The filter to use. | **Returns:** -java.util.List - Keys matching the filter. +java.util.List - a list of keys that match the filter. diff --git a/english/java/com.groupdocs.viewer.caching/cachekeys/_index.md b/english/java/com.groupdocs.viewer.caching/cachekeys/_index.md index 61b25254e..2a72b2ea1 100644 --- a/english/java/com.groupdocs.viewer.caching/cachekeys/_index.md +++ b/english/java/com.groupdocs.viewer.caching/cachekeys/_index.md @@ -1,7 +1,7 @@ --- title: CacheKeys second_title: GroupDocs.Viewer for Java API Reference -description: Provides methods to retrieve unique identifier for the cache entry. +description: Provides methods to retrieve the unique identifier for a cache entry. type: docs weight: 10 url: /java/com.groupdocs.viewer.caching/cachekeys/ @@ -12,7 +12,25 @@ java.lang.Object public class CacheKeys ``` -Provides methods to retrieve unique identifier for the cache entry. +Provides methods to retrieve the unique identifier for a cache entry. + +The class allows you to generate cache keys based on different parameters, such as the document path, rendering options, and resource name. These cache keys can be used to store and retrieve cached data for efficient document rendering. + +Example usage: + +``` + + // Generate a cache key for a file + String fileKey = CacheKeys.getFileKey("filename.pdf"); + + // Generate a cache key for a page + String pageKey = CacheKeys.getPageKey(pageNumber, FileType.HTML.getExtension()); + + // Generate a cache key for a resource + Resource resource = new Resource("styles.css", false); + String pageKey = CacheKeys.getResourceKey(pageNumber, resource); + +``` ## Fields | Field | Description | @@ -22,14 +40,14 @@ Provides methods to retrieve unique identifier for the cache entry. | Method | Description | | --- | --- | -| [getAttachmentsKey()](#getAttachmentsKey--) | Returns unique identifier for the cache entry that represents collection of [Attachment](../../com.groupdocs.viewer.results/attachment) objects. | -| [getAttachmentKey(String attachmentId)](#getAttachmentKey-java.lang.String-) | Returns unique identifier for the cache entry that represents attachment file. | -| [getViewInfoKey()](#getViewInfoKey--) | Returns unique identifier for the cache entry that represents [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. | -| [getFileInfoKey()](#getFileInfoKey--) | Returns unique identifier for the cache entry that represents [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. | -| [getFileKey(String extension)](#getFileKey-java.lang.String-) | Returns unique identifier for the cache entry that represents file. | -| [getPageKey(int pageNumber, String extension)](#getPageKey-int-java.lang.String-) | Returns unique identifier for the cache entry that represents page file. | -| [getResourceKey(int pageNumber, Resource resource)](#getResourceKey-int-com.groupdocs.viewer.results.Resource-) | Returns unique identifier for the cache entry that represents [Resource](../../com.groupdocs.viewer.results/resource) object. | -| [getResourceFilter(int pageNumber)](#getResourceFilter-int-) | Returns filter string to search for cache entries that represents [Resource](../../com.groupdocs.viewer.results/resource) objects. | +| [getAttachmentsKey()](#getAttachmentsKey--) | Returns the unique identifier for the cache entry that represents a collection of [Attachment](../../com.groupdocs.viewer.results/attachment) objects. | +| [getAttachmentKey(String attachmentId)](#getAttachmentKey-java.lang.String-) | Retrieves the unique identifier for the cache entry representing an attachment file. | +| [getViewInfoKey()](#getViewInfoKey--) | Retrieves the unique identifier for the cache entry that represents a [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. | +| [getFileInfoKey()](#getFileInfoKey--) | Retrieves the unique identifier for the cache entry that represents a [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. | +| [getFileKey(String extension)](#getFileKey-java.lang.String-) | Retrieves the unique identifier for the cache entry that represents a file. | +| [getPageKey(int pageNumber, String extension)](#getPageKey-int-java.lang.String-) | Retrieves the unique identifier for the cache entry that represents a page file. | +| [getResourceKey(int pageNumber, Resource resource)](#getResourceKey-int-com.groupdocs.viewer.results.Resource-) | Returns a unique identifier for the cache entry that represents a [Resource](../../com.groupdocs.viewer.results/resource) object. | +| [getResourceFilter(int pageNumber)](#getResourceFilter-int-) | Returns a filter string to search for cache entries that represent [Resource](../../com.groupdocs.viewer.results/resource) objects. | ### PAGE_NUMBER {#PAGE-NUMBER} ``` public static final String PAGE_NUMBER @@ -42,52 +60,52 @@ public static String getAttachmentsKey() ``` -Returns unique identifier for the cache entry that represents collection of [Attachment](../../com.groupdocs.viewer.results/attachment) objects. +Returns the unique identifier for the cache entry that represents a collection of [Attachment](../../com.groupdocs.viewer.results/attachment) objects. **Returns:** -java.lang.String - Unique identifier for the cache entry that represents collection of [Attachment](../../com.groupdocs.viewer.results/attachment) objects. +java.lang.String - the unique identifier for the attachments cache entry. ### getAttachmentKey(String attachmentId) {#getAttachmentKey-java.lang.String-} ``` public static String getAttachmentKey(String attachmentId) ``` -Returns unique identifier for the cache entry that represents attachment file. +Retrieves the unique identifier for the cache entry representing an attachment file. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| attachmentId | java.lang.String | Unique (in context of single file) identifier of the attachment. | +| attachmentId | java.lang.String | The unique identifier of the attachment (in the context of a single file). | **Returns:** -java.lang.String - Unique identifier for the cache entry that represents attachment file. +java.lang.String - the unique identifier for the attachment file cache entry. ### getViewInfoKey() {#getViewInfoKey--} ``` public static String getViewInfoKey() ``` -Returns unique identifier for the cache entry that represents [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. +Retrieves the unique identifier for the cache entry that represents a [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. **Returns:** -java.lang.String - Unique identifier for the cache entry that represents [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. +java.lang.String - the unique identifier for the cache entry. ### getFileInfoKey() {#getFileInfoKey--} ``` public static String getFileInfoKey() ``` -Returns unique identifier for the cache entry that represents [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. +Retrieves the unique identifier for the cache entry that represents a [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. **Returns:** -java.lang.String - Unique identifier for the cache entry that represents [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. +java.lang.String - the unique identifier for the cache entry representing a [ViewInfo](../../com.groupdocs.viewer.results/viewinfo) object. ### getFileKey(String extension) {#getFileKey-java.lang.String-} ``` public static String getFileKey(String extension) ``` -Returns unique identifier for the cache entry that represents file. +Retrieves the unique identifier for the cache entry that represents a file. **Parameters:** | Parameter | Type | Description | @@ -95,14 +113,14 @@ Returns unique identifier for the cache entry that represents file. | extension | java.lang.String | The filename suffix (including the period ".") e.g. ".doc". | **Returns:** -java.lang.String - Unique identifier for the cache entry that represents file. +java.lang.String - the unique identifier for the cache entry representing a file. ### getPageKey(int pageNumber, String extension) {#getPageKey-int-java.lang.String-} ``` public static String getPageKey(int pageNumber, String extension) ``` -Returns unique identifier for the cache entry that represents page file. +Retrieves the unique identifier for the cache entry that represents a page file. **Parameters:** | Parameter | Type | Description | @@ -111,14 +129,14 @@ Returns unique identifier for the cache entry that represents page file. | extension | java.lang.String | The filename suffix (including the period ".") e.g. ".doc". | **Returns:** -java.lang.String - Unique identifier for the cache entry that represents page file. +java.lang.String - the unique identifier for the cache entry representing a page file. ### getResourceKey(int pageNumber, Resource resource) {#getResourceKey-int-com.groupdocs.viewer.results.Resource-} ``` public static String getResourceKey(int pageNumber, Resource resource) ``` -Returns unique identifier for the cache entry that represents [Resource](../../com.groupdocs.viewer.results/resource) object. +Returns a unique identifier for the cache entry that represents a [Resource](../../com.groupdocs.viewer.results/resource) object. **Parameters:** | Parameter | Type | Description | @@ -127,19 +145,19 @@ Returns unique identifier for the cache entry that represents [Resource](../../c | resource | [Resource](../../com.groupdocs.viewer.results/resource) | The HTML resource. | **Returns:** -java.lang.String - Unique identifier for the cache entry that represents [Resource](../../com.groupdocs.viewer.results/resource) object. +java.lang.String - the unique identifier for the cache entry. ### getResourceFilter(int pageNumber) {#getResourceFilter-int-} ``` public static String getResourceFilter(int pageNumber) ``` -Returns filter string to search for cache entries that represents [Resource](../../com.groupdocs.viewer.results/resource) objects. +Returns a filter string to search for cache entries that represent [Resource](../../com.groupdocs.viewer.results/resource) objects. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | The number of page. | +| pageNumber | int | The number of the page. | **Returns:** -java.lang.String - Filter string to search for cache entries that represents [Resource](../../com.groupdocs.viewer.results/resource) objects. +java.lang.String - the filter string to search for cache entries. diff --git a/english/java/com.groupdocs.viewer.caching/filecache/_index.md b/english/java/com.groupdocs.viewer.caching/filecache/_index.md index 697075fef..2996369cb 100644 --- a/english/java/com.groupdocs.viewer.caching/filecache/_index.md +++ b/english/java/com.groupdocs.viewer.caching/filecache/_index.md @@ -16,14 +16,35 @@ public class FileCache implements Cache ``` Represents a local on-disk cache. + +The FileCache class represents a local on-disk cache in the GroupDocs.Viewer component. It provides functionality to store and retrieve cached data on the disk for efficient document rendering. + +Example usage: + +``` + + FileCache fileCache = new FileCache(cachePath, cacheSubFolder); + + final ViewerSettings viewerSettings = new ViewerSettings(); + viewerSettings.setCache(fileCache); + + try (Viewer viewer = new Viewer(documentPath, viewerSettings)) { + // Use the viewer object for document rendering + } + +``` + +To use the FileCache, you need to create an instance of this class and pass it to the ViewerSettings object. The Viewer object will then use the FileCache for caching purposes while rendering documents. + +***Note:** The FileCache is just one of the cache implementations provided by GroupDocs.Viewer. You can also implement your own custom cache by implementing the Cache interface.* ## Constructors | Constructor | Description | | --- | --- | -| [FileCache(String cachePath)](#FileCache-java.lang.String-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. | -| [FileCache(Path cachePath)](#FileCache-java.nio.file.Path-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. | -| [FileCache(String cachePath, String cacheSubFolder)](#FileCache-java.lang.String-java.lang.String-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. | -| [FileCache(Path cachePath, String cacheSubFolder)](#FileCache-java.nio.file.Path-java.lang.String-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. | +| [FileCache(String cachePath)](#FileCache-java.lang.String-) | Creates a new instance of the FileCache class. | +| [FileCache(Path cachePath)](#FileCache-java.nio.file.Path-) | Creates a new instance of the FileCache class. | +| [FileCache(String cachePath, String cacheSubFolder)](#FileCache-java.lang.String-java.lang.String-) | Creates a new instance of the FileCache class. | +| [FileCache(Path cachePath, String cacheSubFolder)](#FileCache-java.nio.file.Path-java.lang.String-) | Creates a new instance of the FileCache class. | ## Fields | Field | Description | @@ -33,25 +54,23 @@ Represents a local on-disk cache. | Method | Description | | --- | --- | -| [getCachePath()](#getCachePath--) | The Relative or absolute path to the cache folder. | -| [getCacheSubFolder()](#getCacheSubFolder--) | The sub-folder to append to the \#getCachePath().getCachePath(). | +| [getCachePath()](#getCachePath--) | Gets the relative or absolute path to the cache folder. | +| [getCacheSubFolder()](#getCacheSubFolder--) | The sub-folder to append to the cache path. | | [set(String key, Object value)](#set-java.lang.String-java.lang.Object-) | Serializes data to the local disk. | | [get(String key, Class clazz)](#-T-get-java.lang.String-java.lang.Class-T--) | Deserializes data associated with this key if present. | -| [getKeys(String filter)](#getKeys-java.lang.String-) | Returns all file names that contains filter in filename. | -| [getWaitTimeout()](#getWaitTimeout--) | | -| [setWaitTimeout(System.TimeSpan waitTimeout)](#setWaitTimeout-com.aspose.ms.System.TimeSpan-) | | +| [getKeys(String filter)](#getKeys-java.lang.String-) | Returns all file names that contain the filter in the filename. | ### FileCache(String cachePath) {#FileCache-java.lang.String-} ``` public FileCache(String cachePath) ``` -Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. +Creates a new instance of the FileCache class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| cachePath | java.lang.String | Relative or absolute path where document cache will be stored. | +| cachePath | java.lang.String | The relative or absolute path where the document cache will be stored. | ### FileCache(Path cachePath) {#FileCache-java.nio.file.Path-} ``` @@ -59,12 +78,12 @@ public FileCache(Path cachePath) ``` -Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. +Creates a new instance of the FileCache class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| cachePath | java.nio.file.Path | Relative or absolute path where document cache will be stored. | +| cachePath | java.nio.file.Path | The relative or absolute path where the document cache will be stored. | ### FileCache(String cachePath, String cacheSubFolder) {#FileCache-java.lang.String-java.lang.String-} ``` @@ -72,12 +91,12 @@ public FileCache(String cachePath, String cacheSubFolder) ``` -Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. +Creates a new instance of the FileCache class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| cachePath | java.lang.String | Relative or absolute path where document cache will be stored. | +| cachePath | java.lang.String | The relative or absolute path where the document cache will be stored. | | cacheSubFolder | java.lang.String | The sub-folder to append to cachePath . | ### FileCache(Path cachePath, String cacheSubFolder) {#FileCache-java.nio.file.Path-java.lang.String-} @@ -86,12 +105,12 @@ public FileCache(Path cachePath, String cacheSubFolder) ``` -Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. +Creates a new instance of the FileCache class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| cachePath | java.nio.file.Path | Relative or absolute path where document cache will be stored. | +| cachePath | java.nio.file.Path | The relative or absolute path where the document cache will be stored. | | cacheSubFolder | java.lang.String | The sub-folder to append to cachePath . | ### CACHE_PATH {#CACHE-PATH} @@ -106,20 +125,20 @@ public final String getCachePath() ``` -The Relative or absolute path to the cache folder. +Gets the relative or absolute path to the cache folder. **Returns:** -java.lang.String - The Relative or absolute path to the cache folder. +java.lang.String - Path to the cache folder. ### getCacheSubFolder() {#getCacheSubFolder--} ``` public final String getCacheSubFolder() ``` -The sub-folder to append to the \#getCachePath().getCachePath(). +The sub-folder to append to the cache path. **Returns:** -java.lang.String - The sub-folder to append to the \#getCachePath().getCachePath(). +java.lang.String - the sub-folder to append. ### set(String key, Object value) {#set-java.lang.String-java.lang.Object-} ``` public final void set(String key, Object value) @@ -131,7 +150,7 @@ Serializes data to the local disk. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| key | java.lang.String | An unique identifier for the cache entry. | +| key | java.lang.String | The unique identifier for the cache entry. | | value | java.lang.Object | The object to serialize. | ### get(String key, Class clazz) {#-T-get-java.lang.String-java.lang.Class-T--} @@ -146,17 +165,17 @@ Deserializes data associated with this key if present. | Parameter | Type | Description | | --- | --- | --- | | key | java.lang.String | A key identifying the requested entry. | -| clazz | java.lang.Class | | +| clazz | java.lang.Class | The class of the expected value. | **Returns:** -T - The located value or null. +T - the located value or null. ### getKeys(String filter) {#getKeys-java.lang.String-} ``` public final List getKeys(String filter) ``` -Returns all file names that contains filter in filename. +Returns all file names that contain the filter in the filename. **Parameters:** | Parameter | Type | Description | @@ -164,27 +183,4 @@ Returns all file names that contains filter in filename. | filter | java.lang.String | The filter to use. | **Returns:** -java.util.List - File names that contains filter in filename. -### getWaitTimeout() {#getWaitTimeout--} -``` -public System.TimeSpan getWaitTimeout() -``` - - - - -**Returns:** -com.aspose.ms.System.TimeSpan -### setWaitTimeout(System.TimeSpan waitTimeout) {#setWaitTimeout-com.aspose.ms.System.TimeSpan-} -``` -public void setWaitTimeout(System.TimeSpan waitTimeout) -``` - - - - -**Parameters:** -| Parameter | Type | Description | -| --- | --- | --- | -| waitTimeout | com.aspose.ms.System.TimeSpan | | - +java.util.List - File names that contain the filter in the filename. diff --git a/english/java/com.groupdocs.viewer.exception/_index.md b/english/java/com.groupdocs.viewer.exception/_index.md index 1236744a7..d774c33dc 100644 --- a/english/java/com.groupdocs.viewer.exception/_index.md +++ b/english/java/com.groupdocs.viewer.exception/_index.md @@ -1,22 +1,33 @@ --- title: com.groupdocs.viewer.exception second_title: GroupDocs.Viewer for Java API Reference -description: The package provides classes for exceptions which can occur while working with a document. +description: The package provides classes for exceptions that can occur while working with a document. type: docs weight: 13 url: /java/com.groupdocs.viewer.exception/ --- -The package provides classes for exceptions which can occur while working with a document. +The package provides classes for exceptions that can occur while working with a document. + +The main classes in this package are: + + * com.groupdocs.viewer.exception.ArchiveSecurityException - Thrown when an archive being opened exceeds specified limits. + * [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) - Represents an exception thrown when a file or directory is not found. + * [GroupDocsViewerException](../../com.groupdocs.viewer.exception/groupdocsviewerexception) - Represents generic errors that occur during document processing. + +For more details on working with exceptions in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Classes | Class | Description | | --- | --- | -| [ArchiveSecurityException](../com.groupdocs.viewer.exception/archivesecurityexception) | The exception that is thrown when archive that is being opened exceeds any of the limits specified in com.groupdocs.viewer.options.ArchiveSecurityOptions. | -| [FileNotFoundException](../com.groupdocs.viewer.exception/filenotfoundexception) | Represents the the exception that throws when file or directory was not found. | -| [GroupDocsViewerException](../com.groupdocs.viewer.exception/groupdocsviewerexception) | Represents the generic errors that occur during document processing. | -| [IncorrectPasswordException](../com.groupdocs.viewer.exception/incorrectpasswordexception) | The exception that is thrown when specified password is incorrect. | -| [NotSupportedException](../com.groupdocs.viewer.exception/notsupportedexception) | The exception that is thrown when the operation is not supported. | -| [PasswordRequiredException](../com.groupdocs.viewer.exception/passwordrequiredexception) | The exception that is thrown when password is required to load the document. | +| [ArchiveSecurityException](../com.groupdocs.viewer.exception/archivesecurityexception) | This exception is thrown when an archive being opened exceeds any of the limits specified in the ArchiveSecurityOptions. | +| [FileNotFoundException](../com.groupdocs.viewer.exception/filenotfoundexception) | This exception is thrown when a file or directory is not found. | +| [GroupDocsViewerException](../com.groupdocs.viewer.exception/groupdocsviewerexception) | This exception represents generic errors that can occur during document processing. | +| [IncorrectPasswordException](../com.groupdocs.viewer.exception/incorrectpasswordexception) | This exception is thrown when the specified password is incorrect. | +| [NotSupportedException](../com.groupdocs.viewer.exception/notsupportedexception) | This exception is thrown when the requested operation is not supported. | +| [PasswordRequiredException](../com.groupdocs.viewer.exception/passwordrequiredexception) | This exception is thrown when a password is required to load the document. | diff --git a/english/java/com.groupdocs.viewer.exception/archivesecurityexception/_index.md b/english/java/com.groupdocs.viewer.exception/archivesecurityexception/_index.md index 0ede92009..251697389 100644 --- a/english/java/com.groupdocs.viewer.exception/archivesecurityexception/_index.md +++ b/english/java/com.groupdocs.viewer.exception/archivesecurityexception/_index.md @@ -1,7 +1,7 @@ --- title: ArchiveSecurityException second_title: GroupDocs.Viewer for Java API Reference -description: The exception that is thrown when archive that is being opened exceeds any of the limits specified in com.groupdocs.viewer.options.ArchiveSecurityOptions. +description: This exception is thrown when an archive being opened exceeds any of the limits specified in the ArchiveSecurityOptions. type: docs weight: 10 url: /java/com.groupdocs.viewer.exception/archivesecurityexception/ @@ -12,19 +12,19 @@ java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeExc public class ArchiveSecurityException extends GroupDocsViewerException ``` -The exception that is thrown when archive that is being opened exceeds any of the limits specified in com.groupdocs.viewer.options.ArchiveSecurityOptions. +This exception is thrown when an archive being opened exceeds any of the limits specified in the ArchiveSecurityOptions. ## Constructors | Constructor | Description | | --- | --- | -| [ArchiveSecurityException(String message)](#ArchiveSecurityException-java.lang.String-) | Creates an instance of an exception. | +| [ArchiveSecurityException(String message)](#ArchiveSecurityException-java.lang.String-) | Creates an instance of the ArchiveSecurityException class with the specified message. | ### ArchiveSecurityException(String message) {#ArchiveSecurityException-java.lang.String-} ``` public ArchiveSecurityException(String message) ``` -Creates an instance of an exception. +Creates an instance of the ArchiveSecurityException class with the specified message. **Parameters:** | Parameter | Type | Description | diff --git a/english/java/com.groupdocs.viewer.exception/filenotfoundexception/_index.md b/english/java/com.groupdocs.viewer.exception/filenotfoundexception/_index.md index 14048b040..8895257a3 100644 --- a/english/java/com.groupdocs.viewer.exception/filenotfoundexception/_index.md +++ b/english/java/com.groupdocs.viewer.exception/filenotfoundexception/_index.md @@ -1,7 +1,7 @@ --- title: FileNotFoundException second_title: GroupDocs.Viewer for Java API Reference -description: Represents the the exception that throws when file or directory was not found. +description: This exception is thrown when a file or directory is not found. type: docs weight: 11 url: /java/com.groupdocs.viewer.exception/filenotfoundexception/ @@ -12,23 +12,23 @@ java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeExc public class FileNotFoundException extends GroupDocsViewerException ``` -Represents the the exception that throws when file or directory was not found. +This exception is thrown when a file or directory is not found. It indicates that the specified file or directory does not exist or cannot be accessed. ## Constructors | Constructor | Description | | --- | --- | -| [FileNotFoundException(String message)](#FileNotFoundException-java.lang.String-) | Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. | -| [FileNotFoundException(Path path)](#FileNotFoundException-java.nio.file.Path-) | Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. | -| [FileNotFoundException(String messageTemplate, Object[] params)](#FileNotFoundException-java.lang.String-java.lang.Object...-) | Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. | -| [FileNotFoundException(Throwable cause)](#FileNotFoundException-java.lang.Throwable-) | Instantiates a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class. | -| [FileNotFoundException(String message, Throwable throwable)](#FileNotFoundException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. | +| [FileNotFoundException(String message)](#FileNotFoundException-java.lang.String-) | Creates an instance of the FileNotFoundException class with the specified message. | +| [FileNotFoundException(Path path)](#FileNotFoundException-java.nio.file.Path-) | Initializes a new instance of the FileNotFoundException class with a specified file path. | +| [FileNotFoundException(String messageTemplate, Object[] params)](#FileNotFoundException-java.lang.String-java.lang.Object...-) | Creates a new instance of the FileNotFoundException class with a specified error message. | +| [FileNotFoundException(Throwable cause)](#FileNotFoundException-java.lang.Throwable-) | Instantiates a new instance of the FileNotFoundException class. | +| [FileNotFoundException(String message, Throwable throwable)](#FileNotFoundException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the FileNotFoundException class with a specified error message. | ### FileNotFoundException(String message) {#FileNotFoundException-java.lang.String-} ``` public FileNotFoundException(String message) ``` -Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. +Creates an instance of the FileNotFoundException class with the specified message. **Parameters:** | Parameter | Type | Description | @@ -41,12 +41,12 @@ public FileNotFoundException(Path path) ``` -Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. +Initializes a new instance of the FileNotFoundException class with a specified file path. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| path | java.nio.file.Path | The path of file that does not exist | +| path | java.nio.file.Path | The path of the file that does not exist. | ### FileNotFoundException(String messageTemplate, Object[] params) {#FileNotFoundException-java.lang.String-java.lang.Object...-} ``` @@ -54,13 +54,13 @@ public FileNotFoundException(String messageTemplate, Object[] params) ``` -Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. +Creates a new instance of the FileNotFoundException class with a specified error message. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | messageTemplate | java.lang.String | The message that describes the error. | -| params | java.lang.Object[] | The params which will be set into error message. | +| params | java.lang.Object[] | The parameters that will be set into the error message. | ### FileNotFoundException(Throwable cause) {#FileNotFoundException-java.lang.Throwable-} ``` @@ -68,12 +68,12 @@ public FileNotFoundException(Throwable cause) ``` -Instantiates a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class. +Instantiates a new instance of the FileNotFoundException class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| cause | java.lang.Throwable | the cause | +| cause | java.lang.Throwable | The cause of the exception. | ### FileNotFoundException(String message, Throwable throwable) {#FileNotFoundException-java.lang.String-java.lang.Throwable-} ``` @@ -81,11 +81,11 @@ public FileNotFoundException(String message, Throwable throwable) ``` -Initializes a new instance of the [FileNotFoundException](../../com.groupdocs.viewer.exception/filenotfoundexception) class with a specified error message. +Initializes a new instance of the FileNotFoundException class with a specified error message. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The message. | -| throwable | java.lang.Throwable | The throwable. | +| message | java.lang.String | The message that describes the error. | +| throwable | java.lang.Throwable | The throwable that caused the exception. | diff --git a/english/java/com.groupdocs.viewer.exception/groupdocsviewerexception/_index.md b/english/java/com.groupdocs.viewer.exception/groupdocsviewerexception/_index.md index 00fc71504..44173bb0e 100644 --- a/english/java/com.groupdocs.viewer.exception/groupdocsviewerexception/_index.md +++ b/english/java/com.groupdocs.viewer.exception/groupdocsviewerexception/_index.md @@ -1,7 +1,7 @@ --- title: GroupDocsViewerException second_title: GroupDocs.Viewer for Java API Reference -description: Represents the generic errors that occur during document processing. +description: This exception represents generic errors that can occur during document processing. type: docs weight: 12 url: /java/com.groupdocs.viewer.exception/groupdocsviewerexception/ @@ -12,14 +12,14 @@ java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeExc public class GroupDocsViewerException extends GroupDocsException ``` -Represents the generic errors that occur during document processing. +This exception represents generic errors that can occur during document processing. It is a broad exception that indicates an error or failure, but does not provide specific details about the nature of the error. ## Constructors | Constructor | Description | | --- | --- | -| [GroupDocsViewerException(String message)](#GroupDocsViewerException-java.lang.String-) | Initializes a new instance of the [GroupDocsViewerException](../../com.groupdocs.viewer.exception/groupdocsviewerexception) class with a specified error message. | -| [GroupDocsViewerException(Throwable cause)](#GroupDocsViewerException-java.lang.Throwable-) | Instantiates a new Group docs exception. | -| [GroupDocsViewerException(String message, Throwable throwable)](#GroupDocsViewerException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the [GroupDocsViewerException](../../com.groupdocs.viewer.exception/groupdocsviewerexception) class with a specified error message. | +| [GroupDocsViewerException(String message)](#GroupDocsViewerException-java.lang.String-) | Initializes a new instance of the GroupDocsViewerException class with a specified error message. | +| [GroupDocsViewerException(Throwable cause)](#GroupDocsViewerException-java.lang.Throwable-) | Initializes a new instance of the GroupDocsViewerException class with a cause of the exception. | +| [GroupDocsViewerException(String message, Throwable throwable)](#GroupDocsViewerException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the GroupDocsViewerException class with a specified error message. | ## Methods | Method | Description | @@ -31,7 +31,7 @@ public GroupDocsViewerException(String message) ``` -Initializes a new instance of the [GroupDocsViewerException](../../com.groupdocs.viewer.exception/groupdocsviewerexception) class with a specified error message. +Initializes a new instance of the GroupDocsViewerException class with a specified error message. **Parameters:** | Parameter | Type | Description | @@ -44,12 +44,12 @@ public GroupDocsViewerException(Throwable cause) ``` -Instantiates a new Group docs exception. +Initializes a new instance of the GroupDocsViewerException class with a cause of the exception. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| cause | java.lang.Throwable | the cause | +| cause | java.lang.Throwable | The cause of the exception. | ### GroupDocsViewerException(String message, Throwable throwable) {#GroupDocsViewerException-java.lang.String-java.lang.Throwable-} ``` @@ -57,13 +57,13 @@ public GroupDocsViewerException(String message, Throwable throwable) ``` -Initializes a new instance of the [GroupDocsViewerException](../../com.groupdocs.viewer.exception/groupdocsviewerexception) class with a specified error message. +Initializes a new instance of the GroupDocsViewerException class with a specified error message. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The message. | -| throwable | java.lang.Throwable | The throwable. | +| message | java.lang.String | The message that describes the error. | +| throwable | java.lang.Throwable | The throwable that caused the exception. | ### toString() {#toString--} ``` diff --git a/english/java/com.groupdocs.viewer.exception/incorrectpasswordexception/_index.md b/english/java/com.groupdocs.viewer.exception/incorrectpasswordexception/_index.md index 12dd5c608..fd4ce1b2a 100644 --- a/english/java/com.groupdocs.viewer.exception/incorrectpasswordexception/_index.md +++ b/english/java/com.groupdocs.viewer.exception/incorrectpasswordexception/_index.md @@ -1,7 +1,7 @@ --- title: IncorrectPasswordException second_title: GroupDocs.Viewer for Java API Reference -description: The exception that is thrown when specified password is incorrect. +description: This exception is thrown when the specified password is incorrect. type: docs weight: 13 url: /java/com.groupdocs.viewer.exception/incorrectpasswordexception/ @@ -12,20 +12,20 @@ java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeExc public class IncorrectPasswordException extends GroupDocsViewerException ``` -The exception that is thrown when specified password is incorrect. +This exception is thrown when the specified password is incorrect. This exception is typically thrown when attempting to access or decrypt a protected document with an invalid password. ## Constructors | Constructor | Description | | --- | --- | -| [IncorrectPasswordException()](#IncorrectPasswordException--) | Initializes a new instance of the [IncorrectPasswordException](../../com.groupdocs.viewer.exception/incorrectpasswordexception) class. | -| [IncorrectPasswordException(String message, Throwable throwable)](#IncorrectPasswordException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the [IncorrectPasswordException](../../com.groupdocs.viewer.exception/incorrectpasswordexception) class with a specified error message. | +| [IncorrectPasswordException()](#IncorrectPasswordException--) | Initializes a new instance of the IncorrectPasswordException class. | +| [IncorrectPasswordException(String message, Throwable throwable)](#IncorrectPasswordException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the IncorrectPasswordException class with a specified error message. | ### IncorrectPasswordException() {#IncorrectPasswordException--} ``` public IncorrectPasswordException() ``` -Initializes a new instance of the [IncorrectPasswordException](../../com.groupdocs.viewer.exception/incorrectpasswordexception) class. +Initializes a new instance of the IncorrectPasswordException class. ### IncorrectPasswordException(String message, Throwable throwable) {#IncorrectPasswordException-java.lang.String-java.lang.Throwable-} ``` @@ -33,7 +33,7 @@ public IncorrectPasswordException(String message, Throwable throwable) ``` -Initializes a new instance of the [IncorrectPasswordException](../../com.groupdocs.viewer.exception/incorrectpasswordexception) class with a specified error message. +Initializes a new instance of the IncorrectPasswordException class with a specified error message. **Parameters:** | Parameter | Type | Description | diff --git a/english/java/com.groupdocs.viewer.exception/notsupportedexception/_index.md b/english/java/com.groupdocs.viewer.exception/notsupportedexception/_index.md index 3d7754ccb..173aca761 100644 --- a/english/java/com.groupdocs.viewer.exception/notsupportedexception/_index.md +++ b/english/java/com.groupdocs.viewer.exception/notsupportedexception/_index.md @@ -1,7 +1,7 @@ --- title: NotSupportedException second_title: GroupDocs.Viewer for Java API Reference -description: The exception that is thrown when the operation is not supported. +description: This exception is thrown when the requested operation is not supported. type: docs weight: 14 url: /java/com.groupdocs.viewer.exception/notsupportedexception/ @@ -12,23 +12,25 @@ java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeExc public class NotSupportedException extends GroupDocsViewerException ``` -The exception that is thrown when the operation is not supported. +This exception is thrown when the requested operation is not supported. It indicates that the current operation is not supported by the underlying system or implementation. ## Constructors | Constructor | Description | | --- | --- | -| [NotSupportedException(String message)](#NotSupportedException-java.lang.String-) | | -| [NotSupportedException(String message, Throwable throwable)](#NotSupportedException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the [NotSupportedException](../../com.groupdocs.viewer.exception/notsupportedexception) class with a specified error message. | +| [NotSupportedException(String message)](#NotSupportedException-java.lang.String-) | Initializes a new instance of the NotSupportedException class with a specified error message. | +| [NotSupportedException(String message, Throwable throwable)](#NotSupportedException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the NotSupportedException class with a specified error message and the cause of the exception. | ### NotSupportedException(String message) {#NotSupportedException-java.lang.String-} ``` public NotSupportedException(String message) ``` +Initializes a new instance of the NotSupportedException class with a specified error message. + **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | | +| message | java.lang.String | The message. | ### NotSupportedException(String message, Throwable throwable) {#NotSupportedException-java.lang.String-java.lang.Throwable-} ``` @@ -36,7 +38,7 @@ public NotSupportedException(String message, Throwable throwable) ``` -Initializes a new instance of the [NotSupportedException](../../com.groupdocs.viewer.exception/notsupportedexception) class with a specified error message. +Initializes a new instance of the NotSupportedException class with a specified error message and the cause of the exception. **Parameters:** | Parameter | Type | Description | diff --git a/english/java/com.groupdocs.viewer.exception/passwordrequiredexception/_index.md b/english/java/com.groupdocs.viewer.exception/passwordrequiredexception/_index.md index fc06fa664..f337a18a5 100644 --- a/english/java/com.groupdocs.viewer.exception/passwordrequiredexception/_index.md +++ b/english/java/com.groupdocs.viewer.exception/passwordrequiredexception/_index.md @@ -1,7 +1,7 @@ --- title: PasswordRequiredException second_title: GroupDocs.Viewer for Java API Reference -description: The exception that is thrown when password is required to load the document. +description: This exception is thrown when a password is required to load the document. type: docs weight: 15 url: /java/com.groupdocs.viewer.exception/passwordrequiredexception/ @@ -12,20 +12,20 @@ java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeExc public class PasswordRequiredException extends GroupDocsViewerException ``` -The exception that is thrown when password is required to load the document. +This exception is thrown when a password is required to load the document. This exception typically occurs when attempting to load or open a document that is encrypted or password-protected without providing valid password. ## Constructors | Constructor | Description | | --- | --- | -| [PasswordRequiredException()](#PasswordRequiredException--) | Initializes a new instance of the [PasswordRequiredException](../../com.groupdocs.viewer.exception/passwordrequiredexception) class. | -| [PasswordRequiredException(String message, Throwable throwable)](#PasswordRequiredException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the [PasswordRequiredException](../../com.groupdocs.viewer.exception/passwordrequiredexception) class with a specified error message. | +| [PasswordRequiredException()](#PasswordRequiredException--) | Initializes a new instance of the PasswordRequiredException class. | +| [PasswordRequiredException(String message, Throwable throwable)](#PasswordRequiredException-java.lang.String-java.lang.Throwable-) | Initializes a new instance of the PasswordRequiredException class with a specified error message. | ### PasswordRequiredException() {#PasswordRequiredException--} ``` public PasswordRequiredException() ``` -Initializes a new instance of the [PasswordRequiredException](../../com.groupdocs.viewer.exception/passwordrequiredexception) class. +Initializes a new instance of the PasswordRequiredException class. ### PasswordRequiredException(String message, Throwable throwable) {#PasswordRequiredException-java.lang.String-java.lang.Throwable-} ``` @@ -33,7 +33,7 @@ public PasswordRequiredException(String message, Throwable throwable) ``` -Initializes a new instance of the [PasswordRequiredException](../../com.groupdocs.viewer.exception/passwordrequiredexception) class with a specified error message. +Initializes a new instance of the PasswordRequiredException class with a specified error message. **Parameters:** | Parameter | Type | Description | diff --git a/english/java/com.groupdocs.viewer.fonts/_index.md b/english/java/com.groupdocs.viewer.fonts/_index.md index eb240a101..9f82509cb 100644 --- a/english/java/com.groupdocs.viewer.fonts/_index.md +++ b/english/java/com.groupdocs.viewer.fonts/_index.md @@ -1,20 +1,31 @@ --- title: com.groupdocs.viewer.fonts second_title: GroupDocs.Viewer for Java API Reference -description: The package provides classes classes and enumerations to manage fonts used during rendering process. +description: The package provides classes and enumerations to manage fonts used during the rendering process. type: docs weight: 14 url: /java/com.groupdocs.viewer.fonts/ --- -The package provides classes classes and enumerations to manage fonts used during rendering process. +The package provides classes and enumerations to manage fonts used during the rendering process. + +The main classes and interfaces in this package are: + + * [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) - Represents a folder that contains TrueType fonts. + * [FontSettings](../../com.groupdocs.viewer.fonts/fontsettings) - Provides methods for working with sources to look for TrueType fonts. + * [FontSource](../../com.groupdocs.viewer.fonts/fontsource) - Marker interface for the font sources. + +For more details on working with fonts in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Classes | Class | Description | | --- | --- | -| [FolderFontSource](../com.groupdocs.viewer.fonts/folderfontsource) | Represents the folder that contains TrueType fonts. | +| [FolderFontSource](../com.groupdocs.viewer.fonts/folderfontsource) | Represents a folder that contains TrueType fonts. | | [FontSettings](../com.groupdocs.viewer.fonts/fontsettings) | Provides methods for working with sources to look for TrueType fonts. | ## Interfaces diff --git a/english/java/com.groupdocs.viewer.fonts/folderfontsource/_index.md b/english/java/com.groupdocs.viewer.fonts/folderfontsource/_index.md index 3480c1cd7..dc3200efc 100644 --- a/english/java/com.groupdocs.viewer.fonts/folderfontsource/_index.md +++ b/english/java/com.groupdocs.viewer.fonts/folderfontsource/_index.md @@ -1,7 +1,7 @@ --- title: FolderFontSource second_title: GroupDocs.Viewer for Java API Reference -description: Represents the folder that contains TrueType fonts. +description: Represents a folder that contains TrueType fonts. type: docs weight: 10 url: /java/com.groupdocs.viewer.fonts/folderfontsource/ @@ -15,24 +15,34 @@ java.lang.Object public final class FolderFontSource implements FontSource, System.IEquatable ``` -Represents the folder that contains TrueType fonts. +Represents a folder that contains TrueType fonts. + +The FolderFontSource class is used to specify a folder location that contains TrueType fonts. It allows the GroupDocs.Viewer API to access the fonts stored in the specified folder for document rendering purposes. + +Example usage: + +``` + + FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS)); + +``` ## Constructors | Constructor | Description | | --- | --- | -| [FolderFontSource(String folderPath, SearchOption searchOption)](#FolderFontSource-java.lang.String-com.groupdocs.viewer.fonts.SearchOption-) | Initializes new instance of [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) class. | +| [FolderFontSource(String folderPath, SearchOption searchOption)](#FolderFontSource-java.lang.String-com.groupdocs.viewer.fonts.SearchOption-) | Initializes a new instance of the FolderFontSource class. | ## Methods | Method | Description | | --- | --- | -| [isEqualTo(FolderFontSource left, FolderFontSource right)](#isEqualTo-com.groupdocs.viewer.fonts.FolderFontSource-com.groupdocs.viewer.fonts.FolderFontSource-) | Determines whether two [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) objects are the same. | -| [isNotEqualTo(FolderFontSource left, FolderFontSource right)](#isNotEqualTo-com.groupdocs.viewer.fonts.FolderFontSource-com.groupdocs.viewer.fonts.FolderFontSource-) | Determines whether two [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) objects are not the same. | -| [getFolderPath()](#getFolderPath--) | Path to the folder that contains TrueType fonts. | -| [getSearchOption()](#getSearchOption--) | Specifies whether to search the current folder, or the current folder and all subfolders. | -| [isRecursive()](#isRecursive--) | Checks if fonts would be searched recursively | -| [equals(FolderFontSource other)](#equals-com.groupdocs.viewer.fonts.FolderFontSource-) | Determines whether the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) is the same as specified [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | -| [equals(Object o)](#equals-java.lang.Object-) | Determines whether the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) is the same as specified object. | -| [hashCode()](#hashCode--) | Returns the hash code for the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | +| [isEqualTo(FolderFontSource left, FolderFontSource right)](#isEqualTo-com.groupdocs.viewer.fonts.FolderFontSource-com.groupdocs.viewer.fonts.FolderFontSource-) | Determines whether two FolderFontSource objects are the same. | +| [isNotEqualTo(FolderFontSource left, FolderFontSource right)](#isNotEqualTo-com.groupdocs.viewer.fonts.FolderFontSource-com.groupdocs.viewer.fonts.FolderFontSource-) | Determines whether two FolderFontSource objects are not the same. | +| [getFolderPath()](#getFolderPath--) | Gets the path to the folder that contains TrueType fonts. | +| [getSearchOption()](#getSearchOption--) | Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders. | +| [isRecursive()](#isRecursive--) | Checks if the fonts would be searched recursively. | +| [equals(FolderFontSource other)](#equals-com.groupdocs.viewer.fonts.FolderFontSource-) | Determines whether the current FolderFontSource is the same as the specified FolderFontSource object. | +| [equals(Object o)](#equals-java.lang.Object-) | Determines whether the current FolderFontSource is the same as the specified object. | +| [hashCode()](#hashCode--) | Returns the hash code for the current FolderFontSource object. | | [toString()](#toString--) | Returns a string that represents the current object. | ### FolderFontSource(String folderPath, SearchOption searchOption) {#FolderFontSource-java.lang.String-com.groupdocs.viewer.fonts.SearchOption-} ``` @@ -40,7 +50,7 @@ public FolderFontSource(String folderPath, SearchOption searchOption) ``` -Initializes new instance of [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) class. +Initializes a new instance of the FolderFontSource class. **Parameters:** | Parameter | Type | Description | @@ -54,102 +64,102 @@ public static boolean isEqualTo(FolderFontSource left, FolderFontSource right) ``` -Determines whether two [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) objects are the same. +Determines whether two FolderFontSource objects are the same. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| left | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | Left [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | -| right | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | Right [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | +| left | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | The left FolderFontSource object. | +| right | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | The right FolderFontSource object. | **Returns:** -boolean - true if both [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) objects are the same; otherwise, false +boolean - true if both FolderFontSource objects are the same; otherwise, false . ### isNotEqualTo(FolderFontSource left, FolderFontSource right) {#isNotEqualTo-com.groupdocs.viewer.fonts.FolderFontSource-com.groupdocs.viewer.fonts.FolderFontSource-} ``` public static boolean isNotEqualTo(FolderFontSource left, FolderFontSource right) ``` -Determines whether two [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) objects are not the same. +Determines whether two FolderFontSource objects are not the same. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| left | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | Left [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | -| right | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | Right [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | +| left | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | The left FolderFontSource object. | +| right | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | The right FolderFontSource object. | **Returns:** -boolean - \{@code true if both \{@link FolderFontSource\} objects are not the same; otherwise, \{@code false\} +boolean - true if both FolderFontSource objects are not the same; otherwise, false . ### getFolderPath() {#getFolderPath--} ``` public final String getFolderPath() ``` -Path to the folder that contains TrueType fonts. +Gets the path to the folder that contains TrueType fonts. **Returns:** -java.lang.String +java.lang.String - the path to the folder that contains TrueType fonts. ### getSearchOption() {#getSearchOption--} ``` public final SearchOption getSearchOption() ``` -Specifies whether to search the current folder, or the current folder and all subfolders. +Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders. **Returns:** -[SearchOption](../../com.groupdocs.viewer.fonts/searchoption) - whether to search the current folder, or the current folder and all subfolders. +[SearchOption](../../com.groupdocs.viewer.fonts/searchoption) - the search option. ### isRecursive() {#isRecursive--} ``` public boolean isRecursive() ``` -Checks if fonts would be searched recursively +Checks if the fonts would be searched recursively. **Returns:** -boolean - true if recursively, otherwise false +boolean - true if the fonts would be searched recursively, false otherwise. ### equals(FolderFontSource other) {#equals-com.groupdocs.viewer.fonts.FolderFontSource-} ``` public final boolean equals(FolderFontSource other) ``` -Determines whether the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) is the same as specified [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. +Determines whether the current FolderFontSource is the same as the specified FolderFontSource object. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| other | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | The object to compare with the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | +| other | [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) | The object to compare with the current FolderFontSource object. | **Returns:** -boolean - true if both [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) objects are the same; otherwise, false +boolean - true if both FolderFontSource objects are the same; otherwise, false ### equals(Object o) {#equals-java.lang.Object-} ``` public boolean equals(Object o) ``` -Determines whether the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) is the same as specified object. +Determines whether the current FolderFontSource is the same as the specified object. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| o | java.lang.Object | The object to compare with the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. | +| o | java.lang.Object | The object to compare with the current FolderFontSource object. | **Returns:** -boolean - true if obj parameter is [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) and is the same as current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object; otherwise, false +boolean - true if the obj parameter is of type FolderFontSource and is the same as the current FolderFontSource object; otherwise, false ### hashCode() {#hashCode--} ``` public int hashCode() ``` -Returns the hash code for the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. +Returns the hash code for the current FolderFontSource object. **Returns:** -int - A hash code for the current [FolderFontSource](../../com.groupdocs.viewer.fonts/folderfontsource) object. +int - a hash code for the current FolderFontSource object. ### toString() {#toString--} ``` public String toString() @@ -159,4 +169,4 @@ public String toString() Returns a string that represents the current object. **Returns:** -java.lang.String - A string that represents the current object. +java.lang.String - a string that represents the current object. diff --git a/english/java/com.groupdocs.viewer.fonts/fontsettings/_index.md b/english/java/com.groupdocs.viewer.fonts/fontsettings/_index.md index a6f7fd595..f16fef78a 100644 --- a/english/java/com.groupdocs.viewer.fonts/fontsettings/_index.md +++ b/english/java/com.groupdocs.viewer.fonts/fontsettings/_index.md @@ -13,6 +13,16 @@ public class FontSettings ``` Provides methods for working with sources to look for TrueType fonts. + +The FontSettings class is used to specify and manage sources for locating TrueType fonts. It provides methods to add and reset font sources for the GroupDocs.Viewer API. + +Example usage: + +``` + + FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS)); + +``` ## Constructors | Constructor | Description | @@ -22,8 +32,8 @@ Provides methods for working with sources to look for TrueType fonts. | Method | Description | | --- | --- | -| [setFontSources(FontSource[] fontSources)](#setFontSources-com.groupdocs.viewer.fonts.FontSource...-) | Set the sources to look for TrueType fonts when rendering documents. | -| [resetFontSources()](#resetFontSources--) | Resets font sources that have been set before. | +| [setFontSources(FontSource[] fontSources)](#setFontSources-com.groupdocs.viewer.fonts.FontSource...-) | Sets the sources to look for TrueType fonts when rendering documents. | +| [resetFontSources()](#resetFontSources--) | Resets the font sources that have been set before. | ### FontSettings() {#FontSettings--} ``` public FontSettings() @@ -36,12 +46,12 @@ public static void setFontSources(FontSource[] fontSources) ``` -Set the sources to look for TrueType fonts when rendering documents. +Sets the sources to look for TrueType fonts when rendering documents. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fontSources | [FontSource\[\]](../../com.groupdocs.viewer.fonts/fontsource) | The font sources. | +| fontSources | [FontSource\[\]](../../com.groupdocs.viewer.fonts/fontsource) | The font sources to set. | ### resetFontSources() {#resetFontSources--} ``` @@ -49,5 +59,5 @@ public static void resetFontSources() ``` -Resets font sources that have been set before. +Resets the font sources that have been set before. diff --git a/english/java/com.groupdocs.viewer.fonts/fontsource/_index.md b/english/java/com.groupdocs.viewer.fonts/fontsource/_index.md index a44fbfab4..228eea5e4 100644 --- a/english/java/com.groupdocs.viewer.fonts/fontsource/_index.md +++ b/english/java/com.groupdocs.viewer.fonts/fontsource/_index.md @@ -10,3 +10,7 @@ public interface FontSource ``` Marker interface for the font sources. + +The FontSource interface serves as a marker interface for all types of font sources used in the GroupDocs.Viewer API. + +***Note:** This is a marker interface and does not define any additional methods or functionality. Its purpose is to categorize and identify font source implementations.* diff --git a/english/java/com.groupdocs.viewer.fonts/searchoption/_index.md b/english/java/com.groupdocs.viewer.fonts/searchoption/_index.md index 9c8d5eff9..ca53ebe20 100644 --- a/english/java/com.groupdocs.viewer.fonts/searchoption/_index.md +++ b/english/java/com.groupdocs.viewer.fonts/searchoption/_index.md @@ -13,6 +13,18 @@ public enum SearchOption extends Enum ``` Specifies whether to search the current folder, or the current folder and all subfolders. + +The SearchOption enum is used to specify the scope of font search operation in the GroupDocs.Viewer API. + +Example usage: + +``` + + FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS)); + +``` + +***Note:** This enum is typically used to specify strategy of searching fonts in provided directory.* ## Fields | Field | Description | diff --git a/english/java/com.groupdocs.viewer.interfaces/_index.md b/english/java/com.groupdocs.viewer.interfaces/_index.md index 32ff1854a..5237f53a4 100644 --- a/english/java/com.groupdocs.viewer.interfaces/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/_index.md @@ -1,27 +1,40 @@ --- title: com.groupdocs.viewer.interfaces second_title: GroupDocs.Viewer for Java API Reference -description: The package provides interfaces to instantiate and release output document and its resources. +description: The package provides interfaces for instantiating and releasing the output document and its resources. type: docs weight: 15 url: /java/com.groupdocs.viewer.interfaces/ --- -The package provides interfaces to instantiate and release output document and it's resources. +The package provides interfaces for instantiating and releasing the output document and its resources. + +These interfaces are used to manage the creation and release of streams and URLs associated with the output file, pages, and HTML resources. + +The main interfaces in this package are: + + * [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) - Represents an interface for instantiating a stream used to write output file data. + * [FileStreamFactory](../../com.groupdocs.viewer.interfaces/filestreamfactory) - Defines methods for instantiating and releasing the output file stream. + * [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) - Releases a stream that was instantiated by a method associated with the CreatePageStream interface. + +For more details on working with these interfaces and customizing the output document and resource handling in GroupDocs.Viewer, lease refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Interfaces | Interface | Description | | --- | --- | -| [CreateFileStream](../com.groupdocs.viewer.interfaces/createfilestream) | Represents interface that instantiates stream used to write output file data. | -| [CreatePageStream](../com.groupdocs.viewer.interfaces/createpagestream) | Represents interface that instantiates stream used to write output page data. | -| [CreateResourceStream](../com.groupdocs.viewer.interfaces/createresourcestream) | Represents interface that instantiates stream used to write output HTML resource data. | -| [CreateResourceUrl](../com.groupdocs.viewer.interfaces/createresourceurl) | Represents interface that creates URL for HTML resource. | -| [FileReader](../com.groupdocs.viewer.interfaces/filereader) | Declares method for reading file stream. | -| [FileStreamFactory](../com.groupdocs.viewer.interfaces/filestreamfactory) | Defines methods which are required for instantiating and releasing output file stream. | -| [PageStreamFactory](../com.groupdocs.viewer.interfaces/pagestreamfactory) | Defines the methods that are required for instantiating and releasing output page stream. | -| [ReleaseFileStream](../com.groupdocs.viewer.interfaces/releasefilestream) | Releases interface which was instantiated by the method associated with [CreateFileStream](../com.groupdocs.viewer.interfaces/createfilestream) interface. | -| [ReleasePageStream](../com.groupdocs.viewer.interfaces/releasepagestream) | Releases stream which was instantiated by the method associated with [CreatePageStream](../com.groupdocs.viewer.interfaces/createpagestream) interface. | -| [ReleaseResourceStream](../com.groupdocs.viewer.interfaces/releaseresourcestream) | Releases stream which was instantiated by the method associated with [CreateResourceStream](../com.groupdocs.viewer.interfaces/createresourcestream) interface. | -| [ResourceStreamFactory](../com.groupdocs.viewer.interfaces/resourcestreamfactory) | Defines the methods that are required for creating resource URL, instantiating and releasing output HTML resource stream. | +| [CreateFileStream](../com.groupdocs.viewer.interfaces/createfilestream) | Represents an interface that instantiates a stream used to write output file data. | +| [CreatePageStream](../com.groupdocs.viewer.interfaces/createpagestream) | Represents an interface that instantiates a stream used to write output page data. | +| [CreateResourceStream](../com.groupdocs.viewer.interfaces/createresourcestream) | Represents an interface that instantiates a stream used to write output HTML resource data. | +| [CreateResourceUrl](../com.groupdocs.viewer.interfaces/createresourceurl) | Represents an interface that creates a URL for an HTML resource. | +| [FileReader](../com.groupdocs.viewer.interfaces/filereader) | Declares an interface for reading a file stream. | +| [FileStreamFactory](../com.groupdocs.viewer.interfaces/filestreamfactory) | Defines methods that are required for instantiating and releasing an output file stream. | +| [PageStreamFactory](../com.groupdocs.viewer.interfaces/pagestreamfactory) | Defines the methods that are required for instantiating and releasing an output page stream. | +| [ReleaseFileStream](../com.groupdocs.viewer.interfaces/releasefilestream) | Releases an interface that was instantiated by the method associated with the CreateFileStream interface. | +| [ReleasePageStream](../com.groupdocs.viewer.interfaces/releasepagestream) | Releases a stream that was instantiated by the method associated with the CreatePageStream interface. | +| [ReleaseResourceStream](../com.groupdocs.viewer.interfaces/releaseresourcestream) | Releases a stream that was instantiated by the method associated with the CreateResourceStream interface. | +| [ResourceStreamFactory](../com.groupdocs.viewer.interfaces/resourcestreamfactory) | Defines the methods that are required for creating a resource URL, instantiating, and releasing an output HTML resource stream. | diff --git a/english/java/com.groupdocs.viewer.interfaces/createfilestream/_index.md b/english/java/com.groupdocs.viewer.interfaces/createfilestream/_index.md index 97a77a91b..7c97942f5 100644 --- a/english/java/com.groupdocs.viewer.interfaces/createfilestream/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/createfilestream/_index.md @@ -1,7 +1,7 @@ --- title: CreateFileStream second_title: GroupDocs.Viewer for Java API Reference -description: Represents interface that instantiates stream used to write output file data. +description: Represents an interface that instantiates a stream used to write output file data. type: docs weight: 10 url: /java/com.groupdocs.viewer.interfaces/createfilestream/ @@ -9,19 +9,32 @@ url: /java/com.groupdocs.viewer.interfaces/createfilestream/ public interface CreateFileStream ``` -Represents interface that instantiates stream used to write output file data. +Represents an interface that instantiates a stream used to write output file data. + +The CreateFileStream interface is a functional interface that provides a method for instantiating a stream used to write data to an output file. Implementing classes or lambdas can use this interface to customize the creation of the output file stream based on specific requirements. + +Example usage: + +``` + + CreateFileStream createFileStream = (filePath) -> new FileOutputStream(filePath); + PdfViewOptions pdfViewOptions = new PdfViewOptions(createFileStream); + +``` + +***Note:** The CreateFileStream interface can be used to define different strategies for creating output file streams, such as using a FileOutputStream or any other custom stream implementation.* ## Methods | Method | Description | | --- | --- | -| [invoke()](#invoke--) | The method must return OutputStream that will be used to write output file data. | +| [invoke()](#invoke--) | Returns an OutputStream that will be used to write output file data. | ### invoke() {#invoke--} ``` public abstract OutputStream invoke() ``` -The method must return OutputStream that will be used to write output file data. +Returns an OutputStream that will be used to write output file data. **Returns:** -java.io.OutputStream - The stream used to write output file data. +java.io.OutputStream - the stream used to write output file data. diff --git a/english/java/com.groupdocs.viewer.interfaces/createpagestream/_index.md b/english/java/com.groupdocs.viewer.interfaces/createpagestream/_index.md index 01de444d6..de26b0e3e 100644 --- a/english/java/com.groupdocs.viewer.interfaces/createpagestream/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/createpagestream/_index.md @@ -1,7 +1,7 @@ --- title: CreatePageStream second_title: GroupDocs.Viewer for Java API Reference -description: Represents interface that instantiates stream used to write output page data. +description: Represents an interface that instantiates a stream used to write output page data. type: docs weight: 11 url: /java/com.groupdocs.viewer.interfaces/createpagestream/ @@ -9,24 +9,35 @@ url: /java/com.groupdocs.viewer.interfaces/createpagestream/ public interface CreatePageStream ``` -Represents interface that instantiates stream used to write output page data. +Represents an interface that instantiates a stream used to write output page data. + +The CreatePageStream interface is a functional interface that provides a method for creating a stream to write the output page data. It can be implemented by custom classes to define the behavior of generating and writing page data to a stream. + +Example usage: + +``` + + CreatePageStream createPageStream = pageNumber -> new FileOutputStream("page-" + pageNumber + ".html"); + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(createPageStream); + +``` ## Methods | Method | Description | | --- | --- | -| [invoke(int pageNumber)](#invoke-int-) | The method must return OutputStream that will be used to write output page data. | +| [invoke(int pageNumber)](#invoke-int-) | Returns an OutputStream that will be used to write output page data. | ### invoke(int pageNumber) {#invoke-int-} ``` public abstract OutputStream invoke(int pageNumber) ``` -The method must return OutputStream that will be used to write output page data. +Returns an OutputStream that will be used to write output page data. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | Number of the page | +| pageNumber | int | Number of the page. | **Returns:** -java.io.OutputStream - The stream used to write output page data. +java.io.OutputStream - the stream used to write output page data. diff --git a/english/java/com.groupdocs.viewer.interfaces/createresourcestream/_index.md b/english/java/com.groupdocs.viewer.interfaces/createresourcestream/_index.md index 9c91271c8..af3ae401e 100644 --- a/english/java/com.groupdocs.viewer.interfaces/createresourcestream/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/createresourcestream/_index.md @@ -1,7 +1,7 @@ --- title: CreateResourceStream second_title: GroupDocs.Viewer for Java API Reference -description: Represents interface that instantiates stream used to write output HTML resource data. +description: Represents an interface that instantiates a stream used to write output HTML resource data. type: docs weight: 12 url: /java/com.groupdocs.viewer.interfaces/createresourcestream/ @@ -9,25 +9,37 @@ url: /java/com.groupdocs.viewer.interfaces/createresourcestream/ public interface CreateResourceStream ``` -Represents interface that instantiates stream used to write output HTML resource data. +Represents an interface that instantiates a stream used to write output HTML resource data. + +The CreateResourceStream interface is a functional interface that provides a method for creating a stream to write the output HTML resource data. It can be implemented by custom classes to define the behavior of generating and writing HTML resource data to a stream. + +Example usage: + +``` + + CreateResourceStream createResourceStream = (pageNumber, resource) + -> new FileOutputStream("file-" + pageNumber + "-" + resource.getFileName()); + HtmlViewOptions.forExternalResources(pageStreamFactory, createResourceStream); + +``` ## Methods | Method | Description | | --- | --- | -| [invoke(int pageNumber, Resource resource)](#invoke-int-com.groupdocs.viewer.results.Resource-) | The method must return OutputStream that will be used to write output HTML resource data. | +| [invoke(int pageNumber, Resource resource)](#invoke-int-com.groupdocs.viewer.results.Resource-) | Returns an OutputStream that will be used to write output HTML resource data. | ### invoke(int pageNumber, Resource resource) {#invoke-int-com.groupdocs.viewer.results.Resource-} ``` public abstract OutputStream invoke(int pageNumber, Resource resource) ``` -The method must return OutputStream that will be used to write output HTML resource data. +Returns an OutputStream that will be used to write output HTML resource data. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | pageNumber | int | Number of the page. | -| resource | [Resource](../../com.groupdocs.viewer.results/resource) | HTML resource such as font, style, image or graphics. | +| resource | [Resource](../../com.groupdocs.viewer.results/resource) | HTML resource such as font, style, image, or graphics. | **Returns:** -java.io.OutputStream - The stream used to write output HTML resource data. +java.io.OutputStream - the stream used to write output HTML resource data. diff --git a/english/java/com.groupdocs.viewer.interfaces/createresourceurl/_index.md b/english/java/com.groupdocs.viewer.interfaces/createresourceurl/_index.md index 14da1f495..6c4538f74 100644 --- a/english/java/com.groupdocs.viewer.interfaces/createresourceurl/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/createresourceurl/_index.md @@ -1,7 +1,7 @@ --- title: CreateResourceUrl second_title: GroupDocs.Viewer for Java API Reference -description: Represents interface that creates URL for HTML resource. +description: Represents an interface that creates a URL for an HTML resource. type: docs weight: 13 url: /java/com.groupdocs.viewer.interfaces/createresourceurl/ @@ -9,25 +9,36 @@ url: /java/com.groupdocs.viewer.interfaces/createresourceurl/ public interface CreateResourceUrl ``` -Represents interface that creates URL for HTML resource. +Represents an interface that creates a URL for an HTML resource. + +The CreateResourceUrl interface is a functional interface that provides a method for creating a URL for an HTML resource. It can be implemented by custom classes to define the behavior of generating a URL for accessing HTML resources. + +Example usage: + +``` + + CreateResourceUrl createResourceUrl = (pageNumber, resource) -> "resource-" + pageNumber + "-" + resource.getFileName(); + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(createPageStream, createResourceStream, createResourceUrl); + +``` ## Methods | Method | Description | | --- | --- | -| [invoke(int pageNumber, Resource resource)](#invoke-int-com.groupdocs.viewer.results.Resource-) | Represents the method that creates URL for HTML resource. | +| [invoke(int pageNumber, Resource resource)](#invoke-int-com.groupdocs.viewer.results.Resource-) | Represents the method that creates a URL for an HTML resource. | ### invoke(int pageNumber, Resource resource) {#invoke-int-com.groupdocs.viewer.results.Resource-} ``` public abstract String invoke(int pageNumber, Resource resource) ``` -Represents the method that creates URL for HTML resource. +Represents the method that creates a URL for an HTML resource. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | pageNumber | int | Number of the page. | -| resource | [Resource](../../com.groupdocs.viewer.results/resource) | HTML resource such as font, style, image or graphics. | +| resource | [Resource](../../com.groupdocs.viewer.results/resource) | HTML resource such as font, style, image, or graphics. | **Returns:** -java.lang.String +java.lang.String - the URL for the HTML resource. diff --git a/english/java/com.groupdocs.viewer.interfaces/filereader/_index.md b/english/java/com.groupdocs.viewer.interfaces/filereader/_index.md index c43c30eac..45329026a 100644 --- a/english/java/com.groupdocs.viewer.interfaces/filereader/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/filereader/_index.md @@ -1,7 +1,7 @@ --- title: FileReader second_title: GroupDocs.Viewer for Java API Reference -description: Declares method for reading file stream. +description: Declares an interface for reading a file stream. type: docs weight: 14 url: /java/com.groupdocs.viewer.interfaces/filereader/ @@ -12,12 +12,35 @@ java.io.Closeable public interface FileReader extends Closeable ``` -Declares method for reading file stream. +Declares an interface for reading a file stream. + +The FileReader interface provides a method for reading a file stream. It is used for accessing and reading the contents of a file in a sequential manner. Implementations of this interface should handle the necessary operations to read data from a file. + +Example usage: + +``` + + FileReader fileReader = new FileReader() { + @Override + public InputStream read() { + // Create document stream + } + + @Override + public void close() { + // Close the stream + } + }; + try (Viewer viewer = new Viewer(fileReader, new ViewerSettings())){ + // Process document + } + +``` ## Methods | Method | Description | | --- | --- | -| [read()](#read--) | The method that returns file stream. | +| [read()](#read--) | Returns an InputStream that represents a readable stream for the file. | | [close()](#close--) | Disposes the object and releases any system resources associated with it. | ### read() {#read--} ``` @@ -25,10 +48,10 @@ public abstract InputStream read() ``` -The method that returns file stream. +Returns an InputStream that represents a readable stream for the file. **Returns:** -java.io.InputStream - InputStream readable stream. +java.io.InputStream - the InputStream readable stream. ### close() {#close--} ``` public abstract void close() diff --git a/english/java/com.groupdocs.viewer.interfaces/filestreamfactory/_index.md b/english/java/com.groupdocs.viewer.interfaces/filestreamfactory/_index.md index 70bb95e54..20347b7f6 100644 --- a/english/java/com.groupdocs.viewer.interfaces/filestreamfactory/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/filestreamfactory/_index.md @@ -1,7 +1,7 @@ --- title: FileStreamFactory second_title: GroupDocs.Viewer for Java API Reference -description: Defines methods which are required for instantiating and releasing output file stream. +description: Defines methods that are required for instantiating and releasing an output file stream. type: docs weight: 15 url: /java/com.groupdocs.viewer.interfaces/filestreamfactory/ @@ -9,33 +9,56 @@ url: /java/com.groupdocs.viewer.interfaces/filestreamfactory/ public interface FileStreamFactory ``` -Defines methods which are required for instantiating and releasing output file stream. +Defines methods that are required for instantiating and releasing an output file stream. + +The FileStreamFactory interface declares methods that are used to create and release an output file stream. Implementations of this interface should provide the necessary functionality to create a file stream for writing output file data, as well as release any resources associated with the file stream. + +Example usage: + +``` + + FileStreamFactory fileStreamFactory = new FileStreamFactory() { + @Override + public OutputStream createFileStream() { + // Custom implementation to create and return an output file stream for the specified file path + } + + @Override + public void closeFileStream(OutputStream fileStream) { + // Custom implementation to release any resources associated with the output file stream + } + }; + + PdfViewOptions pdfViewOptions = new PdfViewOptions(fileStreamFactory); + // Use pdfViewOptions in Viewer + +``` ## Methods | Method | Description | | --- | --- | -| [createFileStream()](#createFileStream--) | The method that returns readable stream. | -| [closeFileStream(OutputStream fileStream)](#closeFileStream-java.io.OutputStream-) | Releases the stream created by \#createFileStream().createFileStream() method. | +| [createFileStream()](#createFileStream--) | The method that returns a readable stream. | +| [closeFileStream(OutputStream fileStream)](#closeFileStream-java.io.OutputStream-) | Releases the stream created by the \#createFileStream().createFileStream() method. | ### createFileStream() {#createFileStream--} ``` public abstract OutputStream createFileStream() ``` -The method that returns readable stream. +The method that returns a readable stream. **Returns:** -java.io.OutputStream - OutputStream used to write output file data. +java.io.OutputStream - the OutputStream used to write output file data. ### closeFileStream(OutputStream fileStream) {#closeFileStream-java.io.OutputStream-} ``` public abstract void closeFileStream(OutputStream fileStream) ``` -Releases the stream created by \#createFileStream().createFileStream() method. +Releases the stream created by the \#createFileStream().createFileStream() method. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileStream | java.io.OutputStream | OutputStream created by \#createFileStream().createFileStream() method. | +| fileStream | java.io.OutputStream | The OutputStream created by the \#createFileStream().createFileStream() method. | diff --git a/english/java/com.groupdocs.viewer.interfaces/pagestreamfactory/_index.md b/english/java/com.groupdocs.viewer.interfaces/pagestreamfactory/_index.md index 914b7e551..a9c5dac7f 100644 --- a/english/java/com.groupdocs.viewer.interfaces/pagestreamfactory/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/pagestreamfactory/_index.md @@ -1,7 +1,7 @@ --- title: PageStreamFactory second_title: GroupDocs.Viewer for Java API Reference -description: Defines the methods that are required for instantiating and releasing output page stream. +description: Defines the methods that are required for instantiating and releasing an output page stream. type: docs weight: 16 url: /java/com.groupdocs.viewer.interfaces/pagestreamfactory/ @@ -9,7 +9,29 @@ url: /java/com.groupdocs.viewer.interfaces/pagestreamfactory/ public interface PageStreamFactory ``` -Defines the methods that are required for instantiating and releasing output page stream. +Defines the methods that are required for instantiating and releasing an output page stream. + +The PageStreamFactory interface declares methods that are used to create and release an output page stream. Implementations of this interface should provide the necessary functionality to create a page stream for writing output page data, as well as release any resources associated with the page stream. + +Example usage: + +``` + + final PageStreamFactory pageStreamFactory = new PageStreamFactory() { + public OutputStream createPageStream(int pageNumber) { + // Custom implementation to create and return an output page stream for the specified page number + } + + @Override + public void closePageStream(int pageNumber, OutputStream pageStream) { + // Custom implementation to release any resources associated with the output page stream + } + }; + + PngViewOptions pngViewOptions = new PngViewOptions(pageStreamFactory); + // Use pngViewOptions in Viewer + +``` ## Methods | Method | Description | @@ -27,10 +49,10 @@ Creates the stream used to write output page data. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | The number of a page. | +| pageNumber | int | The number of the page. | **Returns:** -java.io.OutputStream - OutputStream used to write output page data. +java.io.OutputStream - the OutputStream used to write output page data. ### closePageStream(int pageNumber, OutputStream pageStream) {#closePageStream-int-java.io.OutputStream-} ``` public abstract void closePageStream(int pageNumber, OutputStream pageStream) @@ -42,6 +64,6 @@ Releases the stream created by \#createPageStream(int).createPageStream(int) met **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | The number of a page. | -| pageStream | java.io.OutputStream | OutputStream created by \#createPageStream(int).createPageStream(int) method. | +| pageNumber | int | The number of the page. | +| pageStream | java.io.OutputStream | The OutputStream created by \#createPageStream(int).createPageStream(int) method. | diff --git a/english/java/com.groupdocs.viewer.interfaces/releasefilestream/_index.md b/english/java/com.groupdocs.viewer.interfaces/releasefilestream/_index.md index 30d066d90..d0d1db191 100644 --- a/english/java/com.groupdocs.viewer.interfaces/releasefilestream/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/releasefilestream/_index.md @@ -1,7 +1,7 @@ --- title: ReleaseFileStream second_title: GroupDocs.Viewer for Java API Reference -description: Releases interface which was instantiated by the method associated with interface. +description: Releases an interface that was instantiated by the method associated with the CreateFileStream interface. type: docs weight: 17 url: /java/com.groupdocs.viewer.interfaces/releasefilestream/ @@ -9,22 +9,37 @@ url: /java/com.groupdocs.viewer.interfaces/releasefilestream/ public interface ReleaseFileStream ``` -Releases interface which was instantiated by the method associated with [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) interface. +Releases an interface that was instantiated by the method associated with the CreateFileStream interface. + +The ReleaseFileStream interface represents a functional interface that declares a method to release a closeable that was previously instantiated by the corresponding method in the [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) interface. Implementations of this interface should provide the necessary functionality to release any resources associated with the object. + +Example usage: + +``` + + ReleaseFileStream releaseFileStream = (fileStream) -> { + // Custom implementation to release any resources associated with the file stream + }; + + PdfViewOptions pdfViewOptions = new PdfViewOptions(createFileStream, releaseFileStream); + // Use pdfViewOptions in Viewer + +``` ## Methods | Method | Description | | --- | --- | -| [invoke(Closeable fileStream)](#invoke-java.io.Closeable-) | Releases stream which was instantiated by the method associated with [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) interface. | +| [invoke(Closeable fileStream)](#invoke-java.io.Closeable-) | Releases the stream created by the method associated with the [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) interface. | ### invoke(Closeable fileStream) {#invoke-java.io.Closeable-} ``` public abstract void invoke(Closeable fileStream) ``` -Releases stream which was instantiated by the method associated with [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) interface. +Releases the stream created by the method associated with the [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) interface. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileStream | java.io.Closeable | The stream created by the method associated with [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) interface. | +| fileStream | java.io.Closeable | The stream to be released. | diff --git a/english/java/com.groupdocs.viewer.interfaces/releasepagestream/_index.md b/english/java/com.groupdocs.viewer.interfaces/releasepagestream/_index.md index 87452fbb3..8608e01f6 100644 --- a/english/java/com.groupdocs.viewer.interfaces/releasepagestream/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/releasepagestream/_index.md @@ -1,7 +1,7 @@ --- title: ReleasePageStream second_title: GroupDocs.Viewer for Java API Reference -description: Releases stream which was instantiated by the method associated with interface. +description: Releases a stream that was instantiated by the method associated with the CreatePageStream interface. type: docs weight: 18 url: /java/com.groupdocs.viewer.interfaces/releasepagestream/ @@ -9,23 +9,38 @@ url: /java/com.groupdocs.viewer.interfaces/releasepagestream/ public interface ReleasePageStream ``` -Releases stream which was instantiated by the method associated with [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) interface. +Releases a stream that was instantiated by the method associated with the CreatePageStream interface. + +The ReleasePageStream interface represents a functional interface that declares a method to release a stream that was previously instantiated by the corresponding method in the [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) interface. Implementations of this interface should provide the necessary functionality to release any resources associated with the stream. + +Example usage: + +``` + + ReleasePageStream releasePageStream = ((pageNumber, pageStream) -> { + // Custom implementation to release any resources associated with the file stream + }; + + PngViewOptions pngViewOptions = new PngViewOptions(createPageStream, releasePageStream); + // Use pngViewOptions in Viewer + +``` ## Methods | Method | Description | | --- | --- | -| [invoke(int pageNumber, Closeable pageStream)](#invoke-int-java.io.Closeable-) | Releases stream which was instantiated by the method associated with [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) interface. | +| [invoke(int pageNumber, Closeable pageStream)](#invoke-int-java.io.Closeable-) | Releases the stream created by the method associated with the [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) interface. | ### invoke(int pageNumber, Closeable pageStream) {#invoke-int-java.io.Closeable-} ``` public abstract void invoke(int pageNumber, Closeable pageStream) ``` -Releases stream which was instantiated by the method associated with [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) interface. +Releases the stream created by the method associated with the [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) interface. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | | -| pageStream | java.io.Closeable | | +| pageNumber | int | The number of the page. | +| pageStream | java.io.Closeable | The stream to be released. | diff --git a/english/java/com.groupdocs.viewer.interfaces/releaseresourcestream/_index.md b/english/java/com.groupdocs.viewer.interfaces/releaseresourcestream/_index.md index 54b98f60b..15499d4a0 100644 --- a/english/java/com.groupdocs.viewer.interfaces/releaseresourcestream/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/releaseresourcestream/_index.md @@ -1,7 +1,7 @@ --- title: ReleaseResourceStream second_title: GroupDocs.Viewer for Java API Reference -description: Releases stream which was instantiated by the method associated with interface. +description: Releases a stream that was instantiated by the method associated with the CreateResourceStream interface. type: docs weight: 19 url: /java/com.groupdocs.viewer.interfaces/releaseresourcestream/ @@ -9,24 +9,39 @@ url: /java/com.groupdocs.viewer.interfaces/releaseresourcestream/ public interface ReleaseResourceStream ``` -Releases stream which was instantiated by the method associated with [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) interface. +Releases a stream that was instantiated by the method associated with the CreateResourceStream interface. + +The ReleaseResourceStream interface represents a functional interface that declares a method to release a stream that was previously instantiated by the corresponding method in the [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) interface. Implementations of this interface should provide the necessary functionality to release any resources associated with the stream. + +Example usage: + +``` + + ReleaseResourceStream releaseResourceStream = ((pageNumber, resource, resourceStream) -> { + // Custom implementation to release any resources associated with the resource stream + }; + + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(createPageStream, createResourceStream, releaseResourceStream); + // Use htmlViewOptions in Viewer + +``` ## Methods | Method | Description | | --- | --- | -| [invoke(int pageNumber, Resource resource, OutputStream resourceStream)](#invoke-int-com.groupdocs.viewer.results.Resource-java.io.OutputStream-) | Releases stream which was instantiated by the method associated with [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) interface. | +| [invoke(int pageNumber, Resource resource, OutputStream resourceStream)](#invoke-int-com.groupdocs.viewer.results.Resource-java.io.OutputStream-) | Releases the stream created by the method associated with the [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) interface. | ### invoke(int pageNumber, Resource resource, OutputStream resourceStream) {#invoke-int-com.groupdocs.viewer.results.Resource-java.io.OutputStream-} ``` public abstract void invoke(int pageNumber, Resource resource, OutputStream resourceStream) ``` -Releases stream which was instantiated by the method associated with [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) interface. +Releases the stream created by the method associated with the [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) interface. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | | -| resource | [Resource](../../com.groupdocs.viewer.results/resource) | | -| resourceStream | java.io.OutputStream | | +| pageNumber | int | The number of the page. | +| resource | [Resource](../../com.groupdocs.viewer.results/resource) | The resource associated with the stream. | +| resourceStream | java.io.OutputStream | The stream to be released. | diff --git a/english/java/com.groupdocs.viewer.interfaces/resourcestreamfactory/_index.md b/english/java/com.groupdocs.viewer.interfaces/resourcestreamfactory/_index.md index c2f14032a..9025b4566 100644 --- a/english/java/com.groupdocs.viewer.interfaces/resourcestreamfactory/_index.md +++ b/english/java/com.groupdocs.viewer.interfaces/resourcestreamfactory/_index.md @@ -1,7 +1,7 @@ --- title: ResourceStreamFactory second_title: GroupDocs.Viewer for Java API Reference -description: Defines the methods that are required for creating resource URL instantiating and releasing output HTML resource stream. +description: Defines the methods that are required for creating a resource URL instantiating and releasing an output HTML resource stream. type: docs weight: 20 url: /java/com.groupdocs.viewer.interfaces/resourcestreamfactory/ @@ -9,14 +9,42 @@ url: /java/com.groupdocs.viewer.interfaces/resourcestreamfactory/ public interface ResourceStreamFactory ``` -Defines the methods that are required for creating resource URL, instantiating and releasing output HTML resource stream. +Defines the methods that are required for creating a resource URL, instantiating, and releasing an output HTML resource stream. + +The ResourceStreamFactory interface provides the necessary methods for creating a resource URL, as well as instantiating and releasing an output HTML resource stream. Implementations of this interface should provide the functionality to handle the creation, instantiation, and release of the resource stream and URL. + +Example usage: + +``` + + ResourceStreamFactory resourceStreamFactory = new ResourceStreamFactory() { + @Override + public OutputStream createResourceStream(int pageNumber, Resource resource) { + // Custom implementation to create an output HTML resource stream based on the given resource URL + } + + @Override + public String createResourceUrl(int pageNumber, Resource resource) { + // Custom implementation to create a resource URL based on the given resource name + } + + @Override + public void closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream) { + // Custom implementation to release any resources associated with the resource stream + } + }; + + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(pageStreamFactory, resourceStreamFactory); + // Use htmlViewOptions in Viewer + +``` ## Methods | Method | Description | | --- | --- | | [createResourceStream(int pageNumber, Resource resource)](#createResourceStream-int-com.groupdocs.viewer.results.Resource-) | Creates the stream used to write output HTML resource data. | -| [createResourceUrl(int pageNumber, Resource resource)](#createResourceUrl-int-com.groupdocs.viewer.results.Resource-) | Creates the URL for HTML resource. | -| [closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream)](#closeResourceStream-int-com.groupdocs.viewer.results.Resource-java.io.OutputStream-) | Releases the stream created by [createResourceStream(int, Resource)](../../com.groupdocs.viewer.interfaces/resourcestreamfactory\#createResourceStream-int--Resource-) method. | +| [createResourceUrl(int pageNumber, Resource resource)](#createResourceUrl-int-com.groupdocs.viewer.results.Resource-) | Creates the URL for the specified HTML resource based on the page number and resource type. | +| [closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream)](#closeResourceStream-int-com.groupdocs.viewer.results.Resource-java.io.OutputStream-) | Releases the stream created by the [createResourceStream(int, Resource)](../../com.groupdocs.viewer.interfaces/resourcestreamfactory\#createResourceStream-int--Resource-) method for the specified page number and HTML resource. | ### createResourceStream(int pageNumber, Resource resource) {#createResourceStream-int-com.groupdocs.viewer.results.Resource-} ``` public abstract OutputStream createResourceStream(int pageNumber, Resource resource) @@ -28,39 +56,39 @@ Creates the stream used to write output HTML resource data. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | The number of a page. | -| resource | [Resource](../../com.groupdocs.viewer.results/resource) | The HTML resource such as font, style, image or graphics. | +| pageNumber | int | The number of the page. | +| resource | [Resource](../../com.groupdocs.viewer.results/resource) | The HTML resource such as font, style, image, or graphics. | **Returns:** -java.io.OutputStream - OutputStream used to write output resource data. +java.io.OutputStream - the stream used to write output resource data. ### createResourceUrl(int pageNumber, Resource resource) {#createResourceUrl-int-com.groupdocs.viewer.results.Resource-} ``` public abstract String createResourceUrl(int pageNumber, Resource resource) ``` -Creates the URL for HTML resource. +Creates the URL for the specified HTML resource based on the page number and resource type. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | The number of a page. | -| resource | [Resource](../../com.groupdocs.viewer.results/resource) | The HTML resource such as font, style, image or graphics. | +| pageNumber | int | The number of the page that contains the resource. | +| resource | [Resource](../../com.groupdocs.viewer.results/resource) | The HTML resource such as font, style, image, or graphics. | **Returns:** -java.lang.String - URL for HTML resource. +java.lang.String - the URL string representing the location of the HTML resource. ### closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream) {#closeResourceStream-int-com.groupdocs.viewer.results.Resource-java.io.OutputStream-} ``` public abstract void closeResourceStream(int pageNumber, Resource resource, OutputStream resourceStream) ``` -Releases the stream created by [createResourceStream(int, Resource)](../../com.groupdocs.viewer.interfaces/resourcestreamfactory\#createResourceStream-int--Resource-) method. +Releases the stream created by the [createResourceStream(int, Resource)](../../com.groupdocs.viewer.interfaces/resourcestreamfactory\#createResourceStream-int--Resource-) method for the specified page number and HTML resource. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageNumber | int | The number of a page. | -| resource | [Resource](../../com.groupdocs.viewer.results/resource) | The HTML resource such as font, style, image or graphics. | -| resourceStream | java.io.OutputStream | OutputStream created by [createResourceStream(int, Resource)](../../com.groupdocs.viewer.interfaces/resourcestreamfactory\#createResourceStream-int--Resource-) method. | +| pageNumber | int | The number of the page that contains the resource. | +| resource | [Resource](../../com.groupdocs.viewer.results/resource) | The HTML resource such as font, style, image, or graphics. | +| resourceStream | java.io.OutputStream | The OutputStream created by the [createResourceStream(int, Resource)](../../com.groupdocs.viewer.interfaces/resourcestreamfactory\#createResourceStream-int--Resource-) method. | diff --git a/english/java/com.groupdocs.viewer.logging/_index.md b/english/java/com.groupdocs.viewer.logging/_index.md index ea0d9b89f..b4bd0528a 100644 --- a/english/java/com.groupdocs.viewer.logging/_index.md +++ b/english/java/com.groupdocs.viewer.logging/_index.md @@ -1,18 +1,30 @@ --- title: com.groupdocs.viewer.logging second_title: GroupDocs.Viewer for Java API Reference -description: The package provides classes for configuring logging system. +description: The package provides classes for configuring the logging system in GroupDocs.Viewer. type: docs weight: 16 url: /java/com.groupdocs.viewer.logging/ --- -The package provides classes for configuring logging system. +The package provides classes for configuring the logging system in GroupDocs.Viewer. + +By using these classes, you can control how log messages are handled, such as writing them to a file or directing them to a specific logger implementation. + +The main classes in this package are: + + * [FileLogger](../../com.groupdocs.viewer.logging/filelogger) - Writes log messages to a file. + * [ViewerLogger](../../com.groupdocs.viewer.logging/viewerlogger) - Implements logging messages to an integrated or user-defined logger. + +For more details on configuring the logging system in GroupDocs.Viewer and customizing the log message handling, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Classes | Class | Description | | --- | --- | -| [FileLogger](../com.groupdocs.viewer.logging/filelogger) | Writes log messages to the file. | -| [ViewerLogger](../com.groupdocs.viewer.logging/viewerlogger) | Global viewer logger Implements logging messages to integrated or user defined logger. | +| [FileLogger](../com.groupdocs.viewer.logging/filelogger) | Writes log messages to a file. | +| [ViewerLogger](../com.groupdocs.viewer.logging/viewerlogger) | Global viewer logger. | diff --git a/english/java/com.groupdocs.viewer.logging/filelogger/_index.md b/english/java/com.groupdocs.viewer.logging/filelogger/_index.md index 817a82284..8e13c1167 100644 --- a/english/java/com.groupdocs.viewer.logging/filelogger/_index.md +++ b/english/java/com.groupdocs.viewer.logging/filelogger/_index.md @@ -1,7 +1,7 @@ --- title: FileLogger second_title: GroupDocs.Viewer for Java API Reference -description: Writes log messages to the file. +description: Writes log messages to a file. type: docs weight: 10 url: /java/com.groupdocs.viewer.logging/filelogger/ @@ -15,13 +15,35 @@ com.groupdocs.foundation.logging.ILogger public class FileLogger implements ILogger ``` -Writes log messages to the file. +Writes log messages to a file. + +The FileLogger class provides functionality to write log messages to a file. It implements the ILogger interface and can be used to log various events and messages in an application. Log messages are written to the specified file. + +Example usage: + +``` + + // Create a new instance of FileLogger with the specified log file path + FileLogger fileLogger = new FileLogger("/path/to/logfile.txt"); + + // Log an informational message + fileLogger.debug("Debug message"); + + // Log an error message + fileLogger.error("Error message"); + + // Check is logging warning messages enabled + boolean warningEnabled = fileLogger.isWarningEnabled(); + +``` + +***Note:** The FileLogger class provides basic logging functionality. You can extend this class to add custom log levels or additional logging features as per your requirements.* ## Constructors | Constructor | Description | | --- | --- | -| [FileLogger(String fileName)](#FileLogger-java.lang.String-) | Create logger to file. | -| [FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)](#FileLogger-java.lang.String-boolean-boolean-boolean-boolean-) | Create logger to file. | +| [FileLogger(String fileName)](#FileLogger-java.lang.String-) | Creates a logger that logs messages to a file specified by the provided file name. | +| [FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)](#FileLogger-java.lang.String-boolean-boolean-boolean-boolean-) | Creates a logger that logs messages to a file with specified logging levels. | ## Fields | Field | Description | @@ -33,29 +55,29 @@ Writes log messages to the file. | Method | Description | | --- | --- | | [trace(String message, Object[] arguments)](#trace-java.lang.String-java.lang.Object...-) | Writes a trace message to the console. | -| [trace(Throwable throwable, String message, Object[] arguments)](#trace-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a trace message to the console. | -| [isTraceEnabled()](#isTraceEnabled--) | | -| [debug(String message, Object[] arguments)](#debug-java.lang.String-java.lang.Object...-) | Writes a debug message to the console. | -| [debug(Throwable throwable, String message, Object[] arguments)](#debug-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a debug message to the console. | -| [isDebugEnabled()](#isDebugEnabled--) | | -| [warning(String message, Object[] arguments)](#warning-java.lang.String-java.lang.Object...-) | Writes a warning message to the console. | -| [warning(Throwable throwable, String message, Object[] arguments)](#warning-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a warning message to the console. | -| [isWarningEnabled()](#isWarningEnabled--) | | -| [error(String message, Object[] arguments)](#error-java.lang.String-java.lang.Object...-) | Writes an error message to the console. | -| [error(Throwable throwable, String message, Object[] arguments)](#error-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes an error message to the console. | -| [isErrorEnabled()](#isErrorEnabled--) | | +| [trace(Throwable throwable, String message, Object[] arguments)](#trace-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a trace log message to the console. | +| [isTraceEnabled()](#isTraceEnabled--) | Checks if the trace level is enabled for logging. | +| [debug(String message, Object[] arguments)](#debug-java.lang.String-java.lang.Object...-) | Writes a debug log message to the console. | +| [debug(Throwable throwable, String message, Object[] arguments)](#debug-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a debug log message to the console. | +| [isDebugEnabled()](#isDebugEnabled--) | Checks if the debug level is enabled for logging. | +| [warning(String message, Object[] arguments)](#warning-java.lang.String-java.lang.Object...-) | Writes a warning log message to the console. | +| [warning(Throwable throwable, String message, Object[] arguments)](#warning-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a warning log message to the console. | +| [isWarningEnabled()](#isWarningEnabled--) | Checks if the warning level is enabled for logging. | +| [error(String message, Object[] arguments)](#error-java.lang.String-java.lang.Object...-) | Writes an error log message to the console. | +| [error(Throwable throwable, String message, Object[] arguments)](#error-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes an error log message to the console. | +| [isErrorEnabled()](#isErrorEnabled--) | Checks if error-level logging is enabled. | ### FileLogger(String fileName) {#FileLogger-java.lang.String-} ``` public FileLogger(String fileName) ``` -Create logger to file. +Creates a logger that logs messages to a file specified by the provided file name. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileName | java.lang.String | Full file name with path | +| fileName | java.lang.String | The full file name with path. | ### FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled) {#FileLogger-java.lang.String-boolean-boolean-boolean-boolean-} ``` @@ -63,16 +85,16 @@ public FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnable ``` -Create logger to file. +Creates a logger that logs messages to a file with specified logging levels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileName | java.lang.String | | -| isTraceEnabled | boolean | | -| isDebugEnabled | boolean | | -| isWarningEnabled | boolean | | -| isErrorEnabled | boolean | | +| fileName | java.lang.String | The full file name with path. | +| isTraceEnabled | boolean | Specifies whether trace level logging is enabled. | +| isDebugEnabled | boolean | Specifies whether debug level logging is enabled. | +| isWarningEnabled | boolean | Specifies whether warning level logging is enabled. | +| isErrorEnabled | boolean | Specifies whether error level logging is enabled. | ### MESSAGE {#MESSAGE} ``` @@ -98,7 +120,7 @@ Writes a trace message to the console. Trace log messages provide generally usef | Parameter | Type | Description | | --- | --- | --- | | message | java.lang.String | The trace message. | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in order of passing. | ### trace(Throwable throwable, String message, Object[] arguments) {#trace-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -106,14 +128,14 @@ public void trace(Throwable throwable, String message, Object[] arguments) ``` -Writes a trace message to the console. Trace log messages provide generally useful information about application flow. +Writes a trace log message to the console. Trace log messages provide generally useful information about the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception | -| message | java.lang.String | The trace message. | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the trace log message. | +| message | java.lang.String | The trace log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isTraceEnabled() {#isTraceEnabled--} ``` @@ -121,23 +143,23 @@ public boolean isTraceEnabled() ``` -Checks is trace logging enabled +Checks if the trace level is enabled for logging. **Returns:** -boolean +boolean - true if the trace level is enabled, false otherwise. ### debug(String message, Object[] arguments) {#debug-java.lang.String-java.lang.Object...-} ``` public void debug(String message, Object[] arguments) ``` -Writes a debug message to the console. Debug log messages provide information about different processes in application flow. +Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The debug message. | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| message | java.lang.String | The debug log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### debug(Throwable throwable, String message, Object[] arguments) {#debug-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -145,14 +167,14 @@ public void debug(Throwable throwable, String message, Object[] arguments) ``` -Writes a debug message to the console. Debug log messages provide information about different processes in application flow. +Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception | -| message | java.lang.String | The debug message. | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the debug log message. | +| message | java.lang.String | The debug log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isDebugEnabled() {#isDebugEnabled--} ``` @@ -160,23 +182,23 @@ public boolean isDebugEnabled() ``` -Checks is debug logging enabled +Checks if the debug level is enabled for logging. **Returns:** -boolean +boolean - true if the debug level is enabled, false otherwise. ### warning(String message, Object[] arguments) {#warning-java.lang.String-java.lang.Object...-} ``` public void warning(String message, Object[] arguments) ``` -Writes a warning message to the console. Warning log messages provide information about unexpected and recoverable events in application flow. +Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The warning message. | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| message | java.lang.String | The warning log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### warning(Throwable throwable, String message, Object[] arguments) {#warning-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -184,14 +206,14 @@ public void warning(Throwable throwable, String message, Object[] arguments) ``` -Writes a warning message to the console. Warning log messages provide information about unexpected and recoverable events in application flow. +Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception | -| message | java.lang.String | The warning message. | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the warning log message. | +| message | java.lang.String | The warning log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isWarningEnabled() {#isWarningEnabled--} ``` @@ -199,23 +221,23 @@ public boolean isWarningEnabled() ``` -Checks is warning logging enabled +Checks if the warning level is enabled for logging. **Returns:** -boolean +boolean - true if the warning level is enabled, false otherwise. ### error(String message, Object[] arguments) {#error-java.lang.String-java.lang.Object...-} ``` public void error(String message, Object[] arguments) ``` -Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow. +Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The error message | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| message | java.lang.String | The error log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### error(Throwable throwable, String message, Object[] arguments) {#error-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -223,14 +245,14 @@ public void error(Throwable throwable, String message, Object[] arguments) ``` -Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow. +Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception | -| message | java.lang.String | The error message | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the error log message. | +| message | java.lang.String | The error log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isErrorEnabled() {#isErrorEnabled--} ``` @@ -238,7 +260,7 @@ public boolean isErrorEnabled() ``` -Checks is error logging enabled +Checks if error-level logging is enabled. **Returns:** -boolean +boolean - true if error-level logging is enabled, false otherwise. diff --git a/english/java/com.groupdocs.viewer.logging/viewerlogger/_index.md b/english/java/com.groupdocs.viewer.logging/viewerlogger/_index.md index 4e845b88b..bb0a158fb 100644 --- a/english/java/com.groupdocs.viewer.logging/viewerlogger/_index.md +++ b/english/java/com.groupdocs.viewer.logging/viewerlogger/_index.md @@ -1,7 +1,7 @@ --- title: ViewerLogger second_title: GroupDocs.Viewer for Java API Reference -description: Global viewer logger Implements logging messages to integrated or user defined logger. +description: Global viewer logger. type: docs weight: 11 url: /java/com.groupdocs.viewer.logging/viewerlogger/ @@ -12,7 +12,26 @@ java.lang.Object public class ViewerLogger ``` -Global viewer logger Implements logging messages to integrated or user defined logger. +Global viewer logger. + +The ViewerLogger class provides functionality to log messages to an integrated or user-defined logger. It serves as the global logger for the viewer module and can be used to log various events and messages. + +Example usage: + +``` + + // Configure the viewer logger to use the default integrated logger + ViewerLogger.setLogger(new FileLogger("/path/to/file.log")); + + // Log an debug message + ViewerLogger.debug("Debug message"); + + // Log an error message + ViewerLogger.error("Error message"); + +``` + +***Note:** The ViewerLogger class can be configured to use a custom logger implementation by calling the [setLogger(ILogger)](../../com.groupdocs.viewer.logging/viewerlogger\#setLogger-ILogger-) method. By default, it uses the integrated logger provided by the viewer module.* ## Constructors | Constructor | Description | @@ -22,20 +41,20 @@ Global viewer logger Implements logging messages to integrated or user defined l | Method | Description | | --- | --- | -| [trace(String message, Object[] arguments)](#trace-java.lang.String-java.lang.Object...-) | Trace message | -| [trace(Throwable throwable, String message, Object[] arguments)](#trace-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Trace message | -| [isTraceEnabled()](#isTraceEnabled--) | Checks is trace logging enabled | -| [debug(String message, Object[] arguments)](#debug-java.lang.String-java.lang.Object...-) | Debug message | -| [debug(Throwable throwable, String message, Object[] arguments)](#debug-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Debug message | -| [isDebugEnabled()](#isDebugEnabled--) | Checks is debug logging enabled | -| [warning(String message, Object[] arguments)](#warning-java.lang.String-java.lang.Object...-) | Warning message | -| [warning(Throwable throwable, String message, Object[] arguments)](#warning-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Warning message | -| [isWarningEnabled()](#isWarningEnabled--) | Checks is warning logging enabled | -| [error(String message, Object[] arguments)](#error-java.lang.String-java.lang.Object...-) | Error message | -| [error(Throwable throwable, String message, Object[] arguments)](#error-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Error message | -| [isErrorEnabled()](#isErrorEnabled--) | Checks is error logging enabled | -| [getLogger()](#getLogger--) | | -| [setLogger(ILogger logger)](#setLogger-com.groupdocs.foundation.logging.ILogger-) | Sets the logger. | +| [trace(String message, Object[] arguments)](#trace-java.lang.String-java.lang.Object...-) | Writes a trace message to the console. | +| [trace(Throwable throwable, String message, Object[] arguments)](#trace-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a trace log message to the console. | +| [isTraceEnabled()](#isTraceEnabled--) | Checks if the trace level is enabled for logging. | +| [debug(String message, Object[] arguments)](#debug-java.lang.String-java.lang.Object...-) | Writes a debug log message to the console. | +| [debug(Throwable throwable, String message, Object[] arguments)](#debug-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a debug log message to the console. | +| [isDebugEnabled()](#isDebugEnabled--) | Checks if the debug level is enabled for logging. | +| [warning(String message, Object[] arguments)](#warning-java.lang.String-java.lang.Object...-) | Writes a warning log message to the console. | +| [warning(Throwable throwable, String message, Object[] arguments)](#warning-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes a warning log message to the console. | +| [isWarningEnabled()](#isWarningEnabled--) | Checks if the warning level is enabled for logging. | +| [error(String message, Object[] arguments)](#error-java.lang.String-java.lang.Object...-) | Writes an error log message to the console. | +| [error(Throwable throwable, String message, Object[] arguments)](#error-java.lang.Throwable-java.lang.String-java.lang.Object...-) | Writes an error log message to the console. | +| [isErrorEnabled()](#isErrorEnabled--) | Checks if error-level logging is enabled. | +| [getLogger()](#getLogger--) | Gets the logger instance that will be used for logging messages. | +| [setLogger(ILogger logger)](#setLogger-com.groupdocs.foundation.logging.ILogger-) | Sets the logger instance that will be used for logging messages. | ### ViewerLogger() {#ViewerLogger--} ``` public ViewerLogger() @@ -48,13 +67,13 @@ public static void trace(String message, Object[] arguments) ``` -Trace message +Writes a trace message to the console. Trace log messages provide generally useful information about application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The trace message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| message | java.lang.String | The trace message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in order of passing. | ### trace(Throwable throwable, String message, Object[] arguments) {#trace-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -62,14 +81,14 @@ public static void trace(Throwable throwable, String message, Object[] arguments ``` -Trace message +Writes a trace log message to the console. Trace log messages provide generally useful information about the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception message | -| message | java.lang.String | The trace message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the trace log message. | +| message | java.lang.String | The trace log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isTraceEnabled() {#isTraceEnabled--} ``` @@ -77,23 +96,23 @@ public static boolean isTraceEnabled() ``` -Checks is trace logging enabled +Checks if the trace level is enabled for logging. **Returns:** -boolean - true if enabled +boolean - true if the trace level is enabled, false otherwise. ### debug(String message, Object[] arguments) {#debug-java.lang.String-java.lang.Object...-} ``` public static void debug(String message, Object[] arguments) ``` -Debug message +Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The debug message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| message | java.lang.String | The debug log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### debug(Throwable throwable, String message, Object[] arguments) {#debug-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -101,14 +120,14 @@ public static void debug(Throwable throwable, String message, Object[] arguments ``` -Debug message +Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception message | -| message | java.lang.String | The debug message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the debug log message. | +| message | java.lang.String | The debug log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isDebugEnabled() {#isDebugEnabled--} ``` @@ -116,23 +135,23 @@ public static boolean isDebugEnabled() ``` -Checks is debug logging enabled +Checks if the debug level is enabled for logging. **Returns:** -boolean - true if enabled +boolean - true if the debug level is enabled, false otherwise. ### warning(String message, Object[] arguments) {#warning-java.lang.String-java.lang.Object...-} ``` public static void warning(String message, Object[] arguments) ``` -Warning message +Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The warning message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| message | java.lang.String | The warning log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### warning(Throwable throwable, String message, Object[] arguments) {#warning-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -140,14 +159,14 @@ public static void warning(Throwable throwable, String message, Object[] argumen ``` -Warning message +Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception message | -| message | java.lang.String | The warning message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the warning log message. | +| message | java.lang.String | The warning log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isWarningEnabled() {#isWarningEnabled--} ``` @@ -155,23 +174,23 @@ public static boolean isWarningEnabled() ``` -Checks is warning logging enabled +Checks if the warning level is enabled for logging. **Returns:** -boolean - true if enabled +boolean - true if the warning level is enabled, false otherwise. ### error(String message, Object[] arguments) {#error-java.lang.String-java.lang.Object...-} ``` public static void error(String message, Object[] arguments) ``` -Error message +Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| message | java.lang.String | The error message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| message | java.lang.String | The error log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### error(Throwable throwable, String message, Object[] arguments) {#error-java.lang.Throwable-java.lang.String-java.lang.Object...-} ``` @@ -179,14 +198,14 @@ public static void error(Throwable throwable, String message, Object[] arguments ``` -Error message +Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| throwable | java.lang.Throwable | The exception message | -| message | java.lang.String | The error message, can contains \{\} to be replaced with arguments | -| arguments | java.lang.Object[] | The arguments, replaces \{\} in message in order of passing | +| throwable | java.lang.Throwable | The exception associated with the error log message. | +| message | java.lang.String | The error log message. | +| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. | ### isErrorEnabled() {#isErrorEnabled--} ``` @@ -194,30 +213,30 @@ public static boolean isErrorEnabled() ``` -Checks is error logging enabled +Checks if error-level logging is enabled. **Returns:** -boolean - true if enabled +boolean - true if error-level logging is enabled, false otherwise. ### getLogger() {#getLogger--} ``` public static synchronized ILogger getLogger() ``` - +Gets the logger instance that will be used for logging messages. The logger instance can be used to log messages of different levels such as trace, debug, warning, and error. **Returns:** -com.groupdocs.foundation.logging.ILogger +com.groupdocs.foundation.logging.ILogger - the logger instance. ### setLogger(ILogger logger) {#setLogger-com.groupdocs.foundation.logging.ILogger-} ``` public static synchronized void setLogger(ILogger logger) ``` -Sets the logger. +Sets the logger instance that will be used for logging messages. The logger instance can be used to log messages of different levels such as trace, debug, warning, and error. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| logger | com.groupdocs.foundation.logging.ILogger | The input logger. | +| logger | com.groupdocs.foundation.logging.ILogger | The logger instance to set. | diff --git a/english/java/com.groupdocs.viewer.options/_index.md b/english/java/com.groupdocs.viewer.options/_index.md index b1acac13a..40fffd443 100644 --- a/english/java/com.groupdocs.viewer.options/_index.md +++ b/english/java/com.groupdocs.viewer.options/_index.md @@ -9,20 +9,33 @@ url: /java/com.groupdocs.viewer.options/ The package provides classes to specify additional options when rendering documents. +It includes options for rendering various document formats, defining permissions and security settings, specifying watermark properties, and retrieving information about views. + +The main classes in this package are: + + * [ArchiveOptions](../../com.groupdocs.viewer.options/archiveoptions) - Provides options for rendering archive files. + * [PdfOptions](../../com.groupdocs.viewer.options/pdfoptions) - Provides options for rendering PDF documents. + * [WordProcessingOptions](../../com.groupdocs.viewer.options/wordprocessingoptions) - Provides options for rendering word processing documents. + +For more details on configuring the logging system in GroupDocs.Viewer and customizing the log message handling, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ + ## Classes | Class | Description | | --- | --- | | [ArchiveOptions](../com.groupdocs.viewer.options/archiveoptions) | Provides options for rendering archive files. | -| [ArchiveSecurityOptions](../com.groupdocs.viewer.options/archivesecurityoptions) | Class that can be used to limit archives extraction process. | -| [BaseViewOptions](../com.groupdocs.viewer.options/baseviewoptions) | Provides base rendering options. | +| [ArchiveSecurityOptions](../com.groupdocs.viewer.options/archivesecurityoptions) | Class that can be used to limit the archives extraction process. | +| [BaseViewOptions](../com.groupdocs.viewer.options/baseviewoptions) | Class that provides base rendering options. | | [CadOptions](../com.groupdocs.viewer.options/cadoptions) | Provides options for rendering CAD drawings. | | [EmailOptions](../com.groupdocs.viewer.options/emailoptions) | Provides options for rendering email messages. | -| [FileName](../com.groupdocs.viewer.options/filename) | Represents name of simple file | +| [FileName](../com.groupdocs.viewer.options/filename) | Represents the name of a file in an archive. | | [HtmlViewOptions](../com.groupdocs.viewer.options/htmlviewoptions) | Provides options for rendering documents into HTML format. | | [JpgViewOptions](../com.groupdocs.viewer.options/jpgviewoptions) | Provides options for rendering documents into JPG format. | -| [LoadOptions](../com.groupdocs.viewer.options/loadoptions) | Provides options that used to open the file. | +| [LoadOptions](../com.groupdocs.viewer.options/loadoptions) | Provides options that are used to open a file. | | [MailStorageOptions](../com.groupdocs.viewer.options/mailstorageoptions) | Provides options for rendering Mail storage (Lotus Notes, MBox) data files. | | [OutlookOptions](../com.groupdocs.viewer.options/outlookoptions) | Provides options for rendering Outlook data files. | | [PdfOptions](../com.groupdocs.viewer.options/pdfoptions) | Provides options for rendering PDF documents. | diff --git a/english/java/com.groupdocs.viewer.options/archiveoptions/_index.md b/english/java/com.groupdocs.viewer.options/archiveoptions/_index.md index e010d926e..4aea2a745 100644 --- a/english/java/com.groupdocs.viewer.options/archiveoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/archiveoptions/_index.md @@ -13,49 +13,72 @@ public class ArchiveOptions ``` Provides options for rendering archive files. + +The ArchiveOptions class represents a set of options that can be used to configure the rendering of archive files in the viewer module. It allows you to customize various aspects of the rendering process, such as the count of items on each page and so on. + +Example usage: + +``` + + // Create an instance of ArchiveOptions + ArchiveOptions options = new ArchiveOptions(); + + // Set the count of items to be shown on each page + options.setItemsPerPage(16); + + // Create a Viewer instance with the specified options + try (final Viewer viewer = new Viewer(documentPath, options)) { + // Use the viewer object for document rendering + } + +``` + +***Note:** The ArchiveOptions class provides a range of customization options for rendering archive files. You can configure these options based on your specific requirements to achieve the desired output.* ## Constructors | Constructor | Description | | --- | --- | -| [ArchiveOptions()](#ArchiveOptions--) | | +| [ArchiveOptions()](#ArchiveOptions--) | Creates a new instance of the ArchiveOptions class with default settings. | ## Methods | Method | Description | | --- | --- | -| [getFolder()](#getFolder--) | The folder inside the archive to be rendered. | -| [setFolder(String value)](#setFolder-java.lang.String-) | The folder inside the archive to be rendered. | -| [getFileName()](#getFileName--) | The filename to display in the header. | -| [setFileName(FileName mFileName)](#setFileName-com.groupdocs.viewer.options.FileName-) | The filename to display in the header. | -| [getItemsPerPage()](#getItemsPerPage--) | Number of records per page (for rendering to HTML only) | -| [setItemsPerPage(int itemsPerPage)](#setItemsPerPage-int-) | Number of records per page (for rendering to HTML only) | +| [getFolder()](#getFolder--) | Gets the folder inside the archive that will be used for rendering. | +| [setFolder(String value)](#setFolder-java.lang.String-) | Sets the folder inside the archive that will be used for rendering. | +| [getFileName()](#getFileName--) | Gets the filename to be displayed in the header. | +| [setFileName(FileName fileName)](#setFileName-com.groupdocs.viewer.options.FileName-) | Sets the filename to be displayed in the header. | +| [getItemsPerPage()](#getItemsPerPage--) | Gets the number of records per page for rendering to HTML. | +| [setItemsPerPage(int itemsPerPage)](#setItemsPerPage-int-) | Sets the number of records per page for rendering to HTML. | ### ArchiveOptions() {#ArchiveOptions--} ``` public ArchiveOptions() ``` +Creates a new instance of the ArchiveOptions class with default settings. + ### getFolder() {#getFolder--} ``` public final String getFolder() ``` -The folder inside the archive to be rendered. +Gets the folder inside the archive that will be used for rendering. **Returns:** -java.lang.String +java.lang.String - the folder to be rendered. ### setFolder(String value) {#setFolder-java.lang.String-} ``` public final void setFolder(String value) ``` -The folder inside the archive to be rendered. +Sets the folder inside the archive that will be used for rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The folder to be rendered. | ### getFileName() {#getFileName--} ``` @@ -63,22 +86,22 @@ public FileName getFileName() ``` -The filename to display in the header. By default the name of the source file is displayed. +Gets the filename to be displayed in the header. By default, the name of the source file is displayed. **Returns:** -[FileName](../../com.groupdocs.viewer.options/filename) - The filename -### setFileName(FileName mFileName) {#setFileName-com.groupdocs.viewer.options.FileName-} +[FileName](../../com.groupdocs.viewer.options/filename) - the filename to be displayed. +### setFileName(FileName fileName) {#setFileName-com.groupdocs.viewer.options.FileName-} ``` -public void setFileName(FileName mFileName) +public void setFileName(FileName fileName) ``` -The filename to display in the header. By default the name of the source file is displayed. +Sets the filename to be displayed in the header. By default, the name of the source file is displayed. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| mFileName | [FileName](../../com.groupdocs.viewer.options/filename) | The filename | +| fileName | [FileName](../../com.groupdocs.viewer.options/filename) | The filename to be displayed. | ### getItemsPerPage() {#getItemsPerPage--} ``` @@ -86,20 +109,20 @@ public int getItemsPerPage() ``` -Number of records per page (for rendering to HTML only) +Gets the number of records per page for rendering to HTML. **Returns:** -int +int - the number of records per page. ### setItemsPerPage(int itemsPerPage) {#setItemsPerPage-int-} ``` public void setItemsPerPage(int itemsPerPage) ``` -Number of records per page (for rendering to HTML only) +Sets the number of records per page for rendering to HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| itemsPerPage | int | | +| itemsPerPage | int | The number of records per page. | diff --git a/english/java/com.groupdocs.viewer.options/archivesecurityoptions/_index.md b/english/java/com.groupdocs.viewer.options/archivesecurityoptions/_index.md index e44437884..617688e6d 100644 --- a/english/java/com.groupdocs.viewer.options/archivesecurityoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/archivesecurityoptions/_index.md @@ -1,7 +1,7 @@ --- title: ArchiveSecurityOptions second_title: GroupDocs.Viewer for Java API Reference -description: Class that can be used to limit archives extraction process. +description: Class that can be used to limit the archives extraction process. type: docs weight: 11 url: /java/com.groupdocs.viewer.options/archivesecurityoptions/ @@ -12,9 +12,31 @@ java.lang.Object public class ArchiveSecurityOptions ``` -Class that can be used to limit archives extraction process. +Class that can be used to limit the archives extraction process. -Note: Not each archive type supports all options. +The ArchiveSecurityOptions class provides a way to limit the extraction of archives and enforce certain restrictions. + +Example usage: + +``` + + ArchiveSecurityOptions securityOptions = new ArchiveSecurityOptions(); + securityOptions.setMaxAllowedEntryNameLength(255); + securityOptions.setMaxAllowedEntrySize(10737418240L); + securityOptions.setMaxAllowedEntriesCount(1000); + securityOptions.setMaxAllowedEntryCompressionRatio(100); + + final LoadOptions loadOptions = new LoadOptions(); + loadOptions.setArchiveSecurityOptions(securityOptions); + + // Create a Viewer instance with the specified options + try (final Viewer viewer = new Viewer(documentPath, loadOptions)) { + // Use the viewer object for archive document rendering + } + +``` + +***Note:** Not each archive type supports all options.* ## Constructors | Constructor | Description | @@ -24,14 +46,14 @@ Note: Not each archive type supports all options. | Method | Description | | --- | --- | -| [getMaxAllowedEntryNameLength()](#getMaxAllowedEntryNameLength--) | Archive entry name length can not be more than specified in this option. | -| [setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)](#setMaxAllowedEntryNameLength-int-) | Archive entry name length can not be more than specified in this option. | -| [getMaxAllowedEntrySize()](#getMaxAllowedEntrySize--) | Archive entry size can not be more than specified in this option. | -| [setMaxAllowedEntrySize(long maxAllowedEntrySize)](#setMaxAllowedEntrySize-long-) | Archive entry size can not be more than specified in this option. | -| [getMaxAllowedEntriesCount()](#getMaxAllowedEntriesCount--) | Archive that contains more entries, than specified in this option can not be extracted. | -| [setMaxAllowedEntriesCount(long maxAllowedEntriesCount)](#setMaxAllowedEntriesCount-long-) | Archive that contains more entries, than specified in this option can not be extracted. | -| [getMaxAllowedEntryCompressionRatio()](#getMaxAllowedEntryCompressionRatio--) | Archive entries which compression ratio is more, than specified in this option can not be extracted. | -| [setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)](#setMaxAllowedEntryCompressionRatio-double-) | Archive entries which compression ratio is more, than specified in this option can not be extracted. | +| [getMaxAllowedEntryNameLength()](#getMaxAllowedEntryNameLength--) | This option specifies the maximum length that an archive entry name can have. | +| [setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)](#setMaxAllowedEntryNameLength-int-) | Sets the maximum allowed length for the archive entry names. | +| [getMaxAllowedEntrySize()](#getMaxAllowedEntrySize--) | Retrieves the maximum allowed size for archive entries. | +| [setMaxAllowedEntrySize(long maxAllowedEntrySize)](#setMaxAllowedEntrySize-long-) | Sets the maximum allowed size for archive entries. | +| [getMaxAllowedEntriesCount()](#getMaxAllowedEntriesCount--) | Retrieves the maximum allowed count of entries in an archive. | +| [setMaxAllowedEntriesCount(long maxAllowedEntriesCount)](#setMaxAllowedEntriesCount-long-) | Sets the maximum allowed count of entries in an archive. | +| [getMaxAllowedEntryCompressionRatio()](#getMaxAllowedEntryCompressionRatio--) | Specifies the maximum compression ratio allowed for extracting archive entries. | +| [setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)](#setMaxAllowedEntryCompressionRatio-double-) | Specifies the maximum compression ratio allowed for extracting archive entries. | ### ArchiveSecurityOptions() {#ArchiveSecurityOptions--} ``` public ArchiveSecurityOptions() @@ -44,22 +66,26 @@ public int getMaxAllowedEntryNameLength() ``` -Archive entry name length can not be more than specified in this option. Default value is 255. +This option specifies the maximum length that an archive entry name can have. If an entry name exceeds this limit, it will cause an error. + +***Note:** The default value for this option is 255.* **Returns:** -int - Maximum archive entry name length +int - the maximum allowed length for the archive entry names. ### setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength) {#setMaxAllowedEntryNameLength-int-} ``` public void setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength) ``` -Archive entry name length can not be more than specified in this option. Default value is 255. +Sets the maximum allowed length for the archive entry names. The maximum allowed length specifies the limit for the length of an archive entry name. If the length of an entry name exceeds this limit, it will cause an error. + +***Note:** The default value for the maximum allowed entry name length is 255.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxAllowedEntryNameLength | int | Maximum archive entry name length. | +| maxAllowedEntryNameLength | int | The maximum archive entry name length to be set. | ### getMaxAllowedEntrySize() {#getMaxAllowedEntrySize--} ``` @@ -67,22 +93,26 @@ public long getMaxAllowedEntrySize() ``` -Archive entry size can not be more than specified in this option. Default value is 10Gb (10737418240L). +Retrieves the maximum allowed size for archive entries. The maximum allowed entry size specifies the limit for the size of an archive entry. If the size of an entry exceeds this limit, it will result in an error. + +***Note:** The default value for the maximum allowed entry size is 10GB (10737418240 bytes).* **Returns:** -long - Maximum archive entry size. +long - the maximum archive entry size. ### setMaxAllowedEntrySize(long maxAllowedEntrySize) {#setMaxAllowedEntrySize-long-} ``` public void setMaxAllowedEntrySize(long maxAllowedEntrySize) ``` -Archive entry size can not be more than specified in this option. Default value is 10Gb (10737418240L). +Sets the maximum allowed size for archive entries. The maximum allowed entry size specifies the limit for the size of an archive entry. If the size of an entry exceeds this limit, it will result in an error. + +***Note:** The default value for the maximum allowed entry size is 10GB (10737418240 bytes).* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxAllowedEntrySize | long | Maximum archive entry size | +| maxAllowedEntrySize | long | The maximum archive entry size. | ### getMaxAllowedEntriesCount() {#getMaxAllowedEntriesCount--} ``` @@ -90,22 +120,26 @@ public long getMaxAllowedEntriesCount() ``` -Archive that contains more entries, than specified in this option can not be extracted. Default value is 1000. +Retrieves the maximum allowed count of entries in an archive. The maximum allowed entries count specifies the limit for the number of entries that an archive can contain. If an archive contains more entries than this limit, it cannot be extracted. + +***Note:** The default value for the maximum allowed entries count is 1000.* **Returns:** -long - Maximum count of entries in an archive. +long - the maximum count of entries in an archive. ### setMaxAllowedEntriesCount(long maxAllowedEntriesCount) {#setMaxAllowedEntriesCount-long-} ``` public void setMaxAllowedEntriesCount(long maxAllowedEntriesCount) ``` -Archive that contains more entries, than specified in this option can not be extracted. Default value is 1000. +Sets the maximum allowed count of entries in an archive. The maximum allowed entries count specifies the limit for the number of entries that an archive can contain. If an archive contains more entries than this limit, it cannot be extracted. + +***Note:** The default value for the maximum allowed entries count is 1000.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxAllowedEntriesCount | long | Maximum count of entries in an archive. | +| maxAllowedEntriesCount | long | The maximum count of entries in an archive. | ### getMaxAllowedEntryCompressionRatio() {#getMaxAllowedEntryCompressionRatio--} ``` @@ -113,20 +147,24 @@ public double getMaxAllowedEntryCompressionRatio() ``` -Archive entries which compression ratio is more, than specified in this option can not be extracted. Default value is 100. +Specifies the maximum compression ratio allowed for extracting archive entries. + +***Note:** Archive entries with a compression ratio higher than the specified value cannot be extracted.* **Returns:** -double - Maximum allowed entries compression ratio. +double - the maximum allowed compression ratio for archive entries. ### setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio) {#setMaxAllowedEntryCompressionRatio-double-} ``` public void setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio) ``` -Archive entries which compression ratio is more, than specified in this option can not be extracted. Default value is 100. +Specifies the maximum compression ratio allowed for extracting archive entries. + +***Note:** Archive entries with a compression ratio higher than the specified value cannot be extracted.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxAllowedEntryCompressionRatio | double | Maximum allowed entries compression ratio. | +| maxAllowedEntryCompressionRatio | double | The maximum allowed compression ratio for archive entries. | diff --git a/english/java/com.groupdocs.viewer.options/baseviewoptions/_index.md b/english/java/com.groupdocs.viewer.options/baseviewoptions/_index.md index 5d0a5610e..d977ad6c7 100644 --- a/english/java/com.groupdocs.viewer.options/baseviewoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/baseviewoptions/_index.md @@ -1,7 +1,7 @@ --- title: BaseViewOptions second_title: GroupDocs.Viewer for Java API Reference -description: Provides base rendering options. +description: Class that provides base rendering options. type: docs weight: 12 url: /java/com.groupdocs.viewer.options/baseviewoptions/ @@ -12,7 +12,11 @@ java.lang.Object public abstract class BaseViewOptions ``` -Provides base rendering options. +Class that provides base rendering options. + +The BaseViewOptions class serves as the base for rendering options in GroupDocs.Viewer. It allows you to customize the rendering behavior of the output HTML, PDF, PNG, and JPEG files when rendering specific document formats. + +***Note:** For internal usage.* ## Constructors | Constructor | Description | @@ -22,40 +26,41 @@ Provides base rendering options. | Method | Description | | --- | --- | -| [getTextOptions()](#getTextOptions--) | Text files splitting to pages options. | -| [setTextOptions(TextOptions textOptions)](#setTextOptions-com.groupdocs.viewer.options.TextOptions-) | Text files splitting to pages options. | +| [getTextOptions()](#getTextOptions--) | Retrieves the options for splitting text files into pages. | +| [setTextOptions(TextOptions textOptions)](#setTextOptions-com.groupdocs.viewer.options.TextOptions-) | Sets the options for splitting text files into pages. | | [isRenderComments()](#isRenderComments--) | Enables rendering comments. | | [setRenderComments(boolean value)](#setRenderComments-boolean-) | Enables rendering comments. | | [isRenderNotes()](#isRenderNotes--) | Enables rendering notes. | | [setRenderNotes(boolean value)](#setRenderNotes-boolean-) | Enables rendering notes. | | [isRenderHiddenPages()](#isRenderHiddenPages--) | Enables rendering of hidden pages. | | [setRenderHiddenPages(boolean value)](#setRenderHiddenPages-boolean-) | Enables rendering of hidden pages. | -| [getDefaultFontName()](#getDefaultFontName--) | Default font to be used when particular font used in document can't be found. | -| [setDefaultFontName(String value)](#setDefaultFontName-java.lang.String-) | Default font to be used when particular font used in document can't be found. | -| [getArchiveOptions()](#getArchiveOptions--) | The archive files view options. | -| [setArchiveOptions(ArchiveOptions value)](#setArchiveOptions-com.groupdocs.viewer.options.ArchiveOptions-) | The archive files view options. | -| [getCadOptions()](#getCadOptions--) | The CAD drawing view options. | +| [getDefaultFontName()](#getDefaultFontName--) | Default font to be used when a particular font used in the document can't be found. | +| [setDefaultFontName(String value)](#setDefaultFontName-java.lang.String-) | Default font to be used when a particular font used in the document can't be found. | +| [getArchiveOptions()](#getArchiveOptions--) | Retrieves the archive files view options. | +| [setArchiveOptions(ArchiveOptions value)](#setArchiveOptions-com.groupdocs.viewer.options.ArchiveOptions-) | Sets the archive files view options. | +| [getCadOptions()](#getCadOptions--) | Retrieves the CAD drawing view options. | +| [setCadOptions(CadOptions value)](#setCadOptions-com.groupdocs.viewer.options.CadOptions-) | Sets the CAD drawing view options. | | [isCadOptionsInitialized_Internal()](#isCadOptionsInitialized-Internal--) | | -| [setCadOptions(CadOptions value)](#setCadOptions-com.groupdocs.viewer.options.CadOptions-) | The CAD drawing view options. | -| [getEmailOptions()](#getEmailOptions--) | The email messages view options. | -| [isEmailOptionsInitialized_Internal()](#isEmailOptionsInitialized-Internal--) | | -| [setEmailOptions(EmailOptions value)](#setEmailOptions-com.groupdocs.viewer.options.EmailOptions-) | The email messages view options. | -| [getOutlookOptions()](#getOutlookOptions--) | The MS Outlook data files view options. | -| [setOutlookOptions(OutlookOptions value)](#setOutlookOptions-com.groupdocs.viewer.options.OutlookOptions-) | The MS Outlook data files view options. | -| [getPdfOptions()](#getPdfOptions--) | The PDF documents view options. | -| [setPdfOptions(PdfOptions value)](#setPdfOptions-com.groupdocs.viewer.options.PdfOptions-) | The PDF documents view options. | -| [getMailStorageOptions()](#getMailStorageOptions--) | Lotus Notes storage data files view options. | -| [setMailStorageOptions(MailStorageOptions mailStorageOptions)](#setMailStorageOptions-com.groupdocs.viewer.options.MailStorageOptions-) | Lotus Notes storage data files view options. | -| [getProjectManagementOptions()](#getProjectManagementOptions--) | The project management files view options. | -| [setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)](#setProjectManagementOptions-com.groupdocs.viewer.options.ProjectManagementOptions-) | The project management files view options. | -| [getSpreadsheetOptions()](#getSpreadsheetOptions--) | The spreadsheet files view options. | -| [setSpreadsheetOptions(SpreadsheetOptions value)](#setSpreadsheetOptions-com.groupdocs.viewer.options.SpreadsheetOptions-) | The spreadsheet files view options. | -| [getWordProcessingOptions()](#getWordProcessingOptions--) | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | -| [setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)](#setWordProcessingOptions-com.groupdocs.viewer.options.WordProcessingOptions-) | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | -| [getVisioRenderingOptions()](#getVisioRenderingOptions--) | The Visio files processing documents view options. | -| [setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)](#setVisioRenderingOptions-com.groupdocs.viewer.options.VisioRenderingOptions-) | Sets the Visio files processing documents view options. | -| [getPresentationOptions()](#getPresentationOptions--) | The presentation processing documents view options. | -| [setPresentationOptions(PresentationOptions presentationOptions)](#setPresentationOptions-com.groupdocs.viewer.options.PresentationOptions-) | The presentation processing documents view options. | +| [getEmailOptions()](#getEmailOptions--) | Retrieves the email messages view options. | +| [setEmailOptions(EmailOptions value)](#setEmailOptions-com.groupdocs.viewer.options.EmailOptions-) | Sets the email messages view options. | +| [getOutlookOptions()](#getOutlookOptions--) | Retrieves the MS Outlook data files view options. | +| [setOutlookOptions(OutlookOptions value)](#setOutlookOptions-com.groupdocs.viewer.options.OutlookOptions-) | Sets the MS Outlook data files view options. | +| [getPdfOptions()](#getPdfOptions--) | Retrieves the PDF documents view options. | +| [setPdfOptions(PdfOptions value)](#setPdfOptions-com.groupdocs.viewer.options.PdfOptions-) | Retrieves the PDF documents view options. | +| [getMailStorageOptions()](#getMailStorageOptions--) | Retrieves the Lotus Notes storage data files view options. | +| [setMailStorageOptions(MailStorageOptions mailStorageOptions)](#setMailStorageOptions-com.groupdocs.viewer.options.MailStorageOptions-) | Sets the Lotus Notes storage data files view options. | +| [getProjectManagementOptions()](#getProjectManagementOptions--) | Retrieves the project management files view options. | +| [setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)](#setProjectManagementOptions-com.groupdocs.viewer.options.ProjectManagementOptions-) | Sets the project management files view options. | +| [getSpreadsheetOptions()](#getSpreadsheetOptions--) | Retrieves the spreadsheet files view options. | +| [setSpreadsheetOptions(SpreadsheetOptions value)](#setSpreadsheetOptions-com.groupdocs.viewer.options.SpreadsheetOptions-) | Sets the spreadsheet files view options. | +| [getWordProcessingOptions()](#getWordProcessingOptions--) | Retrieves the rendering options for customizing the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)](#setWordProcessingOptions-com.groupdocs.viewer.options.WordProcessingOptions-) | Sets the rendering options for customizing the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [getVisioRenderingOptions()](#getVisioRenderingOptions--) | Retrieves the rendering options for processing Visio files when viewing documents. | +| [setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)](#setVisioRenderingOptions-com.groupdocs.viewer.options.VisioRenderingOptions-) | Sets the rendering options for processing Visio files when viewing documents. | +| [getPresentationOptions()](#getPresentationOptions--) | Retrieves the view options for processing presentation documents. | +| [setPresentationOptions(PresentationOptions presentationOptions)](#setPresentationOptions-com.groupdocs.viewer.options.PresentationOptions-) | Sets the view options for processing presentation documents. | +| [getWebDocumentOptions()](#getWebDocumentOptions--) | Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | +| [setWebDocumentOptions(WebDocumentOptions webDocumentOptions)](#setWebDocumentOptions-com.groupdocs.viewer.options.WebDocumentOptions-) | Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | ### BaseViewOptions() {#BaseViewOptions--} ``` public BaseViewOptions() @@ -68,22 +73,22 @@ public TextOptions getTextOptions() ``` -Text files splitting to pages options. +Retrieves the options for splitting text files into pages. **Returns:** -[TextOptions](../../com.groupdocs.viewer.options/textoptions) +[TextOptions](../../com.groupdocs.viewer.options/textoptions) - the text file splitting options. ### setTextOptions(TextOptions textOptions) {#setTextOptions-com.groupdocs.viewer.options.TextOptions-} ``` public void setTextOptions(TextOptions textOptions) ``` -Text files splitting to pages options. +Sets the options for splitting text files into pages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| textOptions | [TextOptions](../../com.groupdocs.viewer.options/textoptions) | | +| textOptions | [TextOptions](../../com.groupdocs.viewer.options/textoptions) | The text file splitting options. | ### isRenderComments() {#isRenderComments--} ``` @@ -94,7 +99,7 @@ public final boolean isRenderComments() Enables rendering comments. **Returns:** -boolean +boolean - true if comments should be rendered, false otherwise. ### setRenderComments(boolean value) {#setRenderComments-boolean-} ``` public final void setRenderComments(boolean value) @@ -106,7 +111,7 @@ Enables rendering comments. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true if comments should be rendered, false otherwise. | ### isRenderNotes() {#isRenderNotes--} ``` @@ -117,7 +122,7 @@ public final boolean isRenderNotes() Enables rendering notes. **Returns:** -boolean +boolean - true if notes should be rendered, false otherwise. ### setRenderNotes(boolean value) {#setRenderNotes-boolean-} ``` public final void setRenderNotes(boolean value) @@ -129,7 +134,7 @@ Enables rendering notes. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true if notes should be rendered, false otherwise. | ### isRenderHiddenPages() {#isRenderHiddenPages--} ``` @@ -140,7 +145,7 @@ public final boolean isRenderHiddenPages() Enables rendering of hidden pages. **Returns:** -boolean +boolean - true if hidden pages should be rendered, false otherwise. ### setRenderHiddenPages(boolean value) {#setRenderHiddenPages-boolean-} ``` public final void setRenderHiddenPages(boolean value) @@ -152,7 +157,7 @@ Enables rendering of hidden pages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true if hidden pages should be rendered, false otherwise. | ### getDefaultFontName() {#getDefaultFontName--} ``` @@ -160,22 +165,22 @@ public final String getDefaultFontName() ``` -Default font to be used when particular font used in document can't be found. +Default font to be used when a particular font used in the document can't be found. **Returns:** -java.lang.String +java.lang.String - the name of the default font. ### setDefaultFontName(String value) {#setDefaultFontName-java.lang.String-} ``` public final void setDefaultFontName(String value) ``` -Default font to be used when particular font used in document can't be found. +Default font to be used when a particular font used in the document can't be found. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The name of the default font. | ### getArchiveOptions() {#getArchiveOptions--} ``` @@ -183,22 +188,22 @@ public final ArchiveOptions getArchiveOptions() ``` -The archive files view options. +Retrieves the archive files view options. **Returns:** -[ArchiveOptions](../../com.groupdocs.viewer.options/archiveoptions) +[ArchiveOptions](../../com.groupdocs.viewer.options/archiveoptions) - the archive files view options. ### setArchiveOptions(ArchiveOptions value) {#setArchiveOptions-com.groupdocs.viewer.options.ArchiveOptions-} ``` public final void setArchiveOptions(ArchiveOptions value) ``` -The archive files view options. +Sets the archive files view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [ArchiveOptions](../../com.groupdocs.viewer.options/archiveoptions) | | +| value | [ArchiveOptions](../../com.groupdocs.viewer.options/archiveoptions) | The archive files view options. | ### getCadOptions() {#getCadOptions--} ``` @@ -206,65 +211,55 @@ public final CadOptions getCadOptions() ``` -The CAD drawing view options. - -**Returns:** -[CadOptions](../../com.groupdocs.viewer.options/cadoptions) -### isCadOptionsInitialized_Internal() {#isCadOptionsInitialized-Internal--} -``` -public boolean isCadOptionsInitialized_Internal() -``` - - - +Retrieves the CAD drawing view options. **Returns:** -boolean +[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - the CAD drawing view options. ### setCadOptions(CadOptions value) {#setCadOptions-com.groupdocs.viewer.options.CadOptions-} ``` public final void setCadOptions(CadOptions value) ``` -The CAD drawing view options. +Sets the CAD drawing view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [CadOptions](../../com.groupdocs.viewer.options/cadoptions) | | +| value | [CadOptions](../../com.groupdocs.viewer.options/cadoptions) | The CAD drawing view options. | -### getEmailOptions() {#getEmailOptions--} +### isCadOptionsInitialized_Internal() {#isCadOptionsInitialized-Internal--} ``` -public final EmailOptions getEmailOptions() +public boolean isCadOptionsInitialized_Internal() ``` -The email messages view options. + **Returns:** -[EmailOptions](../../com.groupdocs.viewer.options/emailoptions) -### isEmailOptionsInitialized_Internal() {#isEmailOptionsInitialized-Internal--} +boolean +### getEmailOptions() {#getEmailOptions--} ``` -public boolean isEmailOptionsInitialized_Internal() +public final EmailOptions getEmailOptions() ``` - +Retrieves the email messages view options. **Returns:** -boolean +[EmailOptions](../../com.groupdocs.viewer.options/emailoptions) - Email messages view options. ### setEmailOptions(EmailOptions value) {#setEmailOptions-com.groupdocs.viewer.options.EmailOptions-} ``` public final void setEmailOptions(EmailOptions value) ``` -The email messages view options. +Sets the email messages view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [EmailOptions](../../com.groupdocs.viewer.options/emailoptions) | | +| value | [EmailOptions](../../com.groupdocs.viewer.options/emailoptions) | Email messages view options. | ### getOutlookOptions() {#getOutlookOptions--} ``` @@ -272,22 +267,22 @@ public final OutlookOptions getOutlookOptions() ``` -The MS Outlook data files view options. +Retrieves the MS Outlook data files view options. **Returns:** -[OutlookOptions](../../com.groupdocs.viewer.options/outlookoptions) +[OutlookOptions](../../com.groupdocs.viewer.options/outlookoptions) - MS Outlook data files view options. ### setOutlookOptions(OutlookOptions value) {#setOutlookOptions-com.groupdocs.viewer.options.OutlookOptions-} ``` public final void setOutlookOptions(OutlookOptions value) ``` -The MS Outlook data files view options. +Sets the MS Outlook data files view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [OutlookOptions](../../com.groupdocs.viewer.options/outlookoptions) | | +| value | [OutlookOptions](../../com.groupdocs.viewer.options/outlookoptions) | The MS Outlook data files view options to set. | ### getPdfOptions() {#getPdfOptions--} ``` @@ -295,22 +290,22 @@ public final PdfOptions getPdfOptions() ``` -The PDF documents view options. +Retrieves the PDF documents view options. **Returns:** -[PdfOptions](../../com.groupdocs.viewer.options/pdfoptions) +[PdfOptions](../../com.groupdocs.viewer.options/pdfoptions) - the PDF documents view options. ### setPdfOptions(PdfOptions value) {#setPdfOptions-com.groupdocs.viewer.options.PdfOptions-} ``` public final void setPdfOptions(PdfOptions value) ``` -The PDF documents view options. +Retrieves the PDF documents view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [PdfOptions](../../com.groupdocs.viewer.options/pdfoptions) | | +| value | [PdfOptions](../../com.groupdocs.viewer.options/pdfoptions) | The PDF documents view options. | ### getMailStorageOptions() {#getMailStorageOptions--} ``` @@ -318,22 +313,22 @@ public MailStorageOptions getMailStorageOptions() ``` -Lotus Notes storage data files view options. +Retrieves the Lotus Notes storage data files view options. **Returns:** -[MailStorageOptions](../../com.groupdocs.viewer.options/mailstorageoptions) +[MailStorageOptions](../../com.groupdocs.viewer.options/mailstorageoptions) - the Lotus Notes storage data files view options. ### setMailStorageOptions(MailStorageOptions mailStorageOptions) {#setMailStorageOptions-com.groupdocs.viewer.options.MailStorageOptions-} ``` public void setMailStorageOptions(MailStorageOptions mailStorageOptions) ``` -Lotus Notes storage data files view options. +Sets the Lotus Notes storage data files view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| mailStorageOptions | [MailStorageOptions](../../com.groupdocs.viewer.options/mailstorageoptions) | | +| mailStorageOptions | [MailStorageOptions](../../com.groupdocs.viewer.options/mailstorageoptions) | The Lotus Notes storage data files view options. | ### getProjectManagementOptions() {#getProjectManagementOptions--} ``` @@ -341,22 +336,22 @@ public final ProjectManagementOptions getProjectManagementOptions() ``` -The project management files view options. +Retrieves the project management files view options. **Returns:** -[ProjectManagementOptions](../../com.groupdocs.viewer.options/projectmanagementoptions) +[ProjectManagementOptions](../../com.groupdocs.viewer.options/projectmanagementoptions) - the project management files view options. ### setProjectManagementOptions(ProjectManagementOptions projectManagementOptions) {#setProjectManagementOptions-com.groupdocs.viewer.options.ProjectManagementOptions-} ``` public final void setProjectManagementOptions(ProjectManagementOptions projectManagementOptions) ``` -The project management files view options. +Sets the project management files view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| projectManagementOptions | [ProjectManagementOptions](../../com.groupdocs.viewer.options/projectmanagementoptions) | | +| projectManagementOptions | [ProjectManagementOptions](../../com.groupdocs.viewer.options/projectmanagementoptions) | The project management files view options to be set. | ### getSpreadsheetOptions() {#getSpreadsheetOptions--} ``` @@ -364,22 +359,22 @@ public final SpreadsheetOptions getSpreadsheetOptions() ``` -The spreadsheet files view options. +Retrieves the spreadsheet files view options. **Returns:** -[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) +[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - the spreadsheet files view options. ### setSpreadsheetOptions(SpreadsheetOptions value) {#setSpreadsheetOptions-com.groupdocs.viewer.options.SpreadsheetOptions-} ``` public final void setSpreadsheetOptions(SpreadsheetOptions value) ``` -The spreadsheet files view options. +Sets the spreadsheet files view options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) | | +| value | [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) | The spreadsheet files view options. | ### getWordProcessingOptions() {#getWordProcessingOptions--} ``` @@ -387,24 +382,24 @@ public final WordProcessingOptions getWordProcessingOptions() ``` -This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. +Retrieves the rendering options for customizing the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. -Note: See also [Render Word documents as HTML, PDF, or image files][Render Word documents as HTML_ PDF_ or image files] +***Note:** See also [Render Word documents as HTML, PDF, or image files][Render Word documents as HTML_ PDF_ or image files]* [Render Word documents as HTML_ PDF_ or image files]: https://docs.groupdocs.com/viewer/java/how-to-view-word-documents-using-java/ **Returns:** -[WordProcessingOptions](../../com.groupdocs.viewer.options/wordprocessingoptions) +[WordProcessingOptions](../../com.groupdocs.viewer.options/wordprocessingoptions) - the Word processing options for rendering Word documents. ### setWordProcessingOptions(WordProcessingOptions wordProcessingOptions) {#setWordProcessingOptions-com.groupdocs.viewer.options.WordProcessingOptions-} ``` public final void setWordProcessingOptions(WordProcessingOptions wordProcessingOptions) ``` -This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. +Sets the rendering options for customizing the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. -Note: See also [Render Word documents as HTML, PDF, or image files][Render Word documents as HTML_ PDF_ or image files] +***Note:** See also [Render Word documents as HTML, PDF, or image files][Render Word documents as HTML_ PDF_ or image files]* [Render Word documents as HTML_ PDF_ or image files]: https://docs.groupdocs.com/viewer/java/how-to-view-word-documents-using-java/ @@ -412,7 +407,7 @@ Note: See also [Render Word documents as HTML, PDF, or image files][Render Word **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| wordProcessingOptions | [WordProcessingOptions](../../com.groupdocs.viewer.options/wordprocessingoptions) | | +| wordProcessingOptions | [WordProcessingOptions](../../com.groupdocs.viewer.options/wordprocessingoptions) | The Word processing options for rendering Word documents. | ### getVisioRenderingOptions() {#getVisioRenderingOptions--} ``` @@ -420,22 +415,22 @@ public VisioRenderingOptions getVisioRenderingOptions() ``` -The Visio files processing documents view options. +Retrieves the rendering options for processing Visio files when viewing documents. **Returns:** -[VisioRenderingOptions](../../com.groupdocs.viewer.options/visiorenderingoptions) +[VisioRenderingOptions](../../com.groupdocs.viewer.options/visiorenderingoptions) - the Visio rendering options for processing Visio files. ### setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions) {#setVisioRenderingOptions-com.groupdocs.viewer.options.VisioRenderingOptions-} ``` public void setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions) ``` -Sets the Visio files processing documents view options. +Sets the rendering options for processing Visio files when viewing documents. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| visioRenderingOptions | [VisioRenderingOptions](../../com.groupdocs.viewer.options/visiorenderingoptions) | The Visio files processing documents view options. | +| visioRenderingOptions | [VisioRenderingOptions](../../com.groupdocs.viewer.options/visiorenderingoptions) | The Visio rendering options for processing Visio files. | ### getPresentationOptions() {#getPresentationOptions--} ``` @@ -443,20 +438,43 @@ public PresentationOptions getPresentationOptions() ``` -The presentation processing documents view options. +Retrieves the view options for processing presentation documents. **Returns:** -com.groupdocs.viewer.options.PresentationOptions +com.groupdocs.viewer.options.PresentationOptions - the presentation view options for processing presentation documents. ### setPresentationOptions(PresentationOptions presentationOptions) {#setPresentationOptions-com.groupdocs.viewer.options.PresentationOptions-} ``` public void setPresentationOptions(PresentationOptions presentationOptions) ``` -The presentation processing documents view options. +Sets the view options for processing presentation documents. + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| presentationOptions | com.groupdocs.viewer.options.PresentationOptions | The presentation view options for processing presentation documents. | + +### getWebDocumentOptions() {#getWebDocumentOptions--} +``` +public WebDocumentOptions getWebDocumentOptions() +``` + + +Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. + +**Returns:** +com.groupdocs.viewer.options.WebDocumentOptions - The WebDocumentOptions object for customizing the rendering options. +### setWebDocumentOptions(WebDocumentOptions webDocumentOptions) {#setWebDocumentOptions-com.groupdocs.viewer.options.WebDocumentOptions-} +``` +public void setWebDocumentOptions(WebDocumentOptions webDocumentOptions) +``` + + +Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| presentationOptions | com.groupdocs.viewer.options.PresentationOptions | | +| webDocumentOptions | com.groupdocs.viewer.options.WebDocumentOptions | The WebDocumentOptions object for customizing the rendering options. | diff --git a/english/java/com.groupdocs.viewer.options/cadoptions/_index.md b/english/java/com.groupdocs.viewer.options/cadoptions/_index.md index 811d51319..83efae998 100644 --- a/english/java/com.groupdocs.viewer.options/cadoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/cadoptions/_index.md @@ -13,6 +13,29 @@ public class CadOptions ``` Provides options for rendering CAD drawings. + +The CadOptions class encapsulates various settings and parameters that can be used to control the rendering of CAD drawings in the GroupDocs.Viewer component. + +Example usage: + +``` + + CadOptions options = CadOptions.forRenderingByWidth(256); + options.setRenderLayouts(true); + options.setBackgroundColor(Color.YELLOW); + options.setLayers(Arrays.asList( + CacheableFactory.getInstance().newLayer("Layer1"), + CacheableFactory.getInstance().newLayer("Layer2") + )); + + try (Viewer viewer = new Viewer("document.dwg")) { + PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setCadOptions(options); + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | @@ -23,29 +46,29 @@ Provides options for rendering CAD drawings. | Method | Description | | --- | --- | -| [getPc3File()](#getPc3File--) | PC3 - plotter configuration file | -| [setPc3File(String pc3File)](#setPc3File-java.lang.String-) | PC3 - plotter configuration file | -| [forRenderingByScaleFactor(float scaleFactor)](#forRenderingByScaleFactor-float-) | Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by scale factor. | -| [forRenderingByWidth(int width)](#forRenderingByWidth-int-) | Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by width. | -| [forRenderingByHeight(int height)](#forRenderingByHeight-int-) | Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by height. | -| [forRenderingByWidthAndHeight(int width, int height)](#forRenderingByWidthAndHeight-int-int-) | Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by width and height. | -| [getScaleFactor()](#getScaleFactor--) | Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller. | -| [getWidth()](#getWidth--) | The width of the output result in pixels. | -| [getHeight()](#getHeight--) | The height of the output result in pixels. | -| [getBackgroundColor()](#getBackgroundColor--) | Gets image background color | -| [setBackgroundColor(Color mBackgroundColor)](#setBackgroundColor-java.awt.Color-) | Sets image background color | -| [getTiles()](#getTiles--) | The drawing regions to render. | -| [setTiles(List value)](#setTiles-java.util.List-com.groupdocs.viewer.options.Tile--) | The drawing regions to render. | -| [isRenderLayouts()](#isRenderLayouts--) | Indicates whether layouts from CAD document should be rendered. | -| [setRenderLayouts(boolean value)](#setRenderLayouts-boolean-) | Indicates whether layouts from CAD document should be rendered. | -| [getLayoutName()](#getLayoutName--) | The name of the specific layout to render. | -| [setLayoutName(String value)](#setLayoutName-java.lang.String-) | The name of the specific layout to render. | -| [getLayers()](#getLayers--) | The CAD drawing layers to render. | -| [setLayers(List value)](#setLayers-java.util.List-com.groupdocs.viewer.results.Layer--) | The CAD drawing layers to render. | -| [equals(Object o)](#equals-java.lang.Object-) | | -| [hashCode()](#hashCode--) | | -| [toString()](#toString--) | | -| [toString(ToStringStyle style)](#toString-org.apache.commons.lang3.builder.ToStringStyle-) | | +| [getPc3File()](#getPc3File--) | Retrieves the PC3 (Plotter Configuration) file associated with the plotter. | +| [setPc3File(String pc3File)](#setPc3File-java.lang.String-) | Sets the PC3 (Plotter Configuration) file associated with the plotter. | +| [forRenderingByScaleFactor(float scaleFactor)](#forRenderingByScaleFactor-float-) | Initializes a new instance of the CadOptions class for rendering by scale factor. | +| [forRenderingByWidth(int width)](#forRenderingByWidth-int-) | Initializes a new instance of the CadOptions class for rendering by width. | +| [forRenderingByHeight(int height)](#forRenderingByHeight-int-) | Initializes a new instance of the CadOptions class for rendering by height. | +| [forRenderingByWidthAndHeight(int width, int height)](#forRenderingByWidthAndHeight-int-int-) | Initializes a new instance of the CadOptions class for rendering by width and height. | +| [getScaleFactor()](#getScaleFactor--) | Gets the scale factor for rendering. | +| [getWidth()](#getWidth--) | Gets the width of the output result in pixels. | +| [getHeight()](#getHeight--) | Gets the height of the output result in pixels. | +| [getBackgroundColor()](#getBackgroundColor--) | Gets the background color of the image. | +| [setBackgroundColor(Color backgroundColor)](#setBackgroundColor-java.awt.Color-) | Sets the background color of the image. | +| [getTiles()](#getTiles--) | Gets the drawing regions to render. | +| [setTiles(List value)](#setTiles-java.util.List-com.groupdocs.viewer.options.Tile--) | Sets the drawing regions to render. | +| [isRenderLayouts()](#isRenderLayouts--) | Indicates whether layouts from the CAD document should be rendered. | +| [setRenderLayouts(boolean value)](#setRenderLayouts-boolean-) | Sets whether layouts from the CAD document should be rendered. | +| [getLayoutName()](#getLayoutName--) | Gets the name of the specific layout to render. | +| [setLayoutName(String value)](#setLayoutName-java.lang.String-) | Sets the name of the specific layout to render. | +| [getLayers()](#getLayers--) | Gets the CAD drawing layers to render. | +| [setLayers(List value)](#setLayers-java.util.List-com.groupdocs.viewer.results.Layer--) | Gets the CAD drawing layers to render. | +| [equals(Object o)](#equals-java.lang.Object-) | Checks if this CadOptions object is equal to another object. | +| [hashCode()](#hashCode--) | \{@inheritDoc\} | +| [toString()](#toString--) | \{@inheritDoc\} | +| [toString(ToStringStyle style)](#toString-org.apache.commons.lang3.builder.ToStringStyle-) | \{@inheritDoc\} | ### WIDTH {#WIDTH} ``` public static final String WIDTH @@ -64,22 +87,22 @@ public String getPc3File() ``` -PC3 - plotter configuration file +Retrieves the PC3 (Plotter Configuration) file associated with the plotter. **Returns:** -java.lang.String +java.lang.String - the PC3 file path. ### setPc3File(String pc3File) {#setPc3File-java.lang.String-} ``` public void setPc3File(String pc3File) ``` -PC3 - plotter configuration file +Sets the PC3 (Plotter Configuration) file associated with the plotter. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pc3File | java.lang.String | | +| pc3File | java.lang.String | The PC3 file path. | ### forRenderingByScaleFactor(float scaleFactor) {#forRenderingByScaleFactor-float-} ``` @@ -87,22 +110,22 @@ public static CadOptions forRenderingByScaleFactor(float scaleFactor) ``` -Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by scale factor. +Initializes a new instance of the CadOptions class for rendering by scale factor. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| scaleFactor | float | Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller. | +| scaleFactor | float | The scale factor for rendering. Values greater than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller. | **Returns:** -[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - New instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by scale factor. +[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - a new instance of the CadOptions class for rendering by scale factor. ### forRenderingByWidth(int width) {#forRenderingByWidth-int-} ``` public static CadOptions forRenderingByWidth(int width) ``` -Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by width. +Initializes a new instance of the CadOptions class for rendering by width. **Parameters:** | Parameter | Type | Description | @@ -110,14 +133,14 @@ Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cado | width | int | The width of the output result in pixels. | **Returns:** -[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - New instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by width. +[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - a new instance of the CadOptions class for rendering by width. ### forRenderingByHeight(int height) {#forRenderingByHeight-int-} ``` public static CadOptions forRenderingByHeight(int height) ``` -Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by height. +Initializes a new instance of the CadOptions class for rendering by height. **Parameters:** | Parameter | Type | Description | @@ -125,14 +148,14 @@ Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cado | height | int | The height of the output result in pixels. | **Returns:** -[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - New instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by height. +[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - a new instance of the CadOptions class for rendering by height. ### forRenderingByWidthAndHeight(int width, int height) {#forRenderingByWidthAndHeight-int-int-} ``` public static CadOptions forRenderingByWidthAndHeight(int width, int height) ``` -Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by width and height. +Initializes a new instance of the CadOptions class for rendering by width and height. **Parameters:** | Parameter | Type | Description | @@ -141,59 +164,59 @@ Initializes new instance of [CadOptions](../../com.groupdocs.viewer.options/cado | height | int | The height of the output result in pixels. | **Returns:** -[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - New instance of [CadOptions](../../com.groupdocs.viewer.options/cadoptions) class for rendering by width and height. +[CadOptions](../../com.groupdocs.viewer.options/cadoptions) - a new instance of the CadOptions class for rendering by width and height. ### getScaleFactor() {#getScaleFactor--} ``` public final float getScaleFactor() ``` -Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller. +Gets the scale factor for rendering. Values higher than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller. **Returns:** -float +float - the scale factor for rendering. ### getWidth() {#getWidth--} ``` public final int getWidth() ``` -The width of the output result in pixels. +Gets the width of the output result in pixels. **Returns:** -int +int - the width of the output result. ### getHeight() {#getHeight--} ``` public final int getHeight() ``` -The height of the output result in pixels. +Gets the height of the output result in pixels. **Returns:** -int +int - the height of the output result. ### getBackgroundColor() {#getBackgroundColor--} ``` public Color getBackgroundColor() ``` -Gets image background color +Gets the background color of the image. **Returns:** -java.awt.Color - Image background color -### setBackgroundColor(Color mBackgroundColor) {#setBackgroundColor-java.awt.Color-} +java.awt.Color - the background color of the image. +### setBackgroundColor(Color backgroundColor) {#setBackgroundColor-java.awt.Color-} ``` -public void setBackgroundColor(Color mBackgroundColor) +public void setBackgroundColor(Color backgroundColor) ``` -Sets image background color +Sets the background color of the image. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| mBackgroundColor | java.awt.Color | Image background color | +| backgroundColor | java.awt.Color | The background color of the image. | ### getTiles() {#getTiles--} ``` @@ -201,30 +224,26 @@ public final List getTiles() ``` -The drawing regions to render. - --------------------- +Gets the drawing regions to render. -This option supported only for [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG) and [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT) file type. The RenderLayouts ([isRenderLayouts()](../../com.groupdocs.viewer.options/cadoptions\#isRenderLayouts--)/[setRenderLayouts(boolean)](../../com.groupdocs.viewer.options/cadoptions\#setRenderLayouts-boolean-)) and LayoutName ([getLayoutName()](../../com.groupdocs.viewer.options/cadoptions\#getLayoutName--)/[setLayoutName(String)](../../com.groupdocs.viewer.options/cadoptions\#setLayoutName-String-)) options are ignored when rendering by tiles. +**Note:** This option is supported only for [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG) and [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT) file types. The RenderLayouts ([isRenderLayouts()](../../com.groupdocs.viewer.options/cadoptions\#isRenderLayouts--)/[setRenderLayouts(boolean)](../../com.groupdocs.viewer.options/cadoptions\#setRenderLayouts-boolean-)) and LayoutName ([getLayoutName()](../../com.groupdocs.viewer.options/cadoptions\#getLayoutName--)/[setLayoutName(String)](../../com.groupdocs.viewer.options/cadoptions\#setLayoutName-String-)) options are ignored when rendering by tiles. **Returns:** -java.util.List +java.util.List - the list of drawing regions to render. ### setTiles(List value) {#setTiles-java.util.List-com.groupdocs.viewer.options.Tile--} ``` public final void setTiles(List value) ``` -The drawing regions to render. +Sets the drawing regions to render. --------------------- - -This option supported only for [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG) and [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT) file type. The RenderLayouts ([isRenderLayouts()](../../com.groupdocs.viewer.options/cadoptions\#isRenderLayouts--)/[setRenderLayouts(boolean)](../../com.groupdocs.viewer.options/cadoptions\#setRenderLayouts-boolean-)) and LayoutName ([getLayoutName()](../../com.groupdocs.viewer.options/cadoptions\#getLayoutName--)/[setLayoutName(String)](../../com.groupdocs.viewer.options/cadoptions\#setLayoutName-String-)) options are ignored when rendering by tiles. +**Note:** This option is supported only for [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG) and [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT) file types. The RenderLayouts ([isRenderLayouts()](../../com.groupdocs.viewer.options/cadoptions\#isRenderLayouts--)/[setRenderLayouts(boolean)](../../com.groupdocs.viewer.options/cadoptions\#setRenderLayouts-boolean-)) and LayoutName ([getLayoutName()](../../com.groupdocs.viewer.options/cadoptions\#getLayoutName--)/[setLayoutName(String)](../../com.groupdocs.viewer.options/cadoptions\#setLayoutName-String-)) options are ignored when rendering by tiles. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.util.List | | +| value | java.util.List | The list of drawing regions to render. | ### isRenderLayouts() {#isRenderLayouts--} ``` @@ -232,30 +251,26 @@ public final boolean isRenderLayouts() ``` -Indicates whether layouts from CAD document should be rendered. - --------------------- +Indicates whether layouts from the CAD document should be rendered. -This option applies only to CAD drawings that support layouts [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF) and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX); By default only Model is rendered. +**Note:** This option applies only to CAD drawings that support layouts, such as [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF), and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX). By default, only the Model is rendered. **Returns:** -boolean +boolean - true if layouts should be rendered, false otherwise. ### setRenderLayouts(boolean value) {#setRenderLayouts-boolean-} ``` public final void setRenderLayouts(boolean value) ``` -Indicates whether layouts from CAD document should be rendered. +Sets whether layouts from the CAD document should be rendered. --------------------- - -This option applies only to CAD drawings that support layouts [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF) and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX); By default only Model is rendered. +**Note:** This option applies only to CAD drawings that support layouts, such as [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF), and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX). By default, only the Model is rendered. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to render layouts, false otherwise. | ### getLayoutName() {#getLayoutName--} ``` @@ -263,30 +278,26 @@ public final String getLayoutName() ``` -The name of the specific layout to render. Layout name is case-sensitive. - --------------------- +Gets the name of the specific layout to render. The layout name is case-sensitive. -This option applies only to CAD drawings that support layouts [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF) and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX); By default only Model is rendered. +**Note:** This option applies only to CAD drawings that support layouts, such as [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF), and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX). By default, only the Model is rendered. **Returns:** -java.lang.String +java.lang.String - the name of the specific layout to render. ### setLayoutName(String value) {#setLayoutName-java.lang.String-} ``` public final void setLayoutName(String value) ``` -The name of the specific layout to render. Layout name is case-sensitive. +Sets the name of the specific layout to render. The layout name is case-sensitive. --------------------- - -This option applies only to CAD drawings that support layouts [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF) and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX); By default only Model is rendered. +**Note:** This option applies only to CAD drawings that support layouts, such as [FileType.DXF](../../com.groupdocs.viewer/filetype\#DXF), [FileType.DWG](../../com.groupdocs.viewer/filetype\#DWG), [FileType.DWT](../../com.groupdocs.viewer/filetype\#DWT), [FileType.DWF](../../com.groupdocs.viewer/filetype\#DWF), and [FileType.DWFX](../../com.groupdocs.viewer/filetype\#DWFX). By default, only the Model is rendered. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The name of the specific layout to render. | ### getLayers() {#getLayers--} ``` @@ -294,30 +305,26 @@ public final List getLayers() ``` -The CAD drawing layers to render. - --------------------- +Gets the CAD drawing layers to render. -By default all layers are rendered; Layer names are case-sensitive. +**Note:** By default, all layers are rendered. Layer names are case-sensitive. **Returns:** -java.util.List +java.util.List - the CAD drawing layers. ### setLayers(List value) {#setLayers-java.util.List-com.groupdocs.viewer.results.Layer--} ``` public final void setLayers(List value) ``` -The CAD drawing layers to render. +Gets the CAD drawing layers to render. --------------------- - -By default all layers are rendered; Layer names are case-sensitive. +**Note:** By default, all layers are rendered. Layer names are case-sensitive. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.util.List | | +| value | java.util.List | The CAD drawing layers. | ### equals(Object o) {#equals-java.lang.Object-} ``` @@ -325,47 +332,53 @@ public boolean equals(Object o) ``` - +Checks if this CadOptions object is equal to another object. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| o | java.lang.Object | | +| o | java.lang.Object | The object to compare with. | **Returns:** -boolean +boolean - true if the objects are equal, false otherwise. ### hashCode() {#hashCode--} ``` public int hashCode() ``` +Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets. +**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class. **Returns:** -int +int - the hash code value for this object. ### toString() {#toString--} ``` public String toString() ``` +Returns a string representation of this object. +**Note:** This method overrides the default implementation of the toString() method defined in the Object class. **Returns:** -java.lang.String +java.lang.String - a string representation of this object. ### toString(ToStringStyle style) {#toString-org.apache.commons.lang3.builder.ToStringStyle-} ``` public String toString(ToStringStyle style) ``` +Returns a string representation of this object. +**Note:** This method overrides the default implementation of the toString() method defined in the Object class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| style | org.apache.commons.lang3.builder.ToStringStyle | | +| style | org.apache.commons.lang3.builder.ToStringStyle | The ToStringStyle to use for generating the string representation. | **Returns:** -java.lang.String +java.lang.String - a string representation of this object using the specified ToStringStyle. diff --git a/english/java/com.groupdocs.viewer.options/emailoptions/_index.md b/english/java/com.groupdocs.viewer.options/emailoptions/_index.md index dfb8dbd98..a7081fe7b 100644 --- a/english/java/com.groupdocs.viewer.options/emailoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/emailoptions/_index.md @@ -13,34 +13,54 @@ public class EmailOptions ``` Provides options for rendering email messages. + +The EmailOptions class encapsulates various settings and parameters that can be used to control the rendering of email messages in the GroupDocs.Viewer component. + +Example usage: + +``` + + EmailOptions options = new EmailOptions(); + options.setDateTimeFormat("MM d yyyy HH:mm tt"); + options.setPageSize(PageSize.A4); + + PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setEmailOptions(options); + + try (Viewer viewer = new Viewer("email.msg")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [EmailOptions()](#EmailOptions--) | Initializes new instance of [EmailOptions](../../com.groupdocs.viewer.options/emailoptions) class. | +| [EmailOptions()](#EmailOptions--) | Initializes a new instance of the EmailOptions class. | ## Methods | Method | Description | | --- | --- | -| [getDateTimeFormat()](#getDateTimeFormat--) | Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used | -| [setDateTimeFormat(String dateTimeFormat)](#setDateTimeFormat-java.lang.String-) | Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used | -| [getTimeZoneOffset()](#getTimeZoneOffset--) | Message time zone offset | -| [setTimeZoneOffset(TimeZone timeZoneOffset)](#setTimeZoneOffset-java.util.TimeZone-) | Message time zone offset | -| [getPageSize()](#getPageSize--) | The size of the output page. | -| [setPageSize(PageSize value)](#setPageSize-com.groupdocs.viewer.options.PageSize-) | The size of the output page. | -| [getFieldTextMap()](#getFieldTextMap--) | The mapping between email message [Field](../../com.groupdocs.viewer.options/field) and field text representation. | -| [setFieldTextMap(Map value)](#setFieldTextMap-java.util.Map-com.groupdocs.viewer.options.Field-java.lang.String--) | The mapping between email message [Field](../../com.groupdocs.viewer.options/field) and field text representation. | -| [equals(Object o)](#equals-java.lang.Object-) | | -| [hashCode()](#hashCode--) | | -| [toString()](#toString--) | | -| [toString(ToStringStyle style)](#toString-org.apache.commons.lang3.builder.ToStringStyle-) | | +| [getDateTimeFormat()](#getDateTimeFormat--) | Gets the time format for the date and time values. | +| [setDateTimeFormat(String dateTimeFormat)](#setDateTimeFormat-java.lang.String-) | Gets the time format for the date and time values. | +| [getTimeZoneOffset()](#getTimeZoneOffset--) | Gets the time zone offset for the message. | +| [setTimeZoneOffset(TimeZone timeZoneOffset)](#setTimeZoneOffset-java.util.TimeZone-) | Gets the time zone offset for the message. | +| [getPageSize()](#getPageSize--) | Gets the size of the output page. | +| [setPageSize(PageSize value)](#setPageSize-com.groupdocs.viewer.options.PageSize-) | Gets the size of the output page. | +| [getFieldTextMap()](#getFieldTextMap--) | Retrieves the mapping between email message fields and their text representations. | +| [setFieldTextMap(Map value)](#setFieldTextMap-java.util.Map-com.groupdocs.viewer.options.Field-java.lang.String--) | Sets the mapping between email message fields and their text representations. | +| [equals(Object o)](#equals-java.lang.Object-) | Overrides the equals() method of the Object class. | +| [hashCode()](#hashCode--) | \{@inheritDoc\} | +| [toString()](#toString--) | Overrides the toString() method of the Object class. | +| [toString(ToStringStyle style)](#toString-org.apache.commons.lang3.builder.ToStringStyle-) | \{@inheritDoc\} | ### EmailOptions() {#EmailOptions--} ``` public EmailOptions() ``` -Initializes new instance of [EmailOptions](../../com.groupdocs.viewer.options/emailoptions) class. +Initializes a new instance of the EmailOptions class. This constructor is used to create a new instance of the EmailOptions class with default settings. ### getDateTimeFormat() {#getDateTimeFormat--} ``` @@ -48,22 +68,26 @@ public String getDateTimeFormat() ``` -Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used +Gets the time format for the date and time values. + +**Note:** The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. **Returns:** -java.lang.String +java.lang.String - the time format for date and time values. ### setDateTimeFormat(String dateTimeFormat) {#setDateTimeFormat-java.lang.String-} ``` public void setDateTimeFormat(String dateTimeFormat) ``` -Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used +Gets the time format for the date and time values. + +**Note:** The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| dateTimeFormat | java.lang.String | | +| dateTimeFormat | java.lang.String | The time format for date and time values. | ### getTimeZoneOffset() {#getTimeZoneOffset--} ``` @@ -71,22 +95,26 @@ public TimeZone getTimeZoneOffset() ``` -Message time zone offset +Gets the time zone offset for the message. + +**Note:** The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC). **Returns:** -java.util.TimeZone +java.util.TimeZone - the time zone offset. ### setTimeZoneOffset(TimeZone timeZoneOffset) {#setTimeZoneOffset-java.util.TimeZone-} ``` public void setTimeZoneOffset(TimeZone timeZoneOffset) ``` -Message time zone offset +Gets the time zone offset for the message. + +**Note:** The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| timeZoneOffset | java.util.TimeZone | | +| timeZoneOffset | java.util.TimeZone | The time zone offset. | ### getPageSize() {#getPageSize--} ``` @@ -94,22 +122,22 @@ public final PageSize getPageSize() ``` -The size of the output page. +Gets the size of the output page. **Returns:** -[PageSize](../../com.groupdocs.viewer.options/pagesize) - The size of the output page. +[PageSize](../../com.groupdocs.viewer.options/pagesize) - the page size. ### setPageSize(PageSize value) {#setPageSize-com.groupdocs.viewer.options.PageSize-} ``` public final void setPageSize(PageSize value) ``` -The size of the output page. +Gets the size of the output page. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [PageSize](../../com.groupdocs.viewer.options/pagesize) | The size of the output page. | +| value | [PageSize](../../com.groupdocs.viewer.options/pagesize) | The page size. | ### getFieldTextMap() {#getFieldTextMap--} ``` @@ -117,22 +145,22 @@ public final Map getFieldTextMap() ``` -The mapping between email message [Field](../../com.groupdocs.viewer.options/field) and field text representation. +Retrieves the mapping between email message fields and their text representations. **Returns:** -java.util.Map +java.util.Map - the mapping between email message fields and their text representations. ### setFieldTextMap(Map value) {#setFieldTextMap-java.util.Map-com.groupdocs.viewer.options.Field-java.lang.String--} ``` public final void setFieldTextMap(Map value) ``` -The mapping between email message [Field](../../com.groupdocs.viewer.options/field) and field text representation. +Sets the mapping between email message fields and their text representations. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.util.Map | | +| value | java.util.Map | The mapping between email message fields and their text representations. | ### equals(Object o) {#equals-java.lang.Object-} ``` @@ -140,47 +168,51 @@ public boolean equals(Object o) ``` - +Overrides the equals() method of the Object class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| o | java.lang.Object | | +| o | java.lang.Object | The object to compare with. | **Returns:** -boolean +boolean - true if the objects are equal, false otherwise. ### hashCode() {#hashCode--} ``` public int hashCode() ``` +Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets. +**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class. **Returns:** -int +int - the hash code value for this object. ### toString() {#toString--} ``` public String toString() ``` - +Overrides the toString() method of the Object class. **Returns:** -java.lang.String +java.lang.String - a string representation of the object. ### toString(ToStringStyle style) {#toString-org.apache.commons.lang3.builder.ToStringStyle-} ``` public String toString(ToStringStyle style) ``` +Returns a string representation of this object. +**Note:** This method overrides the default implementation of the toString() method defined in the Object class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| style | org.apache.commons.lang3.builder.ToStringStyle | | +| style | org.apache.commons.lang3.builder.ToStringStyle | The ToStringStyle to use for generating the string representation. | **Returns:** -java.lang.String +java.lang.String - a string representation of this object using the specified ToStringStyle. diff --git a/english/java/com.groupdocs.viewer.options/field/_index.md b/english/java/com.groupdocs.viewer.options/field/_index.md index f7e49c8d1..8dfad810a 100644 --- a/english/java/com.groupdocs.viewer.options/field/_index.md +++ b/english/java/com.groupdocs.viewer.options/field/_index.md @@ -13,58 +13,75 @@ public enum Field extends Enum ``` Represents email message fields e.g. From, To, Subject etc. + +The Field enum represents common email message fields in the GroupDocs.Viewer component. It provides a set of predefined fields that can be used to identify and access specific information in email messages, such as the sender, recipient, subject, and more. + +Example usage: + +``` + + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(); + EmailOptions emailOptions = htmlViewOptions.getEmailOptions(); + emailOptions.getFieldTextMap().put(Field.FROM, "Sender"); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | | --- | --- | -| [ANNIVERSARY](#ANNIVERSARY) | Default field text is "Anniversary". | -| [ATTACHMENTS](#ATTACHMENTS) | Default field text is "Attachments". | -| [BCC](#BCC) | Default field text is "Bcc". | -| [BIRTHDAY](#BIRTHDAY) | Default field text is "Birthday". | -| [BUSINESS](#BUSINESS) | Default field text is "Business". | -| [BUSINESS_ADDRESS](#BUSINESS-ADDRESS) | Default field text is "Business Address". | -| [BUSINESS_FAX](#BUSINESS-FAX) | Default field text is "Business Fax". | -| [BUSINESS_HOMEPAGE](#BUSINESS-HOMEPAGE) | Default field text is "BusinessHomepage". | -| [CC](#CC) | Default field text is "Cc". | -| [COMPANY](#COMPANY) | Default field text is "Company". | -| [DEPARTMENT](#DEPARTMENT) | Default field text is "Department". | -| [EMAIL](#EMAIL) | Default field text is "Email". | -| [EMAIL_DISPLAY_AS](#EMAIL-DISPLAY-AS) | Default field text is "Email Display As". | -| [EMAIL_2](#EMAIL-2) | Default field text is "Email2". | -| [EMAIL_2_DISPLAY_AS](#EMAIL-2-DISPLAY-AS) | Default field text is "Email2 Display As". | -| [EMAIL_3](#EMAIL-3) | Default field text is "Email3". | -| [EMAIL_3_DISPLAY_AS](#EMAIL-3-DISPLAY-AS) | Default field text is "Email3 Display As". | -| [END](#END) | Default field text is "End". | -| [FIRST_NAME](#FIRST-NAME) | Default field text is "First Name". | -| [FROM](#FROM) | Default field text is "From". | -| [FULL_NAME](#FULL-NAME) | Default field text is "Full Name". | -| [GENDER](#GENDER) | Default field text is "Gender". | -| [HOBBIES](#HOBBIES) | Default field text is "Hobbies". | -| [HOME](#HOME) | Default field text is "Home". | -| [HOME_ADDRESS](#HOME-ADDRESS) | Default field text is "Home Address". | -| [IMPORTANCE](#IMPORTANCE) | Default field text is "Importance". | -| [JOB_TITLE](#JOB-TITLE) | Default field text is "Job Title". | -| [LAST_NAME](#LAST-NAME) | Default field text is "Last Name". | -| [LOCATION](#LOCATION) | Default field text is "Location". | -| [MIDDLE_NAME](#MIDDLE-NAME) | Default field text is "Middle Name". | -| [MOBILE](#MOBILE) | Default field text is "Mobile". | -| [ORGANIZER](#ORGANIZER) | Default field text is "Organizer". | -| [OTHER_ADDRESS](#OTHER-ADDRESS) | Default field text is "Other Address". | -| [PERSONAL_HOMEPAGE](#PERSONAL-HOMEPAGE) | Default field text is "Personal Homepage". | -| [PROFESSION](#PROFESSION) | Default field text is "Profession". | -| [RECURRENCE](#RECURRENCE) | Default field text is "Recurrence" | -| [RECURRENCE_PATTERN](#RECURRENCE-PATTERN) | Default field text is "Recurrence Pattern". | -| [REQUIRED_ATTENDEES](#REQUIRED-ATTENDEES) | Default field text is "Required Attendees". | -| [SENT](#SENT) | Default field text is "Sent". | -| [SHOW_TIME_AS](#SHOW-TIME-AS) | Default field text is "Show Time As". | -| [SPOUSE_PARTNER](#SPOUSE-PARTNER) | Default field text is "Spouse/Partner". | -| [START](#START) | Default field text is "Start". | -| [SUBJECT](#SUBJECT) | Default field text is "Subject". | -| [TO](#TO) | Default field text is "To". | -| [USER_FIELD_1](#USER-FIELD-1) | Default field text is "User Field 1". | -| [USER_FIELD_2](#USER-FIELD-2) | Default field text is "User Field 2". | -| [USER_FIELD_3](#USER-FIELD-3) | Default field text is "User Field 3". | -| [USER_FIELD_4](#USER-FIELD-4) | Default field text is "User Field 4". | +| [ANNIVERSARY](#ANNIVERSARY) | Represents the "Anniversary" field. | +| [ATTACHMENTS](#ATTACHMENTS) | Represents the "Attachments" field. | +| [BCC](#BCC) | Represents the "Bcc" field. | +| [BIRTHDAY](#BIRTHDAY) | Represents the "Birthday" field. | +| [BUSINESS](#BUSINESS) | Represents the "Business" field. | +| [BUSINESS_ADDRESS](#BUSINESS-ADDRESS) | Represents the "Business Address" field. | +| [BUSINESS_FAX](#BUSINESS-FAX) | Represents the "Business Fax" field. | +| [BUSINESS_HOMEPAGE](#BUSINESS-HOMEPAGE) | Represents the "BusinessHomepage" field. | +| [CC](#CC) | Represents the "Cc" field. | +| [COMPANY](#COMPANY) | Represents the "Company" field. | +| [DEPARTMENT](#DEPARTMENT) | Represents the "Department" field. | +| [EMAIL](#EMAIL) | Represents the "Email" field. | +| [EMAIL_DISPLAY_AS](#EMAIL-DISPLAY-AS) | Represents the "Email Display As" field. | +| [EMAIL_2](#EMAIL-2) | Represents the "Email2" field. | +| [EMAIL_2_DISPLAY_AS](#EMAIL-2-DISPLAY-AS) | Represents the "Email2 Display As" field. | +| [EMAIL_3](#EMAIL-3) | Represents the "Email3" field. | +| [EMAIL_3_DISPLAY_AS](#EMAIL-3-DISPLAY-AS) | Represents the "Email3 Display As" field. | +| [END](#END) | Represents the "End" field. | +| [FIRST_NAME](#FIRST-NAME) | Represents the "First Name" field. | +| [FROM](#FROM) | Represents the "From" field. | +| [FULL_NAME](#FULL-NAME) | Represents the "Full Name" field. | +| [GENDER](#GENDER) | Represents the "Gender" field. | +| [HOBBIES](#HOBBIES) | Represents the "Hobbies" field. | +| [HOME](#HOME) | Represents the "Home" field. | +| [HOME_ADDRESS](#HOME-ADDRESS) | Represents the "Home Address" field. | +| [IMPORTANCE](#IMPORTANCE) | Represents the "Importance" field. | +| [JOB_TITLE](#JOB-TITLE) | Represents the "Job Title" field. | +| [LAST_NAME](#LAST-NAME) | Represents the "Last Name" field. | +| [LOCATION](#LOCATION) | Represents the "Location" field. | +| [MIDDLE_NAME](#MIDDLE-NAME) | Represents the "Middle Name" field. | +| [MOBILE](#MOBILE) | Represents the "Mobile" field. | +| [ORGANIZER](#ORGANIZER) | Represents the "Organizer" field. | +| [OTHER_ADDRESS](#OTHER-ADDRESS) | Represents the "Other Address" field. | +| [PERSONAL_HOMEPAGE](#PERSONAL-HOMEPAGE) | Represents the "Personal Homepage" field. | +| [PROFESSION](#PROFESSION) | Represents the "Profession" field. | +| [RECURRENCE](#RECURRENCE) | Represents the "Recurrence" field. | +| [RECURRENCE_PATTERN](#RECURRENCE-PATTERN) | Represents the "Recurrence Pattern" field. | +| [REQUIRED_ATTENDEES](#REQUIRED-ATTENDEES) | Represents the "Required Attendees" field. | +| [SENT](#SENT) | Represents the "Sent" field. | +| [SHOW_TIME_AS](#SHOW-TIME-AS) | Represents the "Show Time As" field. | +| [SPOUSE_PARTNER](#SPOUSE-PARTNER) | Represents the "Spouse/Partner" field. | +| [START](#START) | Represents the "Start" field. | +| [SUBJECT](#SUBJECT) | Represents the "Subject" field. | +| [TO](#TO) | Represents the "To" field. | +| [USER_FIELD_1](#USER-FIELD-1) | Represents the "User Field 1" field. | +| [USER_FIELD_2](#USER-FIELD-2) | Represents the "User Field 2" field. | +| [USER_FIELD_3](#USER-FIELD-3) | Represents the "User Field 3" field. | +| [USER_FIELD_4](#USER-FIELD-4) | Represents the "User Field 4" field. | ## Methods | Method | Description | @@ -79,7 +96,7 @@ public static final Field ANNIVERSARY ``` -Default field text is "Anniversary". +Represents the "Anniversary" field. ### ATTACHMENTS {#ATTACHMENTS} ``` @@ -87,7 +104,7 @@ public static final Field ATTACHMENTS ``` -Default field text is "Attachments". +Represents the "Attachments" field. ### BCC {#BCC} ``` @@ -95,7 +112,7 @@ public static final Field BCC ``` -Default field text is "Bcc". +Represents the "Bcc" field. ### BIRTHDAY {#BIRTHDAY} ``` @@ -103,7 +120,7 @@ public static final Field BIRTHDAY ``` -Default field text is "Birthday". +Represents the "Birthday" field. ### BUSINESS {#BUSINESS} ``` @@ -111,7 +128,7 @@ public static final Field BUSINESS ``` -Default field text is "Business". +Represents the "Business" field. ### BUSINESS_ADDRESS {#BUSINESS-ADDRESS} ``` @@ -119,7 +136,7 @@ public static final Field BUSINESS_ADDRESS ``` -Default field text is "Business Address". +Represents the "Business Address" field. ### BUSINESS_FAX {#BUSINESS-FAX} ``` @@ -127,7 +144,7 @@ public static final Field BUSINESS_FAX ``` -Default field text is "Business Fax". +Represents the "Business Fax" field. ### BUSINESS_HOMEPAGE {#BUSINESS-HOMEPAGE} ``` @@ -135,7 +152,7 @@ public static final Field BUSINESS_HOMEPAGE ``` -Default field text is "BusinessHomepage". +Represents the "BusinessHomepage" field. ### CC {#CC} ``` @@ -143,7 +160,7 @@ public static final Field CC ``` -Default field text is "Cc". +Represents the "Cc" field. ### COMPANY {#COMPANY} ``` @@ -151,7 +168,7 @@ public static final Field COMPANY ``` -Default field text is "Company". +Represents the "Company" field. ### DEPARTMENT {#DEPARTMENT} ``` @@ -159,7 +176,7 @@ public static final Field DEPARTMENT ``` -Default field text is "Department". +Represents the "Department" field. ### EMAIL {#EMAIL} ``` @@ -167,7 +184,7 @@ public static final Field EMAIL ``` -Default field text is "Email". +Represents the "Email" field. ### EMAIL_DISPLAY_AS {#EMAIL-DISPLAY-AS} ``` @@ -175,7 +192,7 @@ public static final Field EMAIL_DISPLAY_AS ``` -Default field text is "Email Display As". +Represents the "Email Display As" field. ### EMAIL_2 {#EMAIL-2} ``` @@ -183,7 +200,7 @@ public static final Field EMAIL_2 ``` -Default field text is "Email2". +Represents the "Email2" field. ### EMAIL_2_DISPLAY_AS {#EMAIL-2-DISPLAY-AS} ``` @@ -191,7 +208,7 @@ public static final Field EMAIL_2_DISPLAY_AS ``` -Default field text is "Email2 Display As". +Represents the "Email2 Display As" field. ### EMAIL_3 {#EMAIL-3} ``` @@ -199,7 +216,7 @@ public static final Field EMAIL_3 ``` -Default field text is "Email3". +Represents the "Email3" field. ### EMAIL_3_DISPLAY_AS {#EMAIL-3-DISPLAY-AS} ``` @@ -207,7 +224,7 @@ public static final Field EMAIL_3_DISPLAY_AS ``` -Default field text is "Email3 Display As". +Represents the "Email3 Display As" field. ### END {#END} ``` @@ -215,7 +232,7 @@ public static final Field END ``` -Default field text is "End". +Represents the "End" field. ### FIRST_NAME {#FIRST-NAME} ``` @@ -223,7 +240,7 @@ public static final Field FIRST_NAME ``` -Default field text is "First Name". +Represents the "First Name" field. ### FROM {#FROM} ``` @@ -231,7 +248,7 @@ public static final Field FROM ``` -Default field text is "From". +Represents the "From" field. ### FULL_NAME {#FULL-NAME} ``` @@ -239,7 +256,7 @@ public static final Field FULL_NAME ``` -Default field text is "Full Name". +Represents the "Full Name" field. ### GENDER {#GENDER} ``` @@ -247,7 +264,7 @@ public static final Field GENDER ``` -Default field text is "Gender". +Represents the "Gender" field. ### HOBBIES {#HOBBIES} ``` @@ -255,7 +272,7 @@ public static final Field HOBBIES ``` -Default field text is "Hobbies". +Represents the "Hobbies" field. ### HOME {#HOME} ``` @@ -263,7 +280,7 @@ public static final Field HOME ``` -Default field text is "Home". +Represents the "Home" field. ### HOME_ADDRESS {#HOME-ADDRESS} ``` @@ -271,7 +288,7 @@ public static final Field HOME_ADDRESS ``` -Default field text is "Home Address". +Represents the "Home Address" field. ### IMPORTANCE {#IMPORTANCE} ``` @@ -279,7 +296,7 @@ public static final Field IMPORTANCE ``` -Default field text is "Importance". +Represents the "Importance" field. ### JOB_TITLE {#JOB-TITLE} ``` @@ -287,7 +304,7 @@ public static final Field JOB_TITLE ``` -Default field text is "Job Title". +Represents the "Job Title" field. ### LAST_NAME {#LAST-NAME} ``` @@ -295,7 +312,7 @@ public static final Field LAST_NAME ``` -Default field text is "Last Name". +Represents the "Last Name" field. ### LOCATION {#LOCATION} ``` @@ -303,7 +320,7 @@ public static final Field LOCATION ``` -Default field text is "Location". +Represents the "Location" field. ### MIDDLE_NAME {#MIDDLE-NAME} ``` @@ -311,7 +328,7 @@ public static final Field MIDDLE_NAME ``` -Default field text is "Middle Name". +Represents the "Middle Name" field. ### MOBILE {#MOBILE} ``` @@ -319,7 +336,7 @@ public static final Field MOBILE ``` -Default field text is "Mobile". +Represents the "Mobile" field. ### ORGANIZER {#ORGANIZER} ``` @@ -327,7 +344,7 @@ public static final Field ORGANIZER ``` -Default field text is "Organizer". +Represents the "Organizer" field. ### OTHER_ADDRESS {#OTHER-ADDRESS} ``` @@ -335,7 +352,7 @@ public static final Field OTHER_ADDRESS ``` -Default field text is "Other Address". +Represents the "Other Address" field. ### PERSONAL_HOMEPAGE {#PERSONAL-HOMEPAGE} ``` @@ -343,7 +360,7 @@ public static final Field PERSONAL_HOMEPAGE ``` -Default field text is "Personal Homepage". +Represents the "Personal Homepage" field. ### PROFESSION {#PROFESSION} ``` @@ -351,7 +368,7 @@ public static final Field PROFESSION ``` -Default field text is "Profession". +Represents the "Profession" field. ### RECURRENCE {#RECURRENCE} ``` @@ -359,7 +376,7 @@ public static final Field RECURRENCE ``` -Default field text is "Recurrence" +Represents the "Recurrence" field. ### RECURRENCE_PATTERN {#RECURRENCE-PATTERN} ``` @@ -367,7 +384,7 @@ public static final Field RECURRENCE_PATTERN ``` -Default field text is "Recurrence Pattern". +Represents the "Recurrence Pattern" field. ### REQUIRED_ATTENDEES {#REQUIRED-ATTENDEES} ``` @@ -375,7 +392,7 @@ public static final Field REQUIRED_ATTENDEES ``` -Default field text is "Required Attendees". +Represents the "Required Attendees" field. ### SENT {#SENT} ``` @@ -383,7 +400,7 @@ public static final Field SENT ``` -Default field text is "Sent". +Represents the "Sent" field. ### SHOW_TIME_AS {#SHOW-TIME-AS} ``` @@ -391,7 +408,7 @@ public static final Field SHOW_TIME_AS ``` -Default field text is "Show Time As". +Represents the "Show Time As" field. ### SPOUSE_PARTNER {#SPOUSE-PARTNER} ``` @@ -399,7 +416,7 @@ public static final Field SPOUSE_PARTNER ``` -Default field text is "Spouse/Partner". +Represents the "Spouse/Partner" field. ### START {#START} ``` @@ -407,7 +424,7 @@ public static final Field START ``` -Default field text is "Start". +Represents the "Start" field. ### SUBJECT {#SUBJECT} ``` @@ -415,7 +432,7 @@ public static final Field SUBJECT ``` -Default field text is "Subject". +Represents the "Subject" field. ### TO {#TO} ``` @@ -423,7 +440,7 @@ public static final Field TO ``` -Default field text is "To". +Represents the "To" field. ### USER_FIELD_1 {#USER-FIELD-1} ``` @@ -431,7 +448,7 @@ public static final Field USER_FIELD_1 ``` -Default field text is "User Field 1". +Represents the "User Field 1" field. ### USER_FIELD_2 {#USER-FIELD-2} ``` @@ -439,7 +456,7 @@ public static final Field USER_FIELD_2 ``` -Default field text is "User Field 2". +Represents the "User Field 2" field. ### USER_FIELD_3 {#USER-FIELD-3} ``` @@ -447,7 +464,7 @@ public static final Field USER_FIELD_3 ``` -Default field text is "User Field 3". +Represents the "User Field 3" field. ### USER_FIELD_4 {#USER-FIELD-4} ``` @@ -455,7 +472,7 @@ public static final Field USER_FIELD_4 ``` -Default field text is "User Field 4". +Represents the "User Field 4" field. ### values() {#values--} ``` @@ -490,8 +507,10 @@ public final String getName() Field name. +This method retrieves the name of the field. + **Returns:** -java.lang.String - Field name. +java.lang.String - the name of the field. ### toString() {#toString--} ``` public String toString() @@ -501,4 +520,4 @@ public String toString() Returns a string that represents the current object. **Returns:** -java.lang.String - A string that represents the current object. +java.lang.String - a string that represents the current object. diff --git a/english/java/com.groupdocs.viewer.options/filename/_index.md b/english/java/com.groupdocs.viewer.options/filename/_index.md index 3e4ae3823..45680050d 100644 --- a/english/java/com.groupdocs.viewer.options/filename/_index.md +++ b/english/java/com.groupdocs.viewer.options/filename/_index.md @@ -1,7 +1,7 @@ --- title: FileName second_title: GroupDocs.Viewer for Java API Reference -description: Represents name of simple file +description: Represents the name of a file in an archive. type: docs weight: 15 url: /java/com.groupdocs.viewer.options/filename/ @@ -12,31 +12,50 @@ java.lang.Object public class FileName ``` -Represents name of simple file +Represents the name of a file in an archive. + +The FileName class encapsulates the name of a file without any path or directory information. It provides methods to manipulate and retrieve information about the file name. + +Example usage: + +``` + + HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources(); + options.getArchiveOptions().setFileName(new FileName("my-file-name")); + + final LoadOptions loadOptions = new LoadOptions(FileType.ZIP); + try (final Viewer viewer = new Viewer(documentPath, loadOptions)) { + viewer.view(options); + // Use the viewer object for archive document rendering + } + +``` + +***Note:** The FileName class is used to work with file names and does not handle file operations or manipulation.* ## Constructors | Constructor | Description | | --- | --- | -| [FileName(String fileName)](#FileName-java.lang.String-) | Initializes new instance of [FileName](../../com.groupdocs.viewer.options/filename) class. | +| [FileName(String fileName)](#FileName-java.lang.String-) | Initializes a new instance of the FileName class. | ## Fields | Field | Description | | --- | --- | -| [EMPTY](#EMPTY) | The empty filename. | -| [SOURCE](#SOURCE) | The name of the source file. | +| [EMPTY](#EMPTY) | Represents an empty filename. | +| [SOURCE](#SOURCE) | Represents the name of the source file. | ## Methods | Method | Description | | --- | --- | | [getText()](#getText--) | | -| [toString()](#toString--) | Returns a string that represents the current object. | +| [toString()](#toString--) | Returns a string representation of the current object. | ### FileName(String fileName) {#FileName-java.lang.String-} ``` public FileName(String fileName) ``` -Initializes new instance of [FileName](../../com.groupdocs.viewer.options/filename) class. +Initializes a new instance of the FileName class. **Parameters:** | Parameter | Type | Description | @@ -49,7 +68,7 @@ public static final FileName EMPTY ``` -The empty filename. +Represents an empty filename. ### SOURCE {#SOURCE} ``` @@ -57,7 +76,7 @@ public static final FileName SOURCE ``` -The name of the source file. +Represents the name of the source file. ### getText() {#getText--} ``` @@ -75,7 +94,7 @@ public String toString() ``` -Returns a string that represents the current object. +Returns a string representation of the current object. **Returns:** -java.lang.String - A string that represents the current object. +java.lang.String - a string representation of the current object. diff --git a/english/java/com.groupdocs.viewer.options/htmlviewoptions/_index.md b/english/java/com.groupdocs.viewer.options/htmlviewoptions/_index.md index 3ad672f8a..aa7b94872 100644 --- a/english/java/com.groupdocs.viewer.options/htmlviewoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/htmlviewoptions/_index.md @@ -13,6 +13,23 @@ public class HtmlViewOptions extends ViewOptions ``` Provides options for rendering documents into HTML format. + +The HtmlViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into HTML format in the GroupDocs.Viewer component. + +Example usage: + +``` + + HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources(); + options.setExcludeFonts(true); + options.setFontsToExclude(Arrays.asList("font-name")); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(options); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | @@ -23,39 +40,39 @@ Provides options for rendering documents into HTML format. | Method | Description | | --- | --- | -| [getImageMaxWidth()](#getImageMaxWidth--) | Max width of an output image in pixels. | -| [setImageMaxWidth(int imageMaxWidth)](#setImageMaxWidth-int-) | Max width of an output image in pixels. | -| [getImageMaxHeight()](#getImageMaxHeight--) | Max height of an output image in pixels. | -| [setImageMaxHeight(int imageMaxHeight)](#setImageMaxHeight-int-) | Max height of an output image in pixels. | -| [getImageWidth()](#getImageWidth--) | The width of the output image in pixels. | -| [setImageWidth(int imageWidth)](#setImageWidth-int-) | The width of the output image in pixels. | -| [getImageHeight()](#getImageHeight--) | The height of an output image in pixels. | -| [setImageHeight(int imageHeight)](#setImageHeight-int-) | The height of an output image in pixels. | -| [forEmbeddedResources(CreatePageStream createPageStream)](#forEmbeddedResources-com.groupdocs.viewer.interfaces.CreatePageStream-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. | -| [forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream)](#forEmbeddedResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. | -| [forEmbeddedResources(PageStreamFactory pageStreamFactory)](#forEmbeddedResources-com.groupdocs.viewer.interfaces.PageStreamFactory-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. | -| [forEmbeddedResources()](#forEmbeddedResources--) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. | -| [forEmbeddedResources(String filePathFormat)](#forEmbeddedResources-java.lang.String-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. | -| [forEmbeddedResources(Path filePathFormat)](#forEmbeddedResources-java.nio.file.Path-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. | -| [forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl)](#forExternalResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.CreateResourceStream-com.groupdocs.viewer.interfaces.CreateResourceUrl-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. | -| [forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream)](#forExternalResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.CreateResourceStream-com.groupdocs.viewer.interfaces.CreateResourceUrl-com.groupdocs.viewer.interfaces.ReleasePageStream-com.groupdocs.viewer.interfaces.ReleaseResourceStream-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. | -| [forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory)](#forExternalResources-com.groupdocs.viewer.interfaces.PageStreamFactory-com.groupdocs.viewer.interfaces.ResourceStreamFactory-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. | -| [forExternalResources()](#forExternalResources--) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. | -| [forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat)](#forExternalResources-java.lang.String-java.lang.String-java.lang.String-) | Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. | -| [isRenderResponsive()](#isRenderResponsive--) | Enables responsive rendering; Responsive web-pages render well on a devices with different screen size. | -| [setRenderResponsive(boolean value)](#setRenderResponsive-boolean-) | Enables responsive rendering; Responsive web-pages render well on a devices with different screen size. | -| [isMinify()](#isMinify--) | Enables HTML content and HTML resources minification. | -| [setMinify(boolean value)](#setMinify-boolean-) | Enables HTML content and HTML resources minification. | -| [setRenderToSinglePage(boolean renderSinglePage)](#setRenderToSinglePage-boolean-) | Enables HTML content will be rendered to single page | -| [isRenderToSinglePage()](#isRenderToSinglePage--) | Enables HTML content will be rendered to single page | -| [isExcludeFonts()](#isExcludeFonts--) | When enabled prevents adding any fonts into HTML document. | -| [setExcludeFonts(boolean value)](#setExcludeFonts-boolean-) | When enabled prevents adding any fonts into HTML document. | -| [getFontsToExclude()](#getFontsToExclude--) | The list of font names, to exclude from HTML document. | -| [setFontsToExclude(List value)](#setFontsToExclude-java.util.List-java.lang.String--) | The list of font names, to exclude from HTML document. | -| [isForPrinting()](#isForPrinting--) | Indicates whether to optimize output HTML for printing. | -| [setForPrinting(boolean value)](#setForPrinting-boolean-) | Indicates whether to optimize output HTML for printing. | -| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Callback to estimate Words or Email document saving progress | -| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Callback to estimate Words or Email document saving progress | +| [getImageMaxWidth()](#getImageMaxWidth--) | Returns the maximum width of an output image in pixels. | +| [setImageMaxWidth(int imageMaxWidth)](#setImageMaxWidth-int-) | Sets the maximum width of an output image in pixels. | +| [getImageMaxHeight()](#getImageMaxHeight--) | Gets the maximum height of an output image in pixels. | +| [setImageMaxHeight(int imageMaxHeight)](#setImageMaxHeight-int-) | Sets the maximum height of an output image in pixels. | +| [getImageWidth()](#getImageWidth--) | Gets the width of the output image in pixels. | +| [setImageWidth(int imageWidth)](#setImageWidth-int-) | Sets the width of the output image in pixels. | +| [getImageHeight()](#getImageHeight--) | Gets the height of the output image in pixels when converting a single image to HTML. | +| [setImageHeight(int imageHeight)](#setImageHeight-int-) | Sets the height of the output image in pixels when converting a single image to HTML. | +| [forEmbeddedResources(CreatePageStream createPageStream)](#forEmbeddedResources-com.groupdocs.viewer.interfaces.CreatePageStream-) | Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. | +| [forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream)](#forEmbeddedResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-) | Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. | +| [forEmbeddedResources(PageStreamFactory pageStreamFactory)](#forEmbeddedResources-com.groupdocs.viewer.interfaces.PageStreamFactory-) | Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. | +| [forEmbeddedResources()](#forEmbeddedResources--) | Initializes a new instance of the HtmlViewOptions class. | +| [forEmbeddedResources(String filePathFormat)](#forEmbeddedResources-java.lang.String-) | Initializes a new instance of the HtmlViewOptions class. | +| [forEmbeddedResources(Path filePathFormat)](#forEmbeddedResources-java.nio.file.Path-) | Initializes a new instance of the HtmlViewOptions class. | +| [forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl)](#forExternalResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.CreateResourceStream-com.groupdocs.viewer.interfaces.CreateResourceUrl-) | Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources. | +| [forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream)](#forExternalResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.CreateResourceStream-com.groupdocs.viewer.interfaces.CreateResourceUrl-com.groupdocs.viewer.interfaces.ReleasePageStream-com.groupdocs.viewer.interfaces.ReleaseResourceStream-) | Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources. | +| [forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory)](#forExternalResources-com.groupdocs.viewer.interfaces.PageStreamFactory-com.groupdocs.viewer.interfaces.ResourceStreamFactory-) | Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources. | +| [forExternalResources()](#forExternalResources--) | Initializes new instance of HtmlViewOptions class. | +| [forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat)](#forExternalResources-java.lang.String-java.lang.String-java.lang.String-) | Initializes a new instance of the HtmlViewOptions class. | +| [isRenderResponsive()](#isRenderResponsive--) | Determines whether responsive rendering is enabled. | +| [setRenderResponsive(boolean value)](#setRenderResponsive-boolean-) | Sets whether responsive rendering is enabled. | +| [isMinify()](#isMinify--) | Checks if HTML content and HTML resources minification is enabled. | +| [setMinify(boolean value)](#setMinify-boolean-) | Sets whether HTML content and HTML resources minification is enabled. | +| [setRenderToSinglePage(boolean renderSinglePage)](#setRenderToSinglePage-boolean-) | Sets whether HTML content will be rendered to a single page. | +| [isRenderToSinglePage()](#isRenderToSinglePage--) | Determines whether HTML content will be rendered to a single page. | +| [isExcludeFonts()](#isExcludeFonts--) | Determines whether to exclude fonts from the HTML document. | +| [setExcludeFonts(boolean value)](#setExcludeFonts-boolean-) | Sets whether to exclude fonts from the HTML document. | +| [getFontsToExclude()](#getFontsToExclude--) | Retrieves the list of font names to exclude from the HTML document. | +| [setFontsToExclude(List value)](#setFontsToExclude-java.util.List-java.lang.String--) | Sets the list of font names to exclude from the HTML document. | +| [isForPrinting()](#isForPrinting--) | Checks if the output HTML should be optimized for printing. | +| [setForPrinting(boolean value)](#setForPrinting-boolean-) | Sets whether the output HTML should be optimized for printing. | +| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Retrieves the callback used to estimate the saving progress of a Words or Email document. | +| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Sets the callback used to estimate the saving progress of a Words or Email document. | ### CREATE_PAGE_STREAM {#CREATE-PAGE-STREAM} ``` public static final String CREATE_PAGE_STREAM @@ -74,22 +91,26 @@ public int getImageMaxWidth() ``` -Max width of an output image in pixels. (When converting single image to HTML only) +Returns the maximum width of an output image in pixels. + +**Note:** This value is used when converting a single image to HTML. **Returns:** -int +int - the maximum width of an output image. ### setImageMaxWidth(int imageMaxWidth) {#setImageMaxWidth-int-} ``` public void setImageMaxWidth(int imageMaxWidth) ``` -Max width of an output image in pixels. (When converting single image to HTML only) +Sets the maximum width of an output image in pixels. + +**Note:** This value is used when converting a single image to HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageMaxWidth | int | | +| imageMaxWidth | int | The maximum width of an output image. | ### getImageMaxHeight() {#getImageMaxHeight--} ``` @@ -97,22 +118,26 @@ public int getImageMaxHeight() ``` -Max height of an output image in pixels. (When converting single image to HTML only) +Gets the maximum height of an output image in pixels. + +**Note:** This option applies when converting a single image to HTML. It specifies the maximum height of the output image. **Returns:** -int +int - the maximum height of an output image. ### setImageMaxHeight(int imageMaxHeight) {#setImageMaxHeight-int-} ``` public void setImageMaxHeight(int imageMaxHeight) ``` -Max height of an output image in pixels. (When converting single image to HTML only) +Sets the maximum height of an output image in pixels. + +**Note:** This option applies when converting a single image to HTML. It specifies the maximum height of the output image. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageMaxHeight | int | | +| imageMaxHeight | int | The maximum height of an output image. | ### getImageWidth() {#getImageWidth--} ``` @@ -120,22 +145,26 @@ public int getImageWidth() ``` -The width of the output image in pixels. (When converting single image to HTML only) +Gets the width of the output image in pixels. + +***Note:** This value is applicable only when converting a single image to HTML.* **Returns:** -int +int - the width of the output image. ### setImageWidth(int imageWidth) {#setImageWidth-int-} ``` public void setImageWidth(int imageWidth) ``` -The width of the output image in pixels. (When converting single image to HTML only) +Sets the width of the output image in pixels. + +***Note:** This value is applicable only when converting a single image to HTML.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageWidth | int | | +| imageWidth | int | The width of the output image. | ### getImageHeight() {#getImageHeight--} ``` @@ -143,22 +172,22 @@ public int getImageHeight() ``` -The height of an output image in pixels. (When converting single image to HTML only) +Gets the height of the output image in pixels when converting a single image to HTML. **Returns:** -int +int - the height of the output image in pixels. ### setImageHeight(int imageHeight) {#setImageHeight-int-} ``` public void setImageHeight(int imageHeight) ``` -The height of an output image in pixels. (When converting single image to HTML only) +Sets the height of the output image in pixels when converting a single image to HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageHeight | int | | +| imageHeight | int | The height of the output image in pixels. | ### forEmbeddedResources(CreatePageStream createPageStream) {#forEmbeddedResources-com.groupdocs.viewer.interfaces.CreatePageStream-} ``` @@ -166,149 +195,149 @@ public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageSt ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. +Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. + +***Note:** The method takes a CreatePageStream parameter, which is a method used to instantiate a stream for writing output page data.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates a stream used to write output page data. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - New instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. ### forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream) {#forEmbeddedResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-} ``` public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream) ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. +Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | -| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases stream created by method assigned to delegate that passed to createPageStream parameter. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates a stream used to write output page data. | +| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases the stream created by the method assigned to the createPageStream parameter. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - New instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. ### forEmbeddedResources(PageStreamFactory pageStreamFactory) {#forEmbeddedResources-com.groupdocs.viewer.interfaces.PageStreamFactory-} ``` public static HtmlViewOptions forEmbeddedResources(PageStreamFactory pageStreamFactory) ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. +Initializes a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory which implements methods for creating and releasing output page stream. | +| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory that implements methods for creating and releasing the output page stream. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - New instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with embedded resources. +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class for rendering into HTML with embedded resources. ### forEmbeddedResources() {#forEmbeddedResources--} ``` public static HtmlViewOptions forEmbeddedResources() ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. +Initializes a new instance of the HtmlViewOptions class. **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class. ### forEmbeddedResources(String filePathFormat) {#forEmbeddedResources-java.lang.String-} ``` public static HtmlViewOptions forEmbeddedResources(String filePathFormat) ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. +Initializes a new instance of the HtmlViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| filePathFormat | java.lang.String | The file path format e.g. 'page\_\{0\}.html'. | +| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.html'. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class. ### forEmbeddedResources(Path filePathFormat) {#forEmbeddedResources-java.nio.file.Path-} ``` public static HtmlViewOptions forEmbeddedResources(Path filePathFormat) ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. +Initializes a new instance of the HtmlViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| filePathFormat | java.nio.file.Path | The file path format e.g. 'page\_\{0\}.html'. | +| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.html'. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class. ### forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl) {#forExternalResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.CreateResourceStream-com.groupdocs.viewer.interfaces.CreateResourceUrl-} ``` public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl) ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. +Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources. + +***Note:** This method should be used when rendering HTML with external resources, such as CSS and JavaScript files.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | -| createResourceStream | [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) | The method that releases stream created by createPageStream method. | -| createResourceUrl | [CreateResourceUrl](../../com.groupdocs.viewer.interfaces/createresourceurl) | The method that creates URL for HTML resource. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates the stream used to write output page data. | +| createResourceStream | [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) | The method that releases the stream created by the createPageStream method. | +| createResourceUrl | [CreateResourceUrl](../../com.groupdocs.viewer.interfaces/createresourceurl) | The method that creates the URL for the HTML resource. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - New instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class for rendering into HTML with external resources. ### forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream) {#forExternalResources-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.CreateResourceStream-com.groupdocs.viewer.interfaces.CreateResourceUrl-com.groupdocs.viewer.interfaces.ReleasePageStream-com.groupdocs.viewer.interfaces.ReleaseResourceStream-} ``` public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream) ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. +Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | -| createResourceStream | [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) | The method that instantiates stream used to write output HTML resource data. | -| createResourceUrl | [CreateResourceUrl](../../com.groupdocs.viewer.interfaces/createresourceurl) | The method that creates URL for HTML resource. | -| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases stream created by method assigned to delegate that passed to createPageStream parameter. | -| releaseResourceStream | [ReleaseResourceStream](../../com.groupdocs.viewer.interfaces/releaseresourcestream) | The method that releases stream created by method assigned to delegate that passed to createResourceStream parameter. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates the stream used to write output page data. | +| createResourceStream | [CreateResourceStream](../../com.groupdocs.viewer.interfaces/createresourcestream) | The method that instantiates the stream used to write output HTML resource data. | +| createResourceUrl | [CreateResourceUrl](../../com.groupdocs.viewer.interfaces/createresourceurl) | The method that creates the URL for the HTML resource. | +| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases the stream created by the createPageStream method. | +| releaseResourceStream | [ReleaseResourceStream](../../com.groupdocs.viewer.interfaces/releaseresourcestream) | The method that releases the stream created by the createResourceStream method. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - New instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class for rendering into HTML with external resources. ### forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory) {#forExternalResources-com.groupdocs.viewer.interfaces.PageStreamFactory-com.groupdocs.viewer.interfaces.ResourceStreamFactory-} ``` public static HtmlViewOptions forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory) ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. +Initializes a new instance of the HtmlViewOptions class for rendering into HTML with external resources. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory which implements methods for creating and releasing output page stream. | -| resourceStreamFactory | [ResourceStreamFactory](../../com.groupdocs.viewer.interfaces/resourcestreamfactory) | The factory which implements methods that are required for creating resource URL, instantiating and releasing output HTML resource stream. | +| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory that implements methods for creating and releasing the output page stream. | +| resourceStreamFactory | [ResourceStreamFactory](../../com.groupdocs.viewer.interfaces/resourcestreamfactory) | The factory that implements methods for creating resource URLs and instantiating/releasing the output HTML resource stream. | **Returns:** -[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - New instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class for rendering into HTML with external resources. +[HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) - a new instance of the HtmlViewOptions class for rendering into HTML with external resources. ### forExternalResources() {#forExternalResources--} ``` public static HtmlViewOptions forExternalResources() ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. - --------------------- - -This constructor initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) +Initializes new instance of HtmlViewOptions class. * \- with "p\_\{0\}.html" as file path format for the output HTML files; * \- with "p\_\{0\}\_\{1\}" as file path format for the output HTML-resource files; @@ -324,14 +353,14 @@ public static HtmlViewOptions forExternalResources(String filePathFormat, String ``` -Initializes new instance of [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) class. +Initializes a new instance of the HtmlViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| filePathFormat | java.lang.String | The file path format e.g. 'page\_\{0\}.html'. | -| resourceFilePathFormat | java.lang.String | The resource file path format e.g. 'page\_\{0\}/resource\_\{1\}'. | -| resourceUrlFormat | java.lang.String | The resource URL format e.g. 'page\_\{0\}/resource\_\{1\}'. | +| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.html'. | +| resourceFilePathFormat | java.lang.String | The resource file path format, e.g., 'page\_\{0\}/resource\_\{1\}'. | +| resourceUrlFormat | java.lang.String | The resource URL format, e.g., 'page\_\{0\}/resource\_\{1\}'. | **Returns:** [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) @@ -341,22 +370,22 @@ public final boolean isRenderResponsive() ``` -Enables responsive rendering; Responsive web-pages render well on a devices with different screen size. +Determines whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes. **Returns:** -boolean +boolean - true if responsive rendering is enabled, false otherwise. ### setRenderResponsive(boolean value) {#setRenderResponsive-boolean-} ``` public final void setRenderResponsive(boolean value) ``` -Enables responsive rendering; Responsive web-pages render well on a devices with different screen size. +Sets whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable responsive rendering, false to disable it. | ### isMinify() {#isMinify--} ``` @@ -364,22 +393,22 @@ public final boolean isMinify() ``` -Enables HTML content and HTML resources minification. +Checks if HTML content and HTML resources minification is enabled. **Returns:** -boolean +boolean - true if minification is enabled, false otherwise. ### setMinify(boolean value) {#setMinify-boolean-} ``` public final void setMinify(boolean value) ``` -Enables HTML content and HTML resources minification. +Sets whether HTML content and HTML resources minification is enabled. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable minification, false to disable. | ### setRenderToSinglePage(boolean renderSinglePage) {#setRenderToSinglePage-boolean-} ``` @@ -387,12 +416,12 @@ public void setRenderToSinglePage(boolean renderSinglePage) ``` -Enables HTML content will be rendered to single page +Sets whether HTML content will be rendered to a single page. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| renderSinglePage | boolean | | +| renderSinglePage | boolean | true if HTML content should be rendered to a single page, false otherwise. | ### isRenderToSinglePage() {#isRenderToSinglePage--} ``` @@ -400,32 +429,32 @@ public boolean isRenderToSinglePage() ``` -Enables HTML content will be rendered to single page +Determines whether HTML content will be rendered to a single page. **Returns:** -boolean +boolean - true if HTML content will be rendered to a single page, false otherwise. ### isExcludeFonts() {#isExcludeFonts--} ``` public final boolean isExcludeFonts() ``` -When enabled prevents adding any fonts into HTML document. +Determines whether to exclude fonts from the HTML document. **Returns:** -boolean +boolean - true if fonts should be excluded, false otherwise. ### setExcludeFonts(boolean value) {#setExcludeFonts-boolean-} ``` public final void setExcludeFonts(boolean value) ``` -When enabled prevents adding any fonts into HTML document. +Sets whether to exclude fonts from the HTML document. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to exclude fonts, false otherwise. | ### getFontsToExclude() {#getFontsToExclude--} ``` @@ -433,31 +462,30 @@ public final List getFontsToExclude() ``` -The list of font names, to exclude from HTML document. +Retrieves the list of font names to exclude from the HTML document. --------------------- +This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems. -This option is supported for presentations only. The fonts that are added into HTML document improve stability of the output view, at the same time they increase the size of the rendering result. This option, lets you find compromise, between stability and output size. Include the font names that are popular and installed into most systems. -Please note, this property is active only when ExcludeFonts (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) options is disabled. +***Note:** Please note that this property is active only when the ExcludeFonts (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled.* **Returns:** -java.util.List +java.util.List - the list of font names to exclude from the HTML document. ### setFontsToExclude(List value) {#setFontsToExclude-java.util.List-java.lang.String--} ``` public final void setFontsToExclude(List value) ``` -The list of font names, to exclude from HTML document. +Sets the list of font names to exclude from the HTML document. --------------------- +This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems. -This option is supported for presentations only. The fonts that are added into HTML document improve stability of the output view, at the same time they increase the size of the rendering result. This option, lets you find compromise, between stability and output size. Include the font names that are popular and installed into most systems. Please note, this property is active only when ExcludeFonts (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) options is disabled. +***Note:** Please note that this property is active only when the ExcludeFonts (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.util.List | | +| value | java.util.List | The list of font names to exclude from the HTML document. | ### isForPrinting() {#isForPrinting--} ``` @@ -465,22 +493,22 @@ public final boolean isForPrinting() ``` -Indicates whether to optimize output HTML for printing. +Checks if the output HTML should be optimized for printing. **Returns:** -boolean +boolean - true if the output HTML should be optimized for printing, false otherwise. ### setForPrinting(boolean value) {#setForPrinting-boolean-} ``` public final void setForPrinting(boolean value) ``` -Indicates whether to optimize output HTML for printing. +Sets whether the output HTML should be optimized for printing. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to optimize the output HTML for printing, false otherwise. | ### getDocumentSavingCallback() {#getDocumentSavingCallback--} ``` @@ -488,20 +516,20 @@ public IDocumentSavingCallback getDocumentSavingCallback() ``` -Callback to estimate Words or Email document saving progress +Retrieves the callback used to estimate the saving progress of a Words or Email document. **Returns:** -com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - Callback to estimate document saving progress +com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback used to estimate the document saving progress. ### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) {#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-} ``` public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) ``` -Callback to estimate Words or Email document saving progress +Sets the callback used to estimate the saving progress of a Words or Email document. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | Callback to estimate document saving progress | +| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback used to estimate the document saving progress. | diff --git a/english/java/com.groupdocs.viewer.options/imagequality/_index.md b/english/java/com.groupdocs.viewer.options/imagequality/_index.md index 144325fe4..cda5db0be 100644 --- a/english/java/com.groupdocs.viewer.options/imagequality/_index.md +++ b/english/java/com.groupdocs.viewer.options/imagequality/_index.md @@ -13,6 +13,23 @@ public enum ImageQuality extends Enum ``` The quality of images in the output HTML contained by the PDF documents. + +The ImageQuality enum represents the quality of images in the output HTML contained by the PDF documents in the GroupDocs.Viewer component. It provides different levels of image quality that can be used to control the rendering and compression of images in the generated HTML output. + +Example usage: + +``` + + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(); + PdfOptions pdfOptions = htmlViewOptions.getPdfOptions(); + pdfOptions.setImageQuality(ImageQuality.HIGH); + + try (Viewer viewer = new Viewer("document.pdf")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | @@ -32,7 +49,7 @@ public static final ImageQuality LOW ``` -The acceptable quality and best performance. +The acceptable quality and best performance. This setting prioritizes rendering speed over image quality. ### MEDIUM {#MEDIUM} ``` @@ -40,7 +57,7 @@ public static final ImageQuality MEDIUM ``` -Better quality and slower performance. +Better quality and slower performance. This setting provides a balance between image quality and rendering speed. ### HIGH {#HIGH} ``` @@ -48,7 +65,7 @@ public static final ImageQuality HIGH ``` -Best quality but slow performance. +Best quality but slow performance. This setting prioritizes image quality over rendering speed. ### values() {#values--} ``` diff --git a/english/java/com.groupdocs.viewer.options/imaxsizeoptions/_index.md b/english/java/com.groupdocs.viewer.options/imaxsizeoptions/_index.md index 5f814c338..2ba73e707 100644 --- a/english/java/com.groupdocs.viewer.options/imaxsizeoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/imaxsizeoptions/_index.md @@ -10,36 +10,38 @@ public interface IMaxSizeOptions ``` Limits of image size options interface. + +The IMaxSizeOptions interface defines the limits of image size options in the GroupDocs.Viewer component. It serves as a contract for classes that provide maximum size constraints for rendering images. ## Methods | Method | Description | | --- | --- | -| [getMaxWidth()](#getMaxWidth--) | Max width of an output image in pixels. | -| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Max width of an output image in pixels. | -| [getMaxHeight()](#getMaxHeight--) | Max height of an output image in pixels. | -| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Max height of an output image in pixels. | +| [getMaxWidth()](#getMaxWidth--) | Retrieves the maximum width of an output image in pixels. | +| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Sets the maximum width of an output image in pixels. | +| [getMaxHeight()](#getMaxHeight--) | Retrieves the maximum height of an output image in pixels. | +| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Sets the maximum height of an output image in pixels. | ### getMaxWidth() {#getMaxWidth--} ``` public abstract int getMaxWidth() ``` -Max width of an output image in pixels. +Retrieves the maximum width of an output image in pixels. **Returns:** -int +int - the maximum width of the output image. ### setMaxWidth(int maxWidth) {#setMaxWidth-int-} ``` public abstract void setMaxWidth(int maxWidth) ``` -Max width of an output image in pixels. +Sets the maximum width of an output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxWidth | int | | +| maxWidth | int | The maximum width of the output image. | ### getMaxHeight() {#getMaxHeight--} ``` @@ -47,20 +49,20 @@ public abstract int getMaxHeight() ``` -Max height of an output image in pixels. +Retrieves the maximum height of an output image in pixels. **Returns:** -int +int - the maximum height of the output image. ### setMaxHeight(int maxHeight) {#setMaxHeight-int-} ``` public abstract void setMaxHeight(int maxHeight) ``` -Max height of an output image in pixels. +Sets the maximum height of an output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxHeight | int | | +| maxHeight | int | The maximum height of the output image. | diff --git a/english/java/com.groupdocs.viewer.options/jpgviewoptions/_index.md b/english/java/com.groupdocs.viewer.options/jpgviewoptions/_index.md index 0a0aa7bec..cf9ce70ef 100644 --- a/english/java/com.groupdocs.viewer.options/jpgviewoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/jpgviewoptions/_index.md @@ -16,47 +16,68 @@ public class JpgViewOptions extends ViewOptions implements IMaxSizeOptions ``` Provides options for rendering documents into JPG format. + +The JpgViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into JPG format in the GroupDocs.Viewer component. + +Example usage: + +``` + + JpgViewOptions options = new JpgViewOptions(); + options.setMaxWidth(1920); + options.setMaxHeight(1080); + options.setQuality((byte) 96); + options.setRenderComments(true); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(options); + // Use the viewer object for further operations + } + +``` + +***Note:** The JpgViewOptions class implements the IMaxSizeOptions interface to specify the maximum size of the output JPG images.* ## Constructors | Constructor | Description | | --- | --- | -| [JpgViewOptions(CreatePageStream createPageStream)](#JpgViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-) | Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. | -| [JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)](#JpgViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-) | Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. | -| [JpgViewOptions(PageStreamFactory pageStreamFactory)](#JpgViewOptions-com.groupdocs.viewer.interfaces.PageStreamFactory-) | Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. | -| [JpgViewOptions()](#JpgViewOptions--) | Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. | -| [JpgViewOptions(String filePathFormat)](#JpgViewOptions-java.lang.String-) | Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. | -| [JpgViewOptions(Path filePathFormat)](#JpgViewOptions-java.nio.file.Path-) | Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. | +| [JpgViewOptions(CreatePageStream createPageStream)](#JpgViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-) | Initializes a new instance of the JpgViewOptions class. | +| [JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)](#JpgViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-) | Initializes a new instance of the JpgViewOptions class. | +| [JpgViewOptions(PageStreamFactory pageStreamFactory)](#JpgViewOptions-com.groupdocs.viewer.interfaces.PageStreamFactory-) | Initializes a new instance of the JpgViewOptions class. | +| [JpgViewOptions()](#JpgViewOptions--) | Initializes a new instance of JpgViewOptions with "p\_\{0\}.jpg" as the file path format for the output files. | +| [JpgViewOptions(String filePathFormat)](#JpgViewOptions-java.lang.String-) | Initializes a new instance of the JpgViewOptions class. | +| [JpgViewOptions(Path filePathFormat)](#JpgViewOptions-java.nio.file.Path-) | Initializes a new instance of the JpgViewOptions class. | ## Methods | Method | Description | | --- | --- | -| [getMaxWidth()](#getMaxWidth--) | Max width of an output image in pixels. | -| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Max width of an output image in pixels. | -| [getMaxHeight()](#getMaxHeight--) | Max height of an output image in pixels. | -| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Max height of an output image in pixels. | -| [getQuality()](#getQuality--) | Quality of the output image; Valid values are between 1 and 100; Default value is 90. | -| [setQuality(byte value)](#setQuality-byte-) | Quality of the output image; Valid values are between 1 and 100; Default value is 90. | +| [getMaxWidth()](#getMaxWidth--) | Gets the maximum width of an output image in pixels. | +| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Sets the maximum width of an output image in pixels. | +| [getMaxHeight()](#getMaxHeight--) | Gets the maximum height of an output image in pixels. | +| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Sets the maximum height of an output image in pixels. | +| [getQuality()](#getQuality--) | Gets the quality of the output image. | +| [setQuality(byte value)](#setQuality-byte-) | Sets the quality of the output image. | | [isExtractText()](#isExtractText--) | Enables text extraction. | -| [setExtractText(boolean value)](#setExtractText-boolean-) | Enables text extraction. | -| [getWidth()](#getWidth--) | The width of the output image in pixels. | -| [setWidth(int value)](#setWidth-int-) | The width of the output image in pixels. | -| [getHeight()](#getHeight--) | The height of an output image in pixels. | -| [setHeight(int value)](#setHeight-int-) | The height of an output image in pixels. | -| [getPageStreamFactory()](#getPageStreamFactory--) | The factory which implements methods for creating and releasing output page stream. | -| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Callback to estimate Words or Email document saving progress | -| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Callback to estimate Words or Email document saving progress | +| [setExtractText(boolean value)](#setExtractText-boolean-) | Enables or disables text extraction. | +| [getWidth()](#getWidth--) | Gets the width of the output image in pixels. | +| [setWidth(int value)](#setWidth-int-) | Sets the width of the output image in pixels. | +| [getHeight()](#getHeight--) | Gets the height of the output image in pixels. | +| [setHeight(int value)](#setHeight-int-) | Sets the height of the output image in pixels. | +| [getPageStreamFactory()](#getPageStreamFactory--) | Gets the factory that implements methods for creating and releasing the output page stream. | +| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Gets the callback to estimate the saving progress of a Words or Email document. | +| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Sets the callback to estimate the saving progress of a Words or Email document. | ### JpgViewOptions(CreatePageStream createPageStream) {#JpgViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-} ``` public JpgViewOptions(CreatePageStream createPageStream) ``` -Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. +Initializes a new instance of the JpgViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates the stream used to write the output page data. | ### JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) {#JpgViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-} ``` @@ -64,13 +85,13 @@ public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream relea ``` -Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. +Initializes a new instance of the JpgViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | -| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases stream created by method assigned to delegate that passed to createPageStream parameter. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates the stream used to write the output page data. | +| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases the stream created by the method assigned to the delegate passed to the createPageStream parameter. | ### JpgViewOptions(PageStreamFactory pageStreamFactory) {#JpgViewOptions-com.groupdocs.viewer.interfaces.PageStreamFactory-} ``` @@ -78,12 +99,12 @@ public JpgViewOptions(PageStreamFactory pageStreamFactory) ``` -Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. +Initializes a new instance of the JpgViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory which implements methods for creating and releasing output page stream. | +| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory that implements methods for creating and releasing the output page stream. | ### JpgViewOptions() {#JpgViewOptions--} ``` @@ -91,11 +112,7 @@ public JpgViewOptions() ``` -Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. - --------------------- - -This constructor initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) with "p\_\{0\}.jpg" as file path format for the output files. The output files will be placed into current working directory of the application. +Initializes a new instance of JpgViewOptions with "p\_\{0\}.jpg" as the file path format for the output files. The output files will be placed into the current working directory of the application. ### JpgViewOptions(String filePathFormat) {#JpgViewOptions-java.lang.String-} ``` @@ -103,12 +120,12 @@ public JpgViewOptions(String filePathFormat) ``` -Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. +Initializes a new instance of the JpgViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| filePathFormat | java.lang.String | The file path format e.g. 'page\_\{0\}.jpg'. | +| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.jpg'. | ### JpgViewOptions(Path filePathFormat) {#JpgViewOptions-java.nio.file.Path-} ``` @@ -116,12 +133,12 @@ public JpgViewOptions(Path filePathFormat) ``` -Initializes new instance of [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) class. +Initializes a new instance of the JpgViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| filePathFormat | java.nio.file.Path | The file path format e.g. 'page\_\{0\}.jpg'. | +| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.jpg'. | ### getMaxWidth() {#getMaxWidth--} ``` @@ -129,22 +146,22 @@ public int getMaxWidth() ``` -Max width of an output image in pixels. +Gets the maximum width of an output image in pixels. **Returns:** -int +int - the maximum width of an output image. ### setMaxWidth(int maxWidth) {#setMaxWidth-int-} ``` public void setMaxWidth(int maxWidth) ``` -Max width of an output image in pixels. +Sets the maximum width of an output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxWidth | int | | +| maxWidth | int | The maximum width of an output image. | ### getMaxHeight() {#getMaxHeight--} ``` @@ -152,22 +169,22 @@ public int getMaxHeight() ``` -Max height of an output image in pixels. +Gets the maximum height of an output image in pixels. **Returns:** -int +int - the maximum height of an output image. ### setMaxHeight(int maxHeight) {#setMaxHeight-int-} ``` public void setMaxHeight(int maxHeight) ``` -Max height of an output image in pixels. +Sets the maximum height of an output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxHeight | int | | +| maxHeight | int | The maximum height of an output image. | ### getQuality() {#getQuality--} ``` @@ -175,22 +192,26 @@ public final byte getQuality() ``` -Quality of the output image; Valid values are between 1 and 100; Default value is 90. +Gets the quality of the output image. + +***Note:** Valid values are between 1 and 100. The default value is 90.* **Returns:** -byte +byte - the quality of the output image. ### setQuality(byte value) {#setQuality-byte-} ``` public final void setQuality(byte value) ``` -Quality of the output image; Valid values are between 1 and 100; Default value is 90. +Sets the quality of the output image. + +***Note:** Valid values are between 1 and 100. The default value is 90.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | byte | | +| value | byte | The quality of the output image. | ### isExtractText() {#isExtractText--} ``` @@ -200,28 +221,24 @@ public final boolean isExtractText() Enables text extraction. --------------------- - -This option might be useful when you want to add selectable text layer over the image. +***Note:** This option might be useful when you want to add a selectable text layer over the image.* **Returns:** -boolean +boolean - true if text extraction is enabled, false otherwise. ### setExtractText(boolean value) {#setExtractText-boolean-} ``` public final void setExtractText(boolean value) ``` -Enables text extraction. - --------------------- +Enables or disables text extraction. -This option might be useful when you want to add selectable text layer over the image. +***Note:** This option might be useful when you want to add a selectable text layer over the image.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable text extraction, false to disable it. | ### getWidth() {#getWidth--} ``` @@ -229,22 +246,22 @@ public final int getWidth() ``` -The width of the output image in pixels. +Gets the width of the output image in pixels. **Returns:** -int +int - the width of the output image. ### setWidth(int value) {#setWidth-int-} ``` public final void setWidth(int value) ``` -The width of the output image in pixels. +Sets the width of the output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | int | | +| value | int | The width of the output image. | ### getHeight() {#getHeight--} ``` @@ -252,22 +269,22 @@ public final int getHeight() ``` -The height of an output image in pixels. +Gets the height of the output image in pixels. **Returns:** -int +int - the height of the output image. ### setHeight(int value) {#setHeight-int-} ``` public final void setHeight(int value) ``` -The height of an output image in pixels. +Sets the height of the output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | int | | +| value | int | The height of the output image. | ### getPageStreamFactory() {#getPageStreamFactory--} ``` @@ -275,30 +292,30 @@ public final PageStreamFactory getPageStreamFactory() ``` -The factory which implements methods for creating and releasing output page stream. +Gets the factory that implements methods for creating and releasing the output page stream. **Returns:** -[PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) +[PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) - the factory for the output page stream. ### getDocumentSavingCallback() {#getDocumentSavingCallback--} ``` public IDocumentSavingCallback getDocumentSavingCallback() ``` -Callback to estimate Words or Email document saving progress +Gets the callback to estimate the saving progress of a Words or Email document. **Returns:** -com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - Callback to estimate document saving progress +com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress. ### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) {#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-} ``` public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) ``` -Callback to estimate Words or Email document saving progress +Sets the callback to estimate the saving progress of a Words or Email document. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | Callback to estimate document saving progress | +| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. | diff --git a/english/java/com.groupdocs.viewer.options/loadoptions/_index.md b/english/java/com.groupdocs.viewer.options/loadoptions/_index.md index d0d7870b4..64ba9cd63 100644 --- a/english/java/com.groupdocs.viewer.options/loadoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/loadoptions/_index.md @@ -1,7 +1,7 @@ --- title: LoadOptions second_title: GroupDocs.Viewer for Java API Reference -description: Provides options that used to open the file. +description: Provides options that are used to open a file. type: docs weight: 18 url: /java/com.groupdocs.viewer.options/loadoptions/ @@ -12,13 +12,30 @@ java.lang.Object public class LoadOptions ``` -Provides options that used to open the file. +Provides options that are used to open a file. + +The LoadOptions class encapsulates various settings and parameters that can be used to specify how a file should be opened and loaded in the GroupDocs.Viewer component. + +Example usage: + +``` + + LoadOptions options = new LoadOptions(); + options.setPassword("myPassword"); + options.setFileType(PDF); + options.setCharset(Charset.forName("UTF-8")); + + try (Viewer viewer = new Viewer(pdfFileInputStream, options)) { + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [LoadOptions()](#LoadOptions--) | Initializes new instance of [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) class. | -| [LoadOptions(FileType fileType)](#LoadOptions-com.groupdocs.viewer.FileType-) | Initializes new instance of [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) class. | +| [LoadOptions()](#LoadOptions--) | Initializes a new instance of the LoadOptions class. | +| [LoadOptions(FileType fileType)](#LoadOptions-com.groupdocs.viewer.FileType-) | Initializes a new instance of the LoadOptions class. | ## Fields | Field | Description | @@ -29,27 +46,27 @@ Provides options that used to open the file. | Method | Description | | --- | --- | -| [getFileType()](#getFileType--) | The type of the file to open. | -| [setFileType(FileType value)](#setFileType-com.groupdocs.viewer.FileType-) | The type of the file to open. | -| [getPassword()](#getPassword--) | The password for opening encrypted file. | -| [setPassword(String value)](#setPassword-java.lang.String-) | The password for opening encrypted file. | -| [getCharset()](#getCharset--) | The Charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). | -| [setCharset(Charset value)](#setCharset-java.nio.charset.Charset-) | The Charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). | -| [getResourceLoadingTimeout()](#getResourceLoadingTimeout--) | The external resources e.g. graphics loading timeout. | -| [setResourceLoadingTimeout(int resourceLoadingTimeout)](#setResourceLoadingTimeout-int-) | The external resources e.g. graphics loading timeout. | -| [getUrlConnectTimeout()](#getUrlConnectTimeout--) | Connect timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 5 seconds | -| [setUrlConnectTimeout(int urlConnectTimeout)](#setUrlConnectTimeout-int-) | Connect timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 5 seconds | -| [getUrlReadTimeout()](#getUrlReadTimeout--) | Read timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 30 seconds | -| [setUrlReadTimeout(int urlReadTimeout)](#setUrlReadTimeout-int-) | Read timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 30 seconds | -| [getArchiveSecurityOptions()](#getArchiveSecurityOptions--) | Security options to control the process of extracting archives. | -| [setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions)](#setArchiveSecurityOptions-com.groupdocs.viewer.options.ArchiveSecurityOptions-) | Security options to control the process of extracting archives. | +| [getFileType()](#getFileType--) | Gets the type of the file to open. | +| [setFileType(FileType value)](#setFileType-com.groupdocs.viewer.FileType-) | Sets the type of the file to open. | +| [getPassword()](#getPassword--) | Gets the password for opening an encrypted file. | +| [setPassword(String value)](#setPassword-java.lang.String-) | Sets the password for opening an encrypted file. | +| [getCharset()](#getCharset--) | Gets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). | +| [setCharset(Charset value)](#setCharset-java.nio.charset.Charset-) | Sets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). | +| [getResourceLoadingTimeout()](#getResourceLoadingTimeout--) | Gets the timeout for loading external resources, such as graphics. | +| [setResourceLoadingTimeout(int resourceLoadingTimeout)](#setResourceLoadingTimeout-int-) | Sets the timeout for loading external resources, such as graphics. | +| [getUrlConnectTimeout()](#getUrlConnectTimeout--) | Gets the connection timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. | +| [setUrlConnectTimeout(int urlConnectTimeout)](#setUrlConnectTimeout-int-) | Sets the connection timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. | +| [getUrlReadTimeout()](#getUrlReadTimeout--) | Gets the read timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. | +| [setUrlReadTimeout(int urlReadTimeout)](#setUrlReadTimeout-int-) | Sets the read timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. | +| [getArchiveSecurityOptions()](#getArchiveSecurityOptions--) | Gets the security options to control the process of extracting archives. | +| [setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions)](#setArchiveSecurityOptions-com.groupdocs.viewer.options.ArchiveSecurityOptions-) | Sets the security options to control the process of extracting archives. | ### LoadOptions() {#LoadOptions--} ``` public LoadOptions() ``` -Initializes new instance of [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) class. +Initializes a new instance of the LoadOptions class. ### LoadOptions(FileType fileType) {#LoadOptions-com.groupdocs.viewer.FileType-} ``` @@ -57,7 +74,7 @@ public LoadOptions(FileType fileType) ``` -Initializes new instance of [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) class. +Initializes a new instance of the LoadOptions class. **Parameters:** | Parameter | Type | Description | @@ -82,22 +99,22 @@ public final FileType getFileType() ``` -The type of the file to open. +Gets the type of the file to open. **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) +[FileType](../../com.groupdocs.viewer/filetype) - the file type. ### setFileType(FileType value) {#setFileType-com.groupdocs.viewer.FileType-} ``` public final void setFileType(FileType value) ``` -The type of the file to open. +Sets the type of the file to open. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [FileType](../../com.groupdocs.viewer/filetype) | | +| value | [FileType](../../com.groupdocs.viewer/filetype) | The file type. | ### getPassword() {#getPassword--} ``` @@ -105,22 +122,22 @@ public final String getPassword() ``` -The password for opening encrypted file. +Gets the password for opening an encrypted file. **Returns:** -java.lang.String +java.lang.String - the password for opening the file. ### setPassword(String value) {#setPassword-java.lang.String-} ``` public final void setPassword(String value) ``` -The password for opening encrypted file. +Sets the password for opening an encrypted file. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The password for opening the file. | ### getCharset() {#getCharset--} ``` @@ -128,22 +145,26 @@ public final Charset getCharset() ``` -The Charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). Default value is (Charset\#defaultCharset().defaultCharset()\}). +Gets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). + +***Note:** The default value is Charset\#defaultCharset().defaultCharset().* **Returns:** -java.nio.charset.Charset +java.nio.charset.Charset - the charset used for opening text-based files or email messages. ### setCharset(Charset value) {#setCharset-java.nio.charset.Charset-} ``` public final void setCharset(Charset value) ``` -The Charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). Default value is (Charset\#defaultCharset().defaultCharset()). +Sets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). + +***Note:** The default value is Charset\#defaultCharset().defaultCharset().* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.nio.charset.Charset | | +| value | java.nio.charset.Charset | The charset used for opening text-based files or email messages. | ### getResourceLoadingTimeout() {#getResourceLoadingTimeout--} ``` @@ -151,22 +172,30 @@ public int getResourceLoadingTimeout() ``` -The external resources e.g. graphics loading timeout. The default value is 30 seconds. This option is supported for Word Processing documents that contain external resources. +Gets the timeout for loading external resources, such as graphics. + +***Note:** The default value is 30 seconds.* + +This option is supported for Word Processing documents that contain external resources. **Returns:** -int - loading timeout +int - the loading timeout, milliseconds. ### setResourceLoadingTimeout(int resourceLoadingTimeout) {#setResourceLoadingTimeout-int-} ``` public void setResourceLoadingTimeout(int resourceLoadingTimeout) ``` -The external resources e.g. graphics loading timeout. The default value is 30 seconds. This option is supported for Word Processing documents that contain external resources. +Sets the timeout for loading external resources, such as graphics. + +***Note:** The default value is 30 seconds.* + +This option is supported for Word Processing documents that contain external resources. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| resourceLoadingTimeout | int | loading timeout | +| resourceLoadingTimeout | int | The loading timeout, milliseconds. | ### getUrlConnectTimeout() {#getUrlConnectTimeout--} ``` @@ -174,22 +203,26 @@ public int getUrlConnectTimeout() ``` -Connect timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 5 seconds +Gets the connection timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. + +***Note:** The default value is 5 seconds.* **Returns:** -int - connect timeout +int - the connection timeout. ### setUrlConnectTimeout(int urlConnectTimeout) {#setUrlConnectTimeout-int-} ``` public void setUrlConnectTimeout(int urlConnectTimeout) ``` -Connect timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 5 seconds +Sets the connection timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. + +***Note:** The default value is 5 seconds.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| urlConnectTimeout | int | connect timeout | +| urlConnectTimeout | int | The connection timeout. | ### getUrlReadTimeout() {#getUrlReadTimeout--} ``` @@ -197,22 +230,26 @@ public int getUrlReadTimeout() ``` -Read timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 30 seconds +Gets the read timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. + +***Note:** The default value is 30 seconds.* **Returns:** -int - read timeout +int - the read timeout. ### setUrlReadTimeout(int urlReadTimeout) {#setUrlReadTimeout-int-} ``` public void setUrlReadTimeout(int urlReadTimeout) ``` -Read timeout to create [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load document, default value is 30 seconds +Sets the read timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. + +***Note:** The default value is 30 seconds.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| urlReadTimeout | int | read timeout | +| urlReadTimeout | int | The read timeout. | ### getArchiveSecurityOptions() {#getArchiveSecurityOptions--} ``` @@ -220,17 +257,21 @@ public ArchiveSecurityOptions getArchiveSecurityOptions() ``` -Security options to control the process of extracting archives. Not each archive type supports all options. +Gets the security options to control the process of extracting archives. + +***Note:** Not each archive type supports all options.* **Returns:** -com.groupdocs.viewer.options.ArchiveSecurityOptions - The options object to configure the process of extracting archives. +com.groupdocs.viewer.options.ArchiveSecurityOptions - the options object to configure the process of extracting archives. ### setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions) {#setArchiveSecurityOptions-com.groupdocs.viewer.options.ArchiveSecurityOptions-} ``` public void setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions) ``` -Security options to control the process of extracting archives. Not each archive type supports all options. +Sets the security options to control the process of extracting archives. + +***Note:** Not each archive type supports all options.* **Parameters:** | Parameter | Type | Description | diff --git a/english/java/com.groupdocs.viewer.options/mailstorageoptions/_index.md b/english/java/com.groupdocs.viewer.options/mailstorageoptions/_index.md index 2de422d4d..690ec5ab6 100644 --- a/english/java/com.groupdocs.viewer.options/mailstorageoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/mailstorageoptions/_index.md @@ -13,6 +13,26 @@ public class MailStorageOptions ``` Provides options for rendering Mail storage (Lotus Notes, MBox) data files. + +The MailStorageOptions class encapsulates various settings and parameters that can be used to control the rendering of Mail storage data files (such as Lotus Notes or MBox) in the GroupDocs.Viewer component. + +Example usage: + +``` + + MailStorageOptions options = new MailStorageOptions(); + options.setAddressFilter("@gmail.com"); + options.setMaxItems(10); + + final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(); + htmlViewOptions.setMailStorageOptions(options); + + try (Viewer viewer = new Viewer("mail.msg")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | @@ -22,12 +42,12 @@ Provides options for rendering Mail storage (Lotus Notes, MBox) data files. | Method | Description | | --- | --- | -| [getTextFilter()](#getTextFilter--) | The keywords used to filter messages. | +| [getTextFilter()](#getTextFilter--) | Gets the keywords used to filter messages. | | [setTextFilter(String textFilter)](#setTextFilter-java.lang.String-) | Sets the keywords used to filter messages. | -| [getAddressFilter()](#getAddressFilter--) | The email-address used to filter messages by sender or recipient. | -| [setAddressFilter(String addressFilter)](#setAddressFilter-java.lang.String-) | Sets email-address used to filter messages by sender or recipient. | -| [getMaxItems()](#getMaxItems--) | The maximum number of messages or items for render. | -| [setMaxItems(int maxItems)](#setMaxItems-int-) | Sets maximum number of messages or items for render. | +| [getAddressFilter()](#getAddressFilter--) | Gets the email address used to filter messages by sender or recipient. | +| [setAddressFilter(String addressFilter)](#setAddressFilter-java.lang.String-) | Sets the email address used to filter messages by sender or recipient. | +| [getMaxItems()](#getMaxItems--) | Gets the maximum number of messages or items to render. | +| [setMaxItems(int maxItems)](#setMaxItems-int-) | Sets the maximum number of messages or items to render. | ### MailStorageOptions() {#MailStorageOptions--} ``` public MailStorageOptions() @@ -40,10 +60,10 @@ public String getTextFilter() ``` -The keywords used to filter messages. +Gets the keywords used to filter messages. **Returns:** -java.lang.String +java.lang.String - the keywords used for filtering messages. ### setTextFilter(String textFilter) {#setTextFilter-java.lang.String-} ``` public void setTextFilter(String textFilter) @@ -55,7 +75,7 @@ Sets the keywords used to filter messages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| textFilter | java.lang.String | the keywords used to filter messages. | +| textFilter | java.lang.String | The keywords used for filtering messages. | ### getAddressFilter() {#getAddressFilter--} ``` @@ -63,22 +83,22 @@ public String getAddressFilter() ``` -The email-address used to filter messages by sender or recipient. +Gets the email address used to filter messages by sender or recipient. **Returns:** -java.lang.String - The email-address +java.lang.String - the email address used for filtering messages. ### setAddressFilter(String addressFilter) {#setAddressFilter-java.lang.String-} ``` public void setAddressFilter(String addressFilter) ``` -Sets email-address used to filter messages by sender or recipient. +Sets the email address used to filter messages by sender or recipient. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| addressFilter | java.lang.String | the email-address used to filter messages | +| addressFilter | java.lang.String | The email address used for filtering messages. | ### getMaxItems() {#getMaxItems--} ``` @@ -86,24 +106,28 @@ public int getMaxItems() ``` -The maximum number of messages or items for render. +Gets the maximum number of messages or items to render. -Lotus notes data files can be large and retrieving all messages can take significant time. This setting limits maximum number of messages or items that are rendered. Default value is 0 - all messages will be rendered +Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered. + +***Note:** The default value is 0, which means all messages will be rendered.* **Returns:** -int +int - the maximum number of messages or items to render. ### setMaxItems(int maxItems) {#setMaxItems-int-} ``` public void setMaxItems(int maxItems) ``` -Sets maximum number of messages or items for render. +Sets the maximum number of messages or items to render. + +Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered. -Lotus notes data files can be large and retrieving all messages can take significant time. This setting limits maximum number of messages or items that are rendered. Default value is 0 - all messages will be rendered +***Note:** The default value is 0, which means all messages will be rendered.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxItems | int | Maximum number of messages | +| maxItems | int | The maximum number of messages or items to render. | diff --git a/english/java/com.groupdocs.viewer.options/outlookoptions/_index.md b/english/java/com.groupdocs.viewer.options/outlookoptions/_index.md index 28c50628d..6b00ecaf8 100644 --- a/english/java/com.groupdocs.viewer.options/outlookoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/outlookoptions/_index.md @@ -13,6 +13,26 @@ public class OutlookOptions ``` Provides options for rendering Outlook data files. + +The OutlookOptions class encapsulates various settings and parameters that can be used to control the rendering of Outlook data files (such as PST or OST files) in the GroupDocs.Viewer component. + +Example usage: + +``` + + OutlookOptions options = new OutlookOptions(); + options.setAddressFilter("@gmail.com"); + options.setFolder("folderName"); + + final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(); + htmlViewOptions.setOutlookOptions(options); + + try (Viewer viewer = new Viewer("mail.pst")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | @@ -22,14 +42,14 @@ Provides options for rendering Outlook data files. | Method | Description | | --- | --- | -| [getFolder()](#getFolder--) | The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. | -| [setFolder(String value)](#setFolder-java.lang.String-) | The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. | -| [getTextFilter()](#getTextFilter--) | The keywords used to filter messages. | -| [setTextFilter(String value)](#setTextFilter-java.lang.String-) | The keywords used to filter messages. | -| [getAddressFilter()](#getAddressFilter--) | The email-address used to filter messages by sender or recipient. | -| [setAddressFilter(String value)](#setAddressFilter-java.lang.String-) | The email-address used to filter messages by sender or recipient. | -| [getMaxItemsInFolder()](#getMaxItemsInFolder--) | The maximum number of messages or items, that can be rendered from one folder. | -| [setMaxItemsInFolder(int value)](#setMaxItemsInFolder-int-) | The maximum number of messages or items, that can be rendered from one folder. | +| [getFolder()](#getFolder--) | Gets the name of the folder to render. | +| [setFolder(String value)](#setFolder-java.lang.String-) | Sets the name of the folder to render. | +| [getTextFilter()](#getTextFilter--) | Gets the keywords used to filter messages. | +| [setTextFilter(String value)](#setTextFilter-java.lang.String-) | Gets the keywords used to filter messages. | +| [getAddressFilter()](#getAddressFilter--) | Gets the email address used to filter messages by sender or recipient. | +| [setAddressFilter(String value)](#setAddressFilter-java.lang.String-) | Sets the email address used to filter messages by sender or recipient. | +| [getMaxItemsInFolder()](#getMaxItemsInFolder--) | Gets the maximum number of messages or items that can be rendered from one folder. | +| [setMaxItemsInFolder(int value)](#setMaxItemsInFolder-int-) | Sets the maximum number of messages or items that can be rendered from one folder. | ### OutlookOptions() {#OutlookOptions--} ``` public OutlookOptions() @@ -42,22 +62,22 @@ public final String getFolder() ``` -The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. +Gets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render. **Returns:** -java.lang.String +java.lang.String - the name of the folder to render. ### setFolder(String value) {#setFolder-java.lang.String-} ``` public final void setFolder(String value) ``` -The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. +Sets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The name of the folder to render. | ### getTextFilter() {#getTextFilter--} ``` @@ -65,22 +85,22 @@ public final String getTextFilter() ``` -The keywords used to filter messages. +Gets the keywords used to filter messages. **Returns:** -java.lang.String +java.lang.String - the keywords. ### setTextFilter(String value) {#setTextFilter-java.lang.String-} ``` public final void setTextFilter(String value) ``` -The keywords used to filter messages. +Gets the keywords used to filter messages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The keywords. | ### getAddressFilter() {#getAddressFilter--} ``` @@ -88,22 +108,22 @@ public final String getAddressFilter() ``` -The email-address used to filter messages by sender or recipient. +Gets the email address used to filter messages by sender or recipient. **Returns:** -java.lang.String +java.lang.String - the email address used to filter messages. ### setAddressFilter(String value) {#setAddressFilter-java.lang.String-} ``` public final void setAddressFilter(String value) ``` -The email-address used to filter messages by sender or recipient. +Sets the email address used to filter messages by sender or recipient. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The email address used to filter messages. | ### getMaxItemsInFolder() {#getMaxItemsInFolder--} ``` @@ -111,28 +131,24 @@ public final int getMaxItemsInFolder() ``` -The maximum number of messages or items, that can be rendered from one folder. +Gets the maximum number of messages or items that can be rendered from one folder. --------------------- - -Outlook data files can be large and retrieving all messages can take significant time. This setting limits maximum number of messages or items (like contacts and tasks) that are rendered. Default value is 50. In order to render all messages, set the value to 0. +Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. **Returns:** -int +int - the maximum number of messages or items that can be rendered from one folder. ### setMaxItemsInFolder(int value) {#setMaxItemsInFolder-int-} ``` public final void setMaxItemsInFolder(int value) ``` -The maximum number of messages or items, that can be rendered from one folder. - --------------------- +Sets the maximum number of messages or items that can be rendered from one folder. -Outlook data files can be large and retrieving all messages can take significant time. This setting limits maximum number of messages or items (like contacts and tasks) that are rendered. Default value is 50. In order to render all messages, set the value to 0. +Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | int | | +| value | int | The maximum number of messages or items that can be rendered from one folder. | diff --git a/english/java/com.groupdocs.viewer.options/pagesize/_index.md b/english/java/com.groupdocs.viewer.options/pagesize/_index.md index 1c6d5ec60..91f58579c 100644 --- a/english/java/com.groupdocs.viewer.options/pagesize/_index.md +++ b/english/java/com.groupdocs.viewer.options/pagesize/_index.md @@ -13,18 +13,35 @@ public enum PageSize extends Enum ``` The size of the page. + +The PageSize enum represents different page sizes in the GroupDocs.Viewer component. It provides a set of predefined page sizes that can be used to specify the dimensions of a page in various document rendering scenarios. + +Example usage: + +``` + + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(); + ProjectManagementOptions projectManagementOptions = htmlViewOptions.getProjectManagementOptions(); + projectManagementOptions.setPageSize(PageSize.A4); + + try (Viewer viewer = new Viewer("document.mpp")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | | --- | --- | | [UNSPECIFIED](#UNSPECIFIED) | The default, unspecified page size. | -| [LETTER](#LETTER) | The size of the Letter page in points is 792 x 612 | -| [LEDGER](#LEDGER) | The size of the Ledger page in points is 1224 x 792 | -| [A0](#A0) | The size of the A0 page in points is 3371 x 2384 | -| [A1](#A1) | The size of the A1 page in points is 2384 x 1685 | -| [A2](#A2) | The size of the A2 page in points is 1684 x 1190 | -| [A3](#A3) | The size of the A3 page in points is 1190 x 842 | -| [A4](#A4) | The size of the A4 page in points is 842 x 595 | +| [LETTER](#LETTER) | The size of the Letter page in points is 792 x 612. | +| [LEDGER](#LEDGER) | The size of the A0 page in points is 3371 x 2384. | +| [A0](#A0) | The size of the A1 page in points is 2384 x 1685. | +| [A1](#A1) | The size of the A2 page in points is 1684 x 1190. | +| [A2](#A2) | The size of the A3 page in points is 1190 x 842. | +| [A3](#A3) | The size of the A3 page in points is 1190 x 842. | +| [A4](#A4) | The size of the A4 page in points is 842 x 595. | ## Methods | Method | Description | @@ -37,7 +54,7 @@ public static final PageSize UNSPECIFIED ``` -The default, unspecified page size. +The default, unspecified page size. This size is used when no specific page size is specified. ### LETTER {#LETTER} ``` @@ -45,7 +62,7 @@ public static final PageSize LETTER ``` -The size of the Letter page in points is 792 x 612 +The size of the Letter page in points is 792 x 612. This page size is commonly used for letters and documents in North America. ### LEDGER {#LEDGER} ``` @@ -53,7 +70,7 @@ public static final PageSize LEDGER ``` -The size of the Ledger page in points is 1224 x 792 +The size of the A0 page in points is 3371 x 2384. This large page size is part of the ISO 216 international standard. ### A0 {#A0} ``` @@ -61,7 +78,7 @@ public static final PageSize A0 ``` -The size of the A0 page in points is 3371 x 2384 +The size of the A1 page in points is 2384 x 1685. This page size is part of the ISO 216 international standard. ### A1 {#A1} ``` @@ -69,7 +86,7 @@ public static final PageSize A1 ``` -The size of the A1 page in points is 2384 x 1685 +The size of the A2 page in points is 1684 x 1190. This page size is part of the ISO 216 international standard. ### A2 {#A2} ``` @@ -77,7 +94,7 @@ public static final PageSize A2 ``` -The size of the A2 page in points is 1684 x 1190 +The size of the A3 page in points is 1190 x 842. This page size is part of the ISO 216 international standard. ### A3 {#A3} ``` @@ -85,7 +102,7 @@ public static final PageSize A3 ``` -The size of the A3 page in points is 1190 x 842 +The size of the A3 page in points is 1190 x 842. This page size is part of the ISO 216 international standard. ### A4 {#A4} ``` @@ -93,7 +110,7 @@ public static final PageSize A4 ``` -The size of the A4 page in points is 842 x 595 +The size of the A4 page in points is 842 x 595. This page size is part of the ISO 216 international standard. ### values() {#values--} ``` diff --git a/english/java/com.groupdocs.viewer.options/pdfoptions/_index.md b/english/java/com.groupdocs.viewer.options/pdfoptions/_index.md index 74c17f08b..545a944ea 100644 --- a/english/java/com.groupdocs.viewer.options/pdfoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/pdfoptions/_index.md @@ -13,34 +13,55 @@ public class PdfOptions ``` Provides options for rendering PDF documents. + +The PdfOptions class encapsulates various settings and parameters that can be used to control the rendering of PDF documents in the GroupDocs.Viewer component. + +Example usage: + +``` + + PdfOptions options = new PdfOptions(); + options.setDisableCharsGrouping(true); + options.setRenderTextAsImage(true); + options.setEnableFontHinting(true); + + final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(); + htmlViewOptions.setPdfOptions(options); + + try (Viewer viewer = new Viewer("document.pdf")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [PdfOptions()](#PdfOptions--) | Initializes new instance of [PdfOptions](../../com.groupdocs.viewer.options/pdfoptions) class. | +| [PdfOptions()](#PdfOptions--) | Initializes a new instance of PdfOptions class. | ## Methods | Method | Description | | --- | --- | -| [isRenderTextAsImage()](#isRenderTextAsImage--) | If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. | -| [setRenderTextAsImage(boolean renderTextAsImage)](#setRenderTextAsImage-boolean-) | If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. | -| [isDisableCharsGrouping()](#isDisableCharsGrouping--) | If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. | -| [setDisableCharsGrouping(boolean value)](#setDisableCharsGrouping-boolean-) | Disables chars grouping to keep maximum precision during chars positioning when rendering the page. | -| [isEnableLayeredRendering()](#isEnableLayeredRendering--) | Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML. | -| [setEnableLayeredRendering(boolean value)](#setEnableLayeredRendering-boolean-) | Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML. | -| [isEnableFontHinting()](#isEnableFontHinting--) | Enables font hinting. | +| [isRenderTextAsImage()](#isRenderTextAsImage--) | Determines whether the text from the source is rendered as an image in HTML. | +| [setRenderTextAsImage(boolean renderTextAsImage)](#setRenderTextAsImage-boolean-) | Sets whether the text from the source is rendered as an image in HTML. | +| [isDisableCharsGrouping()](#isDisableCharsGrouping--) | Checks if character grouping is disabled to maintain maximum precision during character positioning when rendering the page. | +| [setDisableCharsGrouping(boolean value)](#setDisableCharsGrouping-boolean-) | Sets the option to disable character grouping, ensuring maximum precision during character positioning when rendering the page. | +| [isEnableLayeredRendering()](#isEnableLayeredRendering--) | Checks whether rendering of text and graphics should follow the z-order in the original PDF document when rendering into HTML. | +| [setEnableLayeredRendering(boolean value)](#setEnableLayeredRendering-boolean-) | Enables or disables rendering of text and graphics according to the z-order in the original PDF document when rendering into HTML. | +| [isEnableFontHinting()](#isEnableFontHinting--) | Determines whether font hinting is enabled. | | [setEnableFontHinting(boolean value)](#setEnableFontHinting-boolean-) | Enables font hinting. | -| [isRenderOriginalPageSize()](#isRenderOriginalPageSize--) | When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. | -| [setRenderOriginalPageSize(boolean mRenderOriginalPageSize)](#setRenderOriginalPageSize-boolean-) | When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. | -| [getImageQuality()](#getImageQuality--) | Specifies output image quality for image resources when rendering into HTML. | -| [setImageQuality(ImageQuality value)](#setImageQuality-com.groupdocs.viewer.options.ImageQuality-) | Specifies output image quality for image resources when rendering into HTML. | +| [isRenderOriginalPageSize()](#isRenderOriginalPageSize--) | Enables rendering of pages with the same size in pixels as the page size in the source PDF document. | +| [setRenderOriginalPageSize(boolean renderOriginalPageSize)](#setRenderOriginalPageSize-boolean-) | Enables rendering of pages with the same size in pixels as the page size in the source PDF document. | +| [getImageQuality()](#getImageQuality--) | Retrieves the output image quality for image resources when rendering into HTML. | +| [setImageQuality(ImageQuality value)](#setImageQuality-com.groupdocs.viewer.options.ImageQuality-) | Sets the output image quality for image resources when rendering into HTML. | ### PdfOptions() {#PdfOptions--} ``` public PdfOptions() ``` -Initializes new instance of [PdfOptions](../../com.groupdocs.viewer.options/pdfoptions) class. +Initializes a new instance of PdfOptions class. ### isRenderTextAsImage() {#isRenderTextAsImage--} ``` @@ -48,26 +69,30 @@ public boolean isRenderTextAsImage() ``` -If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly. +Determines whether the text from the source is rendered as an image in HTML. -When this option is set to true, the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. This option is supported when rendering into HTML. +When this option is set to true , the text is rendered as an image in the output HTML. Enable this option to make the text unselectable or to fix character rendering and make the HTML look like PDF. This option is supported when rendering into HTML. + +***Note:** The default value is false .* **Returns:** -boolean +boolean - true if the text is rendered as an image in HTML, false otherwise. ### setRenderTextAsImage(boolean renderTextAsImage) {#setRenderTextAsImage-boolean-} ``` public void setRenderTextAsImage(boolean renderTextAsImage) ``` -If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly. +Sets whether the text from the source is rendered as an image in HTML. + +When this option is set to true , the text is rendered as an image in the output HTML. Enable this option to make the text unselectable or to fix character rendering and make the HTML look like PDF. This option is supported when rendering into HTML. -When this option is set to true, the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. This option is supported when rendering into HTML. +***Note:** The default value is false .* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| renderTextAsImage | boolean | | +| renderTextAsImage | boolean | true to render the text as an image in HTML, false otherwise. | ### isDisableCharsGrouping() {#isDisableCharsGrouping--} ``` @@ -75,28 +100,26 @@ public final boolean isDisableCharsGrouping() ``` -If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly. +Checks if character grouping is disabled to maintain maximum precision during character positioning when rendering the page. When this option is enabled, the characters are rendered without any grouping, which ensures maximum precision. -When this option is set to true, the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. This option is supported when rendering into HTML. - -/\*\* - -Disables chars grouping to keep maximum precision during chars positioning when rendering the page. +***Note:** By default, character grouping is enabled.* **Returns:** -boolean +boolean - true if character grouping is disabled, false otherwise. ### setDisableCharsGrouping(boolean value) {#setDisableCharsGrouping-boolean-} ``` public final void setDisableCharsGrouping(boolean value) ``` -Disables chars grouping to keep maximum precision during chars positioning when rendering the page. +Sets the option to disable character grouping, ensuring maximum precision during character positioning when rendering the page. When this option is enabled by setting the value to true , character grouping is disabled, which ensures maximum precision. + +***Note:** Disabling character grouping can help preserve the exact positioning of characters on the rendered page. By default, character grouping is enabled.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to disable character grouping, false to enable it. | ### isEnableLayeredRendering() {#isEnableLayeredRendering--} ``` @@ -104,30 +127,26 @@ public final boolean isEnableLayeredRendering() ``` -Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML. +Checks whether rendering of text and graphics should follow the z-order in the original PDF document when rendering into HTML. When this option is enabled by returning true , text and graphics are rendered according to their z-order in the original PDF document. --------------------- - -By default text and graphics are rendered into HTML as a single layer. +***Note:** By default, text and graphics are rendered into HTML as a single layer.* **Returns:** -boolean +boolean - true if layered rendering is enabled, false otherwise. ### setEnableLayeredRendering(boolean value) {#setEnableLayeredRendering-boolean-} ``` public final void setEnableLayeredRendering(boolean value) ``` -Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML. - --------------------- +Enables or disables rendering of text and graphics according to the z-order in the original PDF document when rendering into HTML. -By default text and graphics are rendered into HTML as a single layer. +***Note:** By default, text and graphics are rendered into HTML as a single layer.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable layered rendering, false to disable it. | ### isEnableFontHinting() {#isEnableFontHinting--} ``` @@ -135,30 +154,26 @@ public final boolean isEnableFontHinting() ``` -Enables font hinting. The font hinting adjusts the display of an outline font. Supported only for TTF fonts when these fonts are used in source document. +Determines whether font hinting is enabled. Font hinting adjusts the display of an outline font. This option is supported only for TrueType (TTF) fonts when used in the source document. --------------------- - -This option is supported when rendering into PNG or JPG formats. +***Note:** This option is supported when rendering into PNG or JPG formats.* **Returns:** -boolean +boolean - true if font hinting is enabled, false otherwise. ### setEnableFontHinting(boolean value) {#setEnableFontHinting-boolean-} ``` public final void setEnableFontHinting(boolean value) ``` -Enables font hinting. The font hinting adjusts the display of an outline font. Supported only for TTF fonts when these fonts are used in source document. - --------------------- +Enables font hinting. Font hinting adjusts the display of an outline font and is supported only for TrueType (TTF) fonts when used in the source document. -This option is supported when rendering into PNG or JPG formats. +***Note:** This option is supported when rendering into PNG or JPG formats.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable font hinting, false to disable it. | ### isRenderOriginalPageSize() {#isRenderOriginalPageSize--} ``` @@ -166,22 +181,26 @@ public boolean isRenderOriginalPageSize() ``` -When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. By default GroupDocs.Viewer calculates output image page size for better rendering quality. +Enables rendering of pages with the same size in pixels as the page size in the source PDF document. + +***Note:** By default, GroupDocs.Viewer calculates the output image page size for better rendering quality.* **Returns:** -boolean - This option is supported when rendering into PNG or JPG formats. -### setRenderOriginalPageSize(boolean mRenderOriginalPageSize) {#setRenderOriginalPageSize-boolean-} +boolean - true if the option is enabled, false otherwise. +### setRenderOriginalPageSize(boolean renderOriginalPageSize) {#setRenderOriginalPageSize-boolean-} ``` -public void setRenderOriginalPageSize(boolean mRenderOriginalPageSize) +public void setRenderOriginalPageSize(boolean renderOriginalPageSize) ``` -When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. By default GroupDocs.Viewer calculates output image page size for better rendering quality. +Enables rendering of pages with the same size in pixels as the page size in the source PDF document. + +***Note:** By default, GroupDocs.Viewer calculates the output image page size for better rendering quality.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| mRenderOriginalPageSize | boolean | This option is supported when rendering into PNG or JPG formats. | +| renderOriginalPageSize | boolean | true to enable rendering with the original page size, false otherwise. | ### getImageQuality() {#getImageQuality--} ``` @@ -189,20 +208,20 @@ public final ImageQuality getImageQuality() ``` -Specifies output image quality for image resources when rendering into HTML. The default value is Low. +Retrieves the output image quality for image resources when rendering into HTML. The default value is Low. **Returns:** -[ImageQuality](../../com.groupdocs.viewer.options/imagequality) - Specifies output image quality for image resources when rendering into HTML. +[ImageQuality](../../com.groupdocs.viewer.options/imagequality) - the output image quality for image resources when rendering into HTML. ### setImageQuality(ImageQuality value) {#setImageQuality-com.groupdocs.viewer.options.ImageQuality-} ``` public final void setImageQuality(ImageQuality value) ``` -Specifies output image quality for image resources when rendering into HTML. The default value is Low. +Sets the output image quality for image resources when rendering into HTML. The default value is Low. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [ImageQuality](../../com.groupdocs.viewer.options/imagequality) | Specifies output image quality for image resources when rendering into HTML. | +| value | [ImageQuality](../../com.groupdocs.viewer.options/imagequality) | The output image quality for image resources when rendering into HTML. | diff --git a/english/java/com.groupdocs.viewer.options/pdfviewoptions/_index.md b/english/java/com.groupdocs.viewer.options/pdfviewoptions/_index.md index 3cb577719..1a273faab 100644 --- a/english/java/com.groupdocs.viewer.options/pdfviewoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/pdfviewoptions/_index.md @@ -13,46 +13,64 @@ public class PdfViewOptions extends ViewOptions ``` Provides options for rendering documents into PDF format. + +The PdfViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into PDF format in the GroupDocs.Viewer component. + +Example usage: + +``` + + PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setImageHeight(256); + pdfViewOptions.setImageWidth(128); + pdfViewOptions.setDefaultFontName("font-name"); + + try (Viewer viewer = new Viewer("document.pdf")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [PdfViewOptions(CreateFileStream createFileStream)](#PdfViewOptions-com.groupdocs.viewer.interfaces.CreateFileStream-) | Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. | -| [PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)](#PdfViewOptions-com.groupdocs.viewer.interfaces.CreateFileStream-com.groupdocs.viewer.interfaces.ReleaseFileStream-) | Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. | -| [PdfViewOptions(FileStreamFactory fileStreamFactory)](#PdfViewOptions-com.groupdocs.viewer.interfaces.FileStreamFactory-) | Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. | -| [PdfViewOptions()](#PdfViewOptions--) | Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. | -| [PdfViewOptions(String outputFilePath)](#PdfViewOptions-java.lang.String-) | Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. | -| [PdfViewOptions(Path outputFilePath)](#PdfViewOptions-java.nio.file.Path-) | Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. | +| [PdfViewOptions(CreateFileStream createFileStream)](#PdfViewOptions-com.groupdocs.viewer.interfaces.CreateFileStream-) | Initializes a new instance of the PdfViewOptions class. | +| [PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)](#PdfViewOptions-com.groupdocs.viewer.interfaces.CreateFileStream-com.groupdocs.viewer.interfaces.ReleaseFileStream-) | Initializes a new instance of the PdfViewOptions class. | +| [PdfViewOptions(FileStreamFactory fileStreamFactory)](#PdfViewOptions-com.groupdocs.viewer.interfaces.FileStreamFactory-) | Initializes a new instance of the PdfViewOptions class. | +| [PdfViewOptions()](#PdfViewOptions--) | Initializes a new instance of the PdfViewOptions class with default settings. | +| [PdfViewOptions(String outputFilePath)](#PdfViewOptions-java.lang.String-) | Initializes a new instance of the PdfViewOptions class. | +| [PdfViewOptions(Path outputFilePath)](#PdfViewOptions-java.nio.file.Path-) | Initializes a new instance of the PdfViewOptions class. | ## Methods | Method | Description | | --- | --- | -| [getJpgQuality()](#getJpgQuality--) | The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90. | -| [setJpgQuality(int value)](#setJpgQuality-int-) | The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90. | -| [getImageMaxWidth()](#getImageMaxWidth--) | Max width of an output image in pixels. | -| [setImageMaxWidth(int imageMaxWidth)](#setImageMaxWidth-int-) | Max width of an output image in pixels. | -| [getImageMaxHeight()](#getImageMaxHeight--) | Max height of an output image in pixels. | -| [setImageMaxHeight(int imageMaxHeight)](#setImageMaxHeight-int-) | Max height of an output image in pixels. | -| [getImageWidth()](#getImageWidth--) | The width of the output image in pixels. | -| [setImageWidth(int imageWidth)](#setImageWidth-int-) | The width of the output image in pixels. | -| [getImageHeight()](#getImageHeight--) | The height of an output image in pixels. | -| [setImageHeight(int imageHeight)](#setImageHeight-int-) | The height of an output image in pixels. | -| [getSecurity()](#getSecurity--) | The output PDF document security options. | -| [setSecurity(Security value)](#setSecurity-com.groupdocs.viewer.options.Security-) | The output PDF document security options. | -| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Callback to estimate Words or Email document saving progress | -| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Callback to estimate Words or Email document saving progress | +| [getJpgQuality()](#getJpgQuality--) | Retrieves the quality of the JPG images contained by the output PDF document. | +| [setJpgQuality(int value)](#setJpgQuality-int-) | Sets the quality of the JPG images contained by the output PDF document. | +| [getImageMaxWidth()](#getImageMaxWidth--) | Retrieves the maximum width of an output image in pixels. | +| [setImageMaxWidth(int imageMaxWidth)](#setImageMaxWidth-int-) | Sets the maximum width of an output image in pixels. | +| [getImageMaxHeight()](#getImageMaxHeight--) | Retrieves the maximum height of an output image in pixels. | +| [setImageMaxHeight(int imageMaxHeight)](#setImageMaxHeight-int-) | Sets the maximum height of an output image in pixels. | +| [getImageWidth()](#getImageWidth--) | Retrieves the width of the output image in pixels. | +| [setImageWidth(int imageWidth)](#setImageWidth-int-) | Sets the width of the output image in pixels. | +| [getImageHeight()](#getImageHeight--) | Retrieves the height of the output image in pixels. | +| [setImageHeight(int imageHeight)](#setImageHeight-int-) | Sets the height of the output image in pixels. | +| [getSecurity()](#getSecurity--) | Retrieves the security options for the output PDF document. | +| [setSecurity(Security value)](#setSecurity-com.groupdocs.viewer.options.Security-) | Sets the security options for the output PDF document. | +| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Retrieves the callback used to estimate the progress of saving a Words or Email document. | +| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Sets the callback used to estimate the progress of saving a Words or Email document. | ### PdfViewOptions(CreateFileStream createFileStream) {#PdfViewOptions-com.groupdocs.viewer.interfaces.CreateFileStream-} ``` public PdfViewOptions(CreateFileStream createFileStream) ``` -Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. +Initializes a new instance of the PdfViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createFileStream | [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) | The method that instantiates stream used to write output file data. | +| createFileStream | [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) | | ### PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream) {#PdfViewOptions-com.groupdocs.viewer.interfaces.CreateFileStream-com.groupdocs.viewer.interfaces.ReleaseFileStream-} ``` @@ -60,13 +78,13 @@ public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream relea ``` -Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. +Initializes a new instance of the PdfViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createFileStream | [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) | The method that instantiates stream used to write output file data. | -| releaseFileStream | [ReleaseFileStream](../../com.groupdocs.viewer.interfaces/releasefilestream) | The method that releases stream created by method assigned to delegate that passed to createFileStream parameter. | +| createFileStream | [CreateFileStream](../../com.groupdocs.viewer.interfaces/createfilestream) | The method used to instantiate the stream for writing the output file data. | +| releaseFileStream | [ReleaseFileStream](../../com.groupdocs.viewer.interfaces/releasefilestream) | The method used to release the stream created by the createFileStream method. | ### PdfViewOptions(FileStreamFactory fileStreamFactory) {#PdfViewOptions-com.groupdocs.viewer.interfaces.FileStreamFactory-} ``` @@ -74,12 +92,12 @@ public PdfViewOptions(FileStreamFactory fileStreamFactory) ``` -Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. +Initializes a new instance of the PdfViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileStreamFactory | [FileStreamFactory](../../com.groupdocs.viewer.interfaces/filestreamfactory) | The factory which implements methods for creating and releasing output file stream. | +| fileStreamFactory | [FileStreamFactory](../../com.groupdocs.viewer.interfaces/filestreamfactory) | The factory that implements methods for creating and releasing the output file stream. | ### PdfViewOptions() {#PdfViewOptions--} ``` @@ -87,11 +105,9 @@ public PdfViewOptions() ``` -Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. - --------------------- +Initializes a new instance of the PdfViewOptions class with default settings. -This constructor initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) with "output.pdf" as file path format for the output file. The output file will be placed into current working directory of the application. +This constructor creates a new PdfViewOptions object with "output.pdf" as the file path format for the output file. The output file will be placed into the current working directory of the application. ### PdfViewOptions(String outputFilePath) {#PdfViewOptions-java.lang.String-} ``` @@ -99,12 +115,14 @@ public PdfViewOptions(String outputFilePath) ``` -Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. +Initializes a new instance of the PdfViewOptions class. + +This constructor creates a new PdfViewOptions object with the specified outputFilePath parameter representing the path for the output PDF file. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| outputFilePath | java.lang.String | The path for output PDF file. | +| outputFilePath | java.lang.String | The path for the output PDF file. | ### PdfViewOptions(Path outputFilePath) {#PdfViewOptions-java.nio.file.Path-} ``` @@ -112,12 +130,12 @@ public PdfViewOptions(Path outputFilePath) ``` -Initializes new instance of [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions) class. +Initializes a new instance of the PdfViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| outputFilePath | java.nio.file.Path | The path for output PDF file. | +| outputFilePath | java.nio.file.Path | The path for the output PDF file. | ### getJpgQuality() {#getJpgQuality--} ``` @@ -125,22 +143,26 @@ public final int getJpgQuality() ``` -The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90. +Retrieves the quality of the JPG images contained by the output PDF document. The JPG quality determines the level of compression applied to the images in the PDF document. + +***Note:** Valid values range from 1 to 100, where 1 represents the lowest quality and 100 represents the highest quality.* **Returns:** -int +int - the quality of the JPG images in the output PDF document. ### setJpgQuality(int value) {#setJpgQuality-int-} ``` public final void setJpgQuality(int value) ``` -The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90. +Sets the quality of the JPG images contained by the output PDF document. The JPG quality determines the level of compression applied to the images in the PDF document. + +***Note:** Valid values range from 1 to 100, where 1 represents the lowest quality and 100 represents the highest quality.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | int | | +| value | int | The quality of the JPG images in the output PDF document. | ### getImageMaxWidth() {#getImageMaxWidth--} ``` @@ -148,22 +170,22 @@ public int getImageMaxWidth() ``` -Max width of an output image in pixels. (When converting single image to HTML only) +Retrieves the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML. **Returns:** -int +int - the maximum width of the output image in pixels. ### setImageMaxWidth(int imageMaxWidth) {#setImageMaxWidth-int-} ``` public void setImageMaxWidth(int imageMaxWidth) ``` -Max width of an output image in pixels. (When converting single image to HTML only) +Sets the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageMaxWidth | int | | +| imageMaxWidth | int | The maximum width of the output image in pixels. | ### getImageMaxHeight() {#getImageMaxHeight--} ``` @@ -171,22 +193,22 @@ public int getImageMaxHeight() ``` -Max height of an output image in pixels. (When converting single image to HTML only) +Retrieves the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML. **Returns:** -int +int - the maximum height of the output image in pixels. ### setImageMaxHeight(int imageMaxHeight) {#setImageMaxHeight-int-} ``` public void setImageMaxHeight(int imageMaxHeight) ``` -Max height of an output image in pixels. (When converting single image to HTML only) +Sets the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageMaxHeight | int | | +| imageMaxHeight | int | The maximum height of the output image in pixels. | ### getImageWidth() {#getImageWidth--} ``` @@ -194,22 +216,22 @@ public int getImageWidth() ``` -The width of the output image in pixels. (When converting single image to HTML only) +Retrieves the width of the output image in pixels. This parameter applies only when converting a single image to HTML. **Returns:** -int +int - the width of the output image in pixels. ### setImageWidth(int imageWidth) {#setImageWidth-int-} ``` public void setImageWidth(int imageWidth) ``` -The width of the output image in pixels. (When converting single image to HTML only) +Sets the width of the output image in pixels. This parameter applies only when converting a single image to HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageWidth | int | | +| imageWidth | int | The width of the output image in pixels. | ### getImageHeight() {#getImageHeight--} ``` @@ -217,22 +239,22 @@ public int getImageHeight() ``` -The height of an output image in pixels. (When converting single image to HTML only) +Retrieves the height of the output image in pixels. This parameter applies only when converting a single image to HTML. **Returns:** -int +int - the height of the output image in pixels. ### setImageHeight(int imageHeight) {#setImageHeight-int-} ``` public void setImageHeight(int imageHeight) ``` -The height of an output image in pixels. (When converting single image to HTML only) +Sets the height of the output image in pixels. This parameter applies only when converting a single image to HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| imageHeight | int | | +| imageHeight | int | The height of the output image in pixels. | ### getSecurity() {#getSecurity--} ``` @@ -240,22 +262,22 @@ public final Security getSecurity() ``` -The output PDF document security options. +Retrieves the security options for the output PDF document. **Returns:** -[Security](../../com.groupdocs.viewer.options/security) +[Security](../../com.groupdocs.viewer.options/security) - the security options for the output PDF document. ### setSecurity(Security value) {#setSecurity-com.groupdocs.viewer.options.Security-} ``` public final void setSecurity(Security value) ``` -The output PDF document security options. +Sets the security options for the output PDF document. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [Security](../../com.groupdocs.viewer.options/security) | | +| value | [Security](../../com.groupdocs.viewer.options/security) | The security options for the output PDF document. | ### getDocumentSavingCallback() {#getDocumentSavingCallback--} ``` @@ -263,20 +285,20 @@ public IDocumentSavingCallback getDocumentSavingCallback() ``` -Callback to estimate Words or Email document saving progress +Retrieves the callback used to estimate the progress of saving a Words or Email document. **Returns:** -com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - Callback to estimate document saving progress +com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress. ### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) {#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-} ``` public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) ``` -Callback to estimate Words or Email document saving progress +Sets the callback used to estimate the progress of saving a Words or Email document. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | Callback to estimate document saving progress | +| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. | diff --git a/english/java/com.groupdocs.viewer.options/permissions/_index.md b/english/java/com.groupdocs.viewer.options/permissions/_index.md index eeb2f3266..37e77eaa8 100644 --- a/english/java/com.groupdocs.viewer.options/permissions/_index.md +++ b/english/java/com.groupdocs.viewer.options/permissions/_index.md @@ -13,6 +13,25 @@ public class Permissions ``` Defines PDF document permissions. + +The Permissions class provides constants that represent different permissions that can be applied to a PDF document in the GroupDocs.Viewer component. These permissions control the actions that can be performed on the PDF document, such as printing, copying text, modifying annotations, and more. + +Example usage: + +``` + + int permissions = Permissions.DENY_PRINTING | Permissions.DENY_MODIFICATION; + final Security security = new Security(); + security.setPermissions(permissions); + final PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setSecurity(security); + + try (Viewer viewer = new Viewer("document.pdf")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | @@ -22,11 +41,11 @@ Defines PDF document permissions. | Field | Description | | --- | --- | -| [ALLOW_ALL](#ALLOW-ALL) | Allow printing, modification and data extraction. | -| [DENY_PRINTING](#DENY-PRINTING) | Deny printing | -| [DENY_MODIFICATION](#DENY-MODIFICATION) | Deny to modify content, fill in forms, add or modify annotations. | +| [ALLOW_ALL](#ALLOW-ALL) | Allow printing, modification, and data extraction. | +| [DENY_PRINTING](#DENY-PRINTING) | Deny printing. | +| [DENY_MODIFICATION](#DENY-MODIFICATION) | Deny modification of content, filling in forms, and adding or modifying annotations. | | [DENY_DATA_EXTRACTION](#DENY-DATA-EXTRACTION) | Deny text and graphics extraction. | -| [DENY_ALL](#DENY-ALL) | Deny printing, modification and data extraction. | +| [DENY_ALL](#DENY-ALL) | Deny printing, modification, and data extraction. | ### Permissions() {#Permissions--} ``` public Permissions() @@ -39,7 +58,7 @@ public static final int ALLOW_ALL ``` -Allow printing, modification and data extraction. +Allow printing, modification, and data extraction. ### DENY_PRINTING {#DENY-PRINTING} ``` @@ -47,7 +66,7 @@ public static final int DENY_PRINTING ``` -Deny printing +Deny printing. ### DENY_MODIFICATION {#DENY-MODIFICATION} ``` @@ -55,7 +74,7 @@ public static final int DENY_MODIFICATION ``` -Deny to modify content, fill in forms, add or modify annotations. +Deny modification of content, filling in forms, and adding or modifying annotations. ### DENY_DATA_EXTRACTION {#DENY-DATA-EXTRACTION} ``` @@ -71,5 +90,5 @@ public static final int DENY_ALL ``` -Deny printing, modification and data extraction. +Deny printing, modification, and data extraction. diff --git a/english/java/com.groupdocs.viewer.options/pngviewoptions/_index.md b/english/java/com.groupdocs.viewer.options/pngviewoptions/_index.md index 8965206ca..f42b22ef0 100644 --- a/english/java/com.groupdocs.viewer.options/pngviewoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/pngviewoptions/_index.md @@ -16,44 +16,65 @@ public class PngViewOptions extends ViewOptions implements IMaxSizeOptions ``` Provides options for rendering documents into PNG format. + +The PngViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into PNG format in the GroupDocs.Viewer component. + +Example usage: + +``` + + PngViewOptions options = new PngViewOptions(); + options.setHeight(1080); + options.setWidth(1920); + options.setRenderComments(true); + options.setRenderComments(true); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(options); + // Use the viewer object for further operations + } + +``` + +***Note:** The PngViewOptions class implements the IMaxSizeOptions interface to specify the maximum size of the output PNG images.* ## Constructors | Constructor | Description | | --- | --- | -| [PngViewOptions(CreatePageStream createPageStream)](#PngViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-) | Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. | -| [PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)](#PngViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-) | Initializes new instance of PngViewOptions class. | -| [PngViewOptions(PageStreamFactory pageStreamFactory)](#PngViewOptions-com.groupdocs.viewer.interfaces.PageStreamFactory-) | Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. | -| [PngViewOptions()](#PngViewOptions--) | Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. | -| [PngViewOptions(String filePathFormat)](#PngViewOptions-java.lang.String-) | Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. | -| [PngViewOptions(Path filePathFormat)](#PngViewOptions-java.nio.file.Path-) | Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. | +| [PngViewOptions(CreatePageStream createPageStream)](#PngViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-) | Initializes a new instance of the PngViewOptions class. | +| [PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)](#PngViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-) | Initializes a new instance of the PngViewOptions class. | +| [PngViewOptions(PageStreamFactory pageStreamFactory)](#PngViewOptions-com.groupdocs.viewer.interfaces.PageStreamFactory-) | Initializes a new instance of the PngViewOptions class. | +| [PngViewOptions()](#PngViewOptions--) | Initializes new instance of PngViewOptions class. | +| [PngViewOptions(String filePathFormat)](#PngViewOptions-java.lang.String-) | Initializes a new instance of the PngViewOptions class. | +| [PngViewOptions(Path filePathFormat)](#PngViewOptions-java.nio.file.Path-) | Initializes a new instance of the PngViewOptions class. | ## Methods | Method | Description | | --- | --- | -| [getMaxWidth()](#getMaxWidth--) | Max width of an output image in pixels. | -| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Max width of an output image in pixels. | -| [getMaxHeight()](#getMaxHeight--) | Max height of an output image in pixels. | -| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Max height of an output image in pixels. | -| [isExtractText()](#isExtractText--) | Enables text extraction. | -| [setExtractText(boolean value)](#setExtractText-boolean-) | Enables text extraction. | -| [getWidth()](#getWidth--) | The width of the output image in pixels. | -| [setWidth(int value)](#setWidth-int-) | The width of the output image in pixels. | -| [getHeight()](#getHeight--) | The height of an output image in pixels. | -| [setHeight(int value)](#setHeight-int-) | The height of an output image in pixels. | -| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Callback to estimate Words or Email document saving progress | -| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Callback to estimate Words or Email document saving progress | +| [getMaxWidth()](#getMaxWidth--) | Returns the maximum width of an output image in pixels. | +| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Sets the maximum width of an output image in pixels. | +| [getMaxHeight()](#getMaxHeight--) | Returns the maximum height of an output image in pixels. | +| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Sets the maximum height of an output image in pixels. | +| [isExtractText()](#isExtractText--) | Determines whether text extraction is enabled. | +| [setExtractText(boolean value)](#setExtractText-boolean-) | Enables or disables text extraction. | +| [getWidth()](#getWidth--) | Returns the width of the output image in pixels. | +| [setWidth(int value)](#setWidth-int-) | Sets the width of the output image in pixels. | +| [getHeight()](#getHeight--) | Returns the height of the output image in pixels. | +| [setHeight(int value)](#setHeight-int-) | Sets the height of the output image in pixels. | +| [getDocumentSavingCallback()](#getDocumentSavingCallback--) | Retrieves the callback for estimating the saving progress of a document. | +| [setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)](#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-) | Sets the callback for estimating the saving progress of a document. | ### PngViewOptions(CreatePageStream createPageStream) {#PngViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-} ``` public PngViewOptions(CreatePageStream createPageStream) ``` -Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. +Initializes a new instance of the PngViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates the stream used to write the output page data. | ### PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) {#PngViewOptions-com.groupdocs.viewer.interfaces.CreatePageStream-com.groupdocs.viewer.interfaces.ReleasePageStream-} ``` @@ -61,13 +82,13 @@ public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream relea ``` -Initializes new instance of PngViewOptions class. +Initializes a new instance of the PngViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates stream used to write output page data. | -| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases stream created by method assigned to delegate that passed to createPageStream parameter. | +| createPageStream | [CreatePageStream](../../com.groupdocs.viewer.interfaces/createpagestream) | The method that instantiates the stream used to write the output page data. | +| releasePageStream | [ReleasePageStream](../../com.groupdocs.viewer.interfaces/releasepagestream) | The method that releases the stream created by the method assigned to the createPageStream parameter. | ### PngViewOptions(PageStreamFactory pageStreamFactory) {#PngViewOptions-com.groupdocs.viewer.interfaces.PageStreamFactory-} ``` @@ -75,12 +96,12 @@ public PngViewOptions(PageStreamFactory pageStreamFactory) ``` -Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. +Initializes a new instance of the PngViewOptions class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory which implements methods for creating and releasing output page stream. | +| pageStreamFactory | [PageStreamFactory](../../com.groupdocs.viewer.interfaces/pagestreamfactory) | The factory that implements methods for creating and releasing the output page stream. | ### PngViewOptions() {#PngViewOptions--} ``` @@ -88,11 +109,9 @@ public PngViewOptions() ``` -Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. - --------------------- +Initializes new instance of PngViewOptions class. -This constructor initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) with "p\_\{0\}.png" as file path format for the output files. The output files will be placed into current working directory of the application. +This constructor initializes new instance of PngViewOptions with "p\_\{0\}.png" as file path format for the output files. The output files will be placed into current working directory of the application. ### PngViewOptions(String filePathFormat) {#PngViewOptions-java.lang.String-} ``` @@ -100,12 +119,16 @@ public PngViewOptions(String filePathFormat) ``` -Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. +Initializes a new instance of the PngViewOptions class. + +For example, if the file path format is 'page\_\{0\}.png', the output files will be named as 'page\_1.png', 'page\_2.png', and so on, based on the page number. + +***Note:** It is important to note that the output files will be placed into the current working directory of the application.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| filePathFormat | java.lang.String | The file path format e.g. 'page\_\{0\}.png'. | +| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.png'. | ### PngViewOptions(Path filePathFormat) {#PngViewOptions-java.nio.file.Path-} ``` @@ -113,12 +136,14 @@ public PngViewOptions(Path filePathFormat) ``` -Initializes new instance of [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) class. +Initializes a new instance of the PngViewOptions class. + +For example, if the file path format is 'page\_\{0\}.png', the output files will be named as 'page\_1.png', 'page\_2.png', and so on, based on the page number. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| filePathFormat | java.nio.file.Path | The file path format e.g. 'page\_\{0\}.png'. | +| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.png'. | ### getMaxWidth() {#getMaxWidth--} ``` @@ -126,22 +151,22 @@ public int getMaxWidth() ``` -Max width of an output image in pixels. +Returns the maximum width of an output image in pixels. **Returns:** -int +int - the maximum width of the output image. ### setMaxWidth(int maxWidth) {#setMaxWidth-int-} ``` public void setMaxWidth(int maxWidth) ``` -Max width of an output image in pixels. +Sets the maximum width of an output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxWidth | int | | +| maxWidth | int | The maximum width of the output image. | ### getMaxHeight() {#getMaxHeight--} ``` @@ -149,22 +174,22 @@ public int getMaxHeight() ``` -Max height of an output image in pixels. +Returns the maximum height of an output image in pixels. **Returns:** -int +int - the maximum height of the output image. ### setMaxHeight(int maxHeight) {#setMaxHeight-int-} ``` public void setMaxHeight(int maxHeight) ``` -Max height of an output image in pixels. +Sets the maximum height of an output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxHeight | int | | +| maxHeight | int | The maximum height of the output image. | ### isExtractText() {#isExtractText--} ``` @@ -172,30 +197,26 @@ public final boolean isExtractText() ``` -Enables text extraction. - --------------------- +Determines whether text extraction is enabled. -This option might be useful when you want to add selectable text layer over the image. +This option might be useful when you want to add a selectable text layer over the image. **Returns:** -boolean +boolean - true if text extraction is enabled, false otherwise. ### setExtractText(boolean value) {#setExtractText-boolean-} ``` public final void setExtractText(boolean value) ``` -Enables text extraction. - --------------------- +Enables or disables text extraction. -This option might be useful when you want to add selectable text layer over the image. +This option might be useful when you want to add a selectable text layer over the image. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable text extraction, false to disable it. | ### getWidth() {#getWidth--} ``` @@ -203,22 +224,22 @@ public final int getWidth() ``` -The width of the output image in pixels. +Returns the width of the output image in pixels. **Returns:** -int +int - the width of the output image. ### setWidth(int value) {#setWidth-int-} ``` public final void setWidth(int value) ``` -The width of the output image in pixels. +Sets the width of the output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | int | | +| value | int | The width of the output image. | ### getHeight() {#getHeight--} ``` @@ -226,22 +247,22 @@ public final int getHeight() ``` -The height of an output image in pixels. +Returns the height of the output image in pixels. **Returns:** -int +int - the height of the output image. ### setHeight(int value) {#setHeight-int-} ``` public final void setHeight(int value) ``` -The height of an output image in pixels. +Sets the height of the output image in pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | int | | +| value | int | The height of the output image. | ### getDocumentSavingCallback() {#getDocumentSavingCallback--} ``` @@ -249,20 +270,20 @@ public IDocumentSavingCallback getDocumentSavingCallback() ``` -Callback to estimate Words or Email document saving progress +Retrieves the callback for estimating the saving progress of a document. **Returns:** -com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - Callback to estimate document saving progress +com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress. ### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) {#setDocumentSavingCallback-com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback-} ``` public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) ``` -Callback to estimate Words or Email document saving progress +Sets the callback for estimating the saving progress of a document. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | Callback to estimate document saving progress | +| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. | diff --git a/english/java/com.groupdocs.viewer.options/position/_index.md b/english/java/com.groupdocs.viewer.options/position/_index.md index 46872ac20..9669d436a 100644 --- a/english/java/com.groupdocs.viewer.options/position/_index.md +++ b/english/java/com.groupdocs.viewer.options/position/_index.md @@ -13,6 +13,27 @@ public enum Position extends Enum ``` Defines watermark position. + +The Position enum represents different positions for a watermark in the GroupDocs.Viewer component. It provides a set of predefined positions that can be used to specify the placement of a watermark on a document or image during the rendering process. + +Example usage: + +``` + + Watermark watermark = new Watermark("Watermark"); + watermark.setPosition(Position.DIAGONAL); + watermark.setColor(java.awt.Color.GREEN); + watermark.setSize(Size.HALF_SIZE); + + PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setWatermark(watermark); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | @@ -36,7 +57,7 @@ public static final Position DIAGONAL ``` -The diagonal position. +The diagonal position. This position represents a diagonal alignment or placement. ### TOP_LEFT {#TOP-LEFT} ``` @@ -44,7 +65,7 @@ public static final Position TOP_LEFT ``` -The top left position. +The top left position. This position represents the top left corner alignment or placement. ### TOP_CENTER {#TOP-CENTER} ``` @@ -52,7 +73,7 @@ public static final Position TOP_CENTER ``` -The top center position. +The top center position. This position represents the top center alignment or placement. ### TOP_RIGHT {#TOP-RIGHT} ``` @@ -60,7 +81,7 @@ public static final Position TOP_RIGHT ``` -The top right position. +The top right position. This position represents the top right corner alignment or placement. ### BOTTOM_LEFT {#BOTTOM-LEFT} ``` @@ -68,7 +89,7 @@ public static final Position BOTTOM_LEFT ``` -The bottom left position. +The bottom left position. This position represents the bottom left corner alignment or placement. ### BOTTOM_CENTER {#BOTTOM-CENTER} ``` @@ -76,7 +97,7 @@ public static final Position BOTTOM_CENTER ``` -The bottom center position. +The bottom center position. This position represents the bottom center alignment or placement. ### BOTTOM_RIGHT {#BOTTOM-RIGHT} ``` @@ -84,7 +105,7 @@ public static final Position BOTTOM_RIGHT ``` -The bottom right position. +The bottom right position. This position represents the bottom right corner alignment or placement. ### values() {#values--} ``` diff --git a/english/java/com.groupdocs.viewer.options/projectmanagementoptions/_index.md b/english/java/com.groupdocs.viewer.options/projectmanagementoptions/_index.md index e9bd73da4..db73e59cc 100644 --- a/english/java/com.groupdocs.viewer.options/projectmanagementoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/projectmanagementoptions/_index.md @@ -13,30 +13,48 @@ public class ProjectManagementOptions ``` Provides options for rendering project management files. + +The ProjectManagementOptions class encapsulates various settings and parameters that can be used to control the rendering of project management files (such as Microsoft Project or similar) in the GroupDocs.Viewer component. + +Example usage: + +``` + + PngViewOptions pngViewOptions = new PngViewOptions(); + ProjectManagementOptions projectManagementOptions = pngViewOptions.getProjectManagementOptions(); + projectManagementOptions.setPageSize(PageSize.A4); + projectManagementOptions.setStartDate(new Date(2021, 11, 23)); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pngViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [ProjectManagementOptions()](#ProjectManagementOptions--) | Creates new instance of [ProjectManagementOptions](../../com.groupdocs.viewer.options/projectmanagementoptions) class. | +| [ProjectManagementOptions()](#ProjectManagementOptions--) | Initializes a new instance of the ProjectManagementOptions class. | ## Methods | Method | Description | | --- | --- | -| [getPageSize()](#getPageSize--) | The output page size. | -| [setPageSize(PageSize value)](#setPageSize-com.groupdocs.viewer.options.PageSize-) | The output page size. | -| [getTimeUnit()](#getTimeUnit--) | The time unit. | -| [setTimeUnit(TimeUnit value)](#setTimeUnit-com.groupdocs.viewer.options.TimeUnit-) | The time unit. | -| [getStartDate()](#getStartDate--) | The start date of the Gantt Chart View to be included into the output. | -| [setStartDate(Date value)](#setStartDate-java.util.Date-) | The start date of the Gantt Chart View to be included into the output. | -| [getEndDate()](#getEndDate--) | The end date of the Gantt Chart View to be included into the output. | -| [setEndDate(Date value)](#setEndDate-java.util.Date-) | The end date of the Gantt Chart View to be included into the output. | +| [getPageSize()](#getPageSize--) | Retrieves the output page size. | +| [setPageSize(PageSize value)](#setPageSize-com.groupdocs.viewer.options.PageSize-) | Sets the output page size. | +| [getTimeUnit()](#getTimeUnit--) | Retrieves the time unit. | +| [setTimeUnit(TimeUnit value)](#setTimeUnit-com.groupdocs.viewer.options.TimeUnit-) | Retrieves the time unit. | +| [getStartDate()](#getStartDate--) | Retrieves the start date of the Gantt Chart View to be included in the output. | +| [setStartDate(Date value)](#setStartDate-java.util.Date-) | Sets the start date of the Gantt Chart View to be included in the output. | +| [getEndDate()](#getEndDate--) | Retrieves the end date of the Gantt Chart View to be included in the output. | +| [setEndDate(Date value)](#setEndDate-java.util.Date-) | Sets the end date of the Gantt Chart View to be included in the output. | ### ProjectManagementOptions() {#ProjectManagementOptions--} ``` public ProjectManagementOptions() ``` -Creates new instance of [ProjectManagementOptions](../../com.groupdocs.viewer.options/projectmanagementoptions) class. +Initializes a new instance of the ProjectManagementOptions class. ### getPageSize() {#getPageSize--} ``` @@ -44,17 +62,17 @@ public final PageSize getPageSize() ``` -The output page size. +Retrieves the output page size. **Returns:** -[PageSize](../../com.groupdocs.viewer.options/pagesize) - The output page size. +[PageSize](../../com.groupdocs.viewer.options/pagesize) - the output page size. ### setPageSize(PageSize value) {#setPageSize-com.groupdocs.viewer.options.PageSize-} ``` public final void setPageSize(PageSize value) ``` -The output page size. +Sets the output page size. **Parameters:** | Parameter | Type | Description | @@ -67,17 +85,17 @@ public final TimeUnit getTimeUnit() ``` -The time unit. +Retrieves the time unit. **Returns:** -[TimeUnit](../../com.groupdocs.viewer.options/timeunit) - The time unit. +[TimeUnit](../../com.groupdocs.viewer.options/timeunit) - the time unit. ### setTimeUnit(TimeUnit value) {#setTimeUnit-com.groupdocs.viewer.options.TimeUnit-} ``` public final void setTimeUnit(TimeUnit value) ``` -The time unit. +Retrieves the time unit. **Parameters:** | Parameter | Type | Description | @@ -90,30 +108,26 @@ public final Date getStartDate() ``` -The start date of the Gantt Chart View to be included into the output. - -Note: +Retrieves the start date of the Gantt Chart View to be included in the output. -Use this option when you need to render part of the project within specified time interval of the Gantt Chart View. +***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* **Returns:** -java.util.Date +java.util.Date - the start date of the Gantt Chart View. ### setStartDate(Date value) {#setStartDate-java.util.Date-} ``` public final void setStartDate(Date value) ``` -The start date of the Gantt Chart View to be included into the output. - -Note: +Sets the start date of the Gantt Chart View to be included in the output. -Use this option when you need to render part of the project within specified time interval of the Gantt Chart View. +***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.util.Date | | +| value | java.util.Date | The start date of the Gantt Chart View. | ### getEndDate() {#getEndDate--} ``` @@ -121,28 +135,24 @@ public final Date getEndDate() ``` -The end date of the Gantt Chart View to be included into the output. +Retrieves the end date of the Gantt Chart View to be included in the output. -Note: - -Use this option when you need to render part of the project within specified time interval of the Gantt Chart View. +***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* **Returns:** -java.util.Date +java.util.Date - the end date of the Gantt Chart View. ### setEndDate(Date value) {#setEndDate-java.util.Date-} ``` public final void setEndDate(Date value) ``` -The end date of the Gantt Chart View to be included into the output. - -Note: +Sets the end date of the Gantt Chart View to be included in the output. -Use this option when you need to render part of the project within specified time interval of the Gantt Chart View. +***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.util.Date | | +| value | java.util.Date | The end date of the Gantt Chart View. | diff --git a/english/java/com.groupdocs.viewer.options/rotation/_index.md b/english/java/com.groupdocs.viewer.options/rotation/_index.md index 8e35fea81..b61a2b5b5 100644 --- a/english/java/com.groupdocs.viewer.options/rotation/_index.md +++ b/english/java/com.groupdocs.viewer.options/rotation/_index.md @@ -13,6 +13,24 @@ public enum Rotation extends Enum ``` Defines page rotation in degrees. + +The Rotation enum represents different rotation angles for a page in the GroupDocs.Viewer component. It provides a set of predefined rotation options that can be used to specify the rotation angle for rendering a page in various document viewing or conversion scenarios. + +Example usage: + +``` + + PdfViewOptions pdfViewOptions = new PdfViewOptions(); + + pdfViewOptions.rotatePage(1, Rotation.ON_90_DEGREE); + pdfViewOptions.rotatePage(2, Rotation.ON_180_DEGREE); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | @@ -32,7 +50,7 @@ public static final Rotation ON_90_DEGREE ``` -The 90 degree page rotation. +The 90 degree page rotation. This rotation represents a 90-degree clockwise rotation of the page. ### ON_180_DEGREE {#ON-180-DEGREE} ``` @@ -40,7 +58,7 @@ public static final Rotation ON_180_DEGREE ``` -The 180 degree page rotation. +The 180 degree page rotation. This rotation represents a 180-degree clockwise rotation of the page. ### ON_270_DEGREE {#ON-270-DEGREE} ``` @@ -48,7 +66,7 @@ public static final Rotation ON_270_DEGREE ``` -The 270 degree page rotation. +The 270 degree page rotation. This rotation represents a 270-degree clockwise rotation of the page. ### values() {#values--} ``` diff --git a/english/java/com.groupdocs.viewer.options/security/_index.md b/english/java/com.groupdocs.viewer.options/security/_index.md index 87cd23b42..039da6763 100644 --- a/english/java/com.groupdocs.viewer.options/security/_index.md +++ b/english/java/com.groupdocs.viewer.options/security/_index.md @@ -13,28 +13,48 @@ public class Security ``` Provides PDF document security options. + +The Security class encapsulates various settings and options that can be used to apply security measures to a PDF document in the GroupDocs.Viewer component. These options include password protection, permissions, and more. + +Example usage: + +``` + + Security security = new Security(); + security.setDocumentOpenPassword("myPassword"); + security.setPermissions(Permissions.DENY_MODIFICATION); + + final PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setSecurity(security); + + try (Viewer viewer = new Viewer("document.pdf")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [Security()](#Security--) | Initializes new instance of [Security](../../com.groupdocs.viewer.options/security) class. | +| [Security()](#Security--) | Initializes a new instance of the Security class. | ## Methods | Method | Description | | --- | --- | -| [getDocumentOpenPassword()](#getDocumentOpenPassword--) | The password required to open the PDF document. | -| [setDocumentOpenPassword(String value)](#setDocumentOpenPassword-java.lang.String-) | The password required to open the PDF document. | -| [getPermissionsPassword()](#getPermissionsPassword--) | The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction. | -| [setPermissionsPassword(String value)](#setPermissionsPassword-java.lang.String-) | The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction. | -| [getPermissions()](#getPermissions--) | The PDF document permissions such as printing, modification and data extraction. | -| [setPermissions(int value)](#setPermissions-int-) | The PDF document permissions such as printing, modification and data extraction. | +| [getDocumentOpenPassword()](#getDocumentOpenPassword--) | Gets the password required to open the PDF document. | +| [setDocumentOpenPassword(String value)](#setDocumentOpenPassword-java.lang.String-) | Sets the password required to open the PDF document. | +| [getPermissionsPassword()](#getPermissionsPassword--) | Gets the password required to change permission settings. | +| [setPermissionsPassword(String value)](#setPermissionsPassword-java.lang.String-) | Sets the password required to change permission settings. | +| [getPermissions()](#getPermissions--) | Gets the PDF document permissions such as printing, modification, and data extraction. | +| [setPermissions(int value)](#setPermissions-int-) | Sets the PDF document permissions such as printing, modification, and data extraction. | ### Security() {#Security--} ``` public Security() ``` -Initializes new instance of [Security](../../com.groupdocs.viewer.options/security) class. +Initializes a new instance of the Security class. ### getDocumentOpenPassword() {#getDocumentOpenPassword--} ``` @@ -42,22 +62,22 @@ public final String getDocumentOpenPassword() ``` -The password required to open the PDF document. +Gets the password required to open the PDF document. **Returns:** -java.lang.String +java.lang.String - the document open password. ### setDocumentOpenPassword(String value) {#setDocumentOpenPassword-java.lang.String-} ``` public final void setDocumentOpenPassword(String value) ``` -The password required to open the PDF document. +Sets the password required to open the PDF document. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The document open password. | ### getPermissionsPassword() {#getPermissionsPassword--} ``` @@ -65,22 +85,26 @@ public final String getPermissionsPassword() ``` -The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction. +Gets the password required to change permission settings. + +Using a permissions password, you can restrict printing, modification, and data extraction. **Returns:** -java.lang.String +java.lang.String - the permissions password. ### setPermissionsPassword(String value) {#setPermissionsPassword-java.lang.String-} ``` public final void setPermissionsPassword(String value) ``` -The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction. +Sets the password required to change permission settings. + +Using a permissions password, you can restrict printing, modification, and data extraction. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The permissions password. | ### getPermissions() {#getPermissions--} ``` @@ -88,20 +112,20 @@ public final int getPermissions() ``` -The PDF document permissions such as printing, modification and data extraction. +Gets the PDF document permissions such as printing, modification, and data extraction. **Returns:** -int - The PDF document permissions such as printing, modification and data extraction. +int - the PDF document permissions. ### setPermissions(int value) {#setPermissions-int-} ``` public final void setPermissions(int value) ``` -The PDF document permissions such as printing, modification and data extraction. +Sets the PDF document permissions such as printing, modification, and data extraction. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | int | The PDF document permissions such as printing, modification and data extraction. | +| value | int | The PDF document permissions. | diff --git a/english/java/com.groupdocs.viewer.options/size/_index.md b/english/java/com.groupdocs.viewer.options/size/_index.md index f941dd9ac..efd87ada9 100644 --- a/english/java/com.groupdocs.viewer.options/size/_index.md +++ b/english/java/com.groupdocs.viewer.options/size/_index.md @@ -13,35 +13,56 @@ public class Size ``` Watermark size. + +The Size class represents the size of a watermark in the GroupDocs.Viewer component. It provides options to specify the dimensions of the watermark, such as width and height. + +Example usage: + +``` + + Watermark watermark = new Watermark("Watermark"); + watermark.setPosition(Position.DIAGONAL); + watermark.setColor(java.awt.Color.GREEN); + watermark.setSize(Size.HALF_SIZE); + + PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setWatermark(watermark); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [Size(byte relativeSize)](#Size-byte-) | Initializes new instance of [Size](../../com.groupdocs.viewer.options/size) class. | +| [Size(byte relativeSize)](#Size-byte-) | Initializes a new instance of the Size class. | ## Fields | Field | Description | | --- | --- | -| [FULL_SIZE](#FULL-SIZE) | The maximum size of watermark text that fits page. | -| [HALF_SIZE](#HALF-SIZE) | The half of the maximum size of watermark text that fits page. | -| [ONE_THIRD](#ONE-THIRD) | The one third of the maximum size of watermark text that fits page. | +| [FULL_SIZE](#FULL-SIZE) | Represents the maximum size of watermark text that fits the page. | +| [HALF_SIZE](#HALF-SIZE) | Represents half of the maximum size of watermark text that fits the page. | +| [ONE_THIRD](#ONE-THIRD) | Represents one third of the maximum size of watermark text that fits the page. | ## Methods | Method | Description | | --- | --- | -| [getRelativeSize()](#getRelativeSize--) | The watermark text size in percentages in relation to page width. | +| [getRelativeSize()](#getRelativeSize--) | Returns the watermark text size in percentages in relation to the page width. | ### Size(byte relativeSize) {#Size-byte-} ``` public Size(byte relativeSize) ``` -Initializes new instance of [Size](../../com.groupdocs.viewer.options/size) class. +Initializes a new instance of the Size class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| relativeSize | byte | The size in percents in relation to page size. | +| relativeSize | byte | The size in percentages in relation to the page size. | ### FULL_SIZE {#FULL-SIZE} ``` @@ -49,7 +70,7 @@ public static final Size FULL_SIZE ``` -The maximum size of watermark text that fits page. +Represents the maximum size of watermark text that fits the page. ### HALF_SIZE {#HALF-SIZE} ``` @@ -57,7 +78,7 @@ public static final Size HALF_SIZE ``` -The half of the maximum size of watermark text that fits page. +Represents half of the maximum size of watermark text that fits the page. ### ONE_THIRD {#ONE-THIRD} ``` @@ -65,7 +86,7 @@ public static final Size ONE_THIRD ``` -The one third of the maximum size of watermark text that fits page. +Represents one third of the maximum size of watermark text that fits the page. ### getRelativeSize() {#getRelativeSize--} ``` @@ -73,7 +94,7 @@ public final byte getRelativeSize() ``` -The watermark text size in percentages in relation to page width. Valid values are between 1 and 100. +Returns the watermark text size in percentages in relation to the page width. **Returns:** -byte +byte - the watermark text size in percentages. diff --git a/english/java/com.groupdocs.viewer.options/spreadsheetoptions/_index.md b/english/java/com.groupdocs.viewer.options/spreadsheetoptions/_index.md index 3d9831c21..727b1b4b3 100644 --- a/english/java/com.groupdocs.viewer.options/spreadsheetoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/spreadsheetoptions/_index.md @@ -13,60 +13,82 @@ public class SpreadsheetOptions ``` Provides options for rendering spreadsheets. + +The SpreadsheetOptions class encapsulates various settings and parameters that can be used to control the rendering of spreadsheet files (such as Excel or CSV files) in the GroupDocs.Viewer component. + +Example usage: + +``` + + PngViewOptions pngViewOptions = new PngViewOptions(); + SpreadsheetOptions spreadsheetOptions = pngViewOptions.getSpreadsheetOptions(); + spreadsheetOptions.setRenderHeadings(true); + spreadsheetOptions.setCountColumnsPerPage(24); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pngViewOptions); + // Use the viewer object for further operations + } + +``` ## Methods | Method | Description | | --- | --- | -| [isRenderByPageBreaks()](#isRenderByPageBreaks--) | When this option is enabled a worksheet will be rendered by page breaks. | -| [setRenderByPageBreaks(boolean renderByPageBreaks)](#setRenderByPageBreaks-boolean-) | When this option is enabled a worksheet will be rendered by page breaks. | -| [isDetectSeparator()](#isDetectSeparator--) | Detect separator (for CSV/TSV files). | -| [setDetectSeparator(boolean detectSeparator)](#setDetectSeparator-boolean-) | Detect separator (for CSV/TSV files). | -| [forOnePagePerSheet()](#forOnePagePerSheet--) | Initializes new instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) class for rendering whole sheet into page. | -| [forSplitSheetIntoPages(int countRowsPerPage)](#forSplitSheetIntoPages-int-) | Initializes new instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) for rendering sheet into pages. | -| [forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage)](#forSplitSheetIntoPages-int-int-) | Initializes new instance of for rendering sheet into pages. | -| [forRenderingPrintArea()](#forRenderingPrintArea--) | Initializes new instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) for rendering print areas only. | -| [isOnePagePerSheet()](#isOnePagePerSheet--) | Indicates that one sheet is rendered into one page. | -| [getCountRowsPerPage()](#getCountRowsPerPage--) | The rows count to include into each page when splitting worksheet into pages. | -| [getCountColumnsPerPage()](#getCountColumnsPerPage--) | The columns count to include into each page when splitting worksheet into pages. | -| [setCountColumnsPerPage(int countColumnsPerPage)](#setCountColumnsPerPage-int-) | The columns count to include into each page when splitting worksheet into pages. | -| [isRenderPrintAreaOnly()](#isRenderPrintAreaOnly--) | Indicates that only print areas are rendered. | -| [isRenderGridLines()](#isRenderGridLines--) | Enables grid lines rendering. | -| [setRenderGridLines(boolean value)](#setRenderGridLines-boolean-) | Enables grid lines rendering. | -| [isSkipEmptyRows()](#isSkipEmptyRows--) | Disables empty rows rendering. | -| [setSkipEmptyRows(boolean value)](#setSkipEmptyRows-boolean-) | Disables empty rows rendering. | -| [isSkipEmptyColumns()](#isSkipEmptyColumns--) | Disables empty columns rendering. | -| [setSkipEmptyColumns(boolean value)](#setSkipEmptyColumns-boolean-) | Disables empty columns rendering. | -| [isRenderHiddenRows()](#isRenderHiddenRows--) | Enables hidden rows rendering. | -| [setRenderHiddenRows(boolean value)](#setRenderHiddenRows-boolean-) | Enables hidden rows rendering. | -| [isRenderHeadings()](#isRenderHeadings--) | Is headings rendering enabled. | -| [setRenderHeadings(boolean mRenderHeadings)](#setRenderHeadings-boolean-) | Enables headings rendering. | +| [isRenderByPageBreaks()](#isRenderByPageBreaks--) | Determines whether the worksheet should be rendered by page breaks. | +| [setRenderByPageBreaks(boolean renderByPageBreaks)](#setRenderByPageBreaks-boolean-) | Sets whether the worksheet should be rendered by page breaks. | +| [isDetectSeparator()](#isDetectSeparator--) | Detects the separator for CSV/TSV files. | +| [setDetectSeparator(boolean detectSeparator)](#setDetectSeparator-boolean-) | Sets whether to detect the separator for CSV/TSV files. | +| [forOnePagePerSheet()](#forOnePagePerSheet--) | Creates a new instance of SpreadsheetOptions class for rendering one sheet into one page. | +| [forSplitSheetIntoPages(int countRowsPerPage)](#forSplitSheetIntoPages-int-) | Creates a new instance of SpreadsheetOptions class for rendering a sheet into multiple pages. | +| [forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage)](#forSplitSheetIntoPages-int-int-) | Initializes a new instance of the SpreadsheetOptions class for rendering a sheet into pages. | +| [forRenderingPrintArea()](#forRenderingPrintArea--) | Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. | +| [isOnePagePerSheet()](#isOnePagePerSheet--) | Indicates whether one sheet is rendered into one page. | +| [getCountRowsPerPage()](#getCountRowsPerPage--) | Gets the count of rows to include into each page when splitting the worksheet into pages. | +| [getCountColumnsPerPage()](#getCountColumnsPerPage--) | Gets the count of columns to include into each page when splitting the worksheet into pages. | +| [setCountColumnsPerPage(int countColumnsPerPage)](#setCountColumnsPerPage-int-) | Sets the count of columns to include into each page when splitting the worksheet into pages. | +| [isRenderPrintAreaOnly()](#isRenderPrintAreaOnly--) | Indicates whether only the print areas are rendered. | +| [isRenderGridLines()](#isRenderGridLines--) | Enables rendering of grid lines. | +| [setRenderGridLines(boolean value)](#setRenderGridLines-boolean-) | Enables or disables the rendering of grid lines. | +| [isSkipEmptyRows()](#isSkipEmptyRows--) | Indicates whether empty rows should be skipped during rendering. | +| [setSkipEmptyRows(boolean value)](#setSkipEmptyRows-boolean-) | Sets whether empty rows should be skipped during rendering. | +| [isSkipEmptyColumns()](#isSkipEmptyColumns--) | Indicates whether empty columns should be skipped during rendering. | +| [setSkipEmptyColumns(boolean value)](#setSkipEmptyColumns-boolean-) | Sets whether empty columns should be skipped during rendering. | +| [isRenderHiddenRows()](#isRenderHiddenRows--) | Determines whether hidden rows should be rendered. | +| [setRenderHiddenRows(boolean value)](#setRenderHiddenRows-boolean-) | Sets whether hidden rows should be rendered. | +| [isRenderHeadings()](#isRenderHeadings--) | Checks if headings rendering is enabled. | +| [setRenderHeadings(boolean renderHeadings)](#setRenderHeadings-boolean-) | Enables headings rendering. | | [isRenderHiddenColumns()](#isRenderHiddenColumns--) | Enables hidden columns rendering. | | [setRenderHiddenColumns(boolean value)](#setRenderHiddenColumns-boolean-) | Enables hidden columns rendering. | -| [getTextOverflowMode()](#getTextOverflowMode--) | The text overflow mode for rendering spreadsheet documents into HTML. | -| [setTextOverflowMode(TextOverflowMode value)](#setTextOverflowMode-com.groupdocs.viewer.options.TextOverflowMode-) | The text overflow mode for rendering spreadsheet documents into HTML. | -| [forRenderingByPageBreaks()](#forRenderingByPageBreaks--) | Initializes new instance of for rendering print areas only. | +| [getTextOverflowMode()](#getTextOverflowMode--) | Returns the text overflow mode for rendering spreadsheet documents into HTML. | +| [setTextOverflowMode(TextOverflowMode value)](#setTextOverflowMode-com.groupdocs.viewer.options.TextOverflowMode-) | Sets the text overflow mode for rendering spreadsheet documents into HTML. | +| [forRenderingByPageBreaks()](#forRenderingByPageBreaks--) | Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. | ### isRenderByPageBreaks() {#isRenderByPageBreaks--} ``` public boolean isRenderByPageBreaks() ``` -When this option is enabled a worksheet will be rendered by page breaks. The behaviour is the same as you're printing a spreadsheet in Excel. +Determines whether the worksheet should be rendered by page breaks. + +***Note:** This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.* **Returns:** -boolean +boolean - true if the worksheet should be rendered by page breaks, false otherwise. ### setRenderByPageBreaks(boolean renderByPageBreaks) {#setRenderByPageBreaks-boolean-} ``` public void setRenderByPageBreaks(boolean renderByPageBreaks) ``` -When this option is enabled a worksheet will be rendered by page breaks. The behaviour is the same as you're printing a spreadsheet in Excel. +Sets whether the worksheet should be rendered by page breaks. + +***Note:** This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| renderByPageBreaks | boolean | | +| renderByPageBreaks | boolean | true if the worksheet should be rendered by page breaks, false otherwise. | ### isDetectSeparator() {#isDetectSeparator--} ``` @@ -74,22 +96,22 @@ public boolean isDetectSeparator() ``` -Detect separator (for CSV/TSV files). +Detects the separator for CSV/TSV files. **Returns:** -boolean +boolean - true if the separator should be automatically detected, false otherwise. ### setDetectSeparator(boolean detectSeparator) {#setDetectSeparator-boolean-} ``` public void setDetectSeparator(boolean detectSeparator) ``` -Detect separator (for CSV/TSV files). +Sets whether to detect the separator for CSV/TSV files. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| detectSeparator | boolean | | +| detectSeparator | boolean | true to automatically detect the separator, false otherwise. | ### forOnePagePerSheet() {#forOnePagePerSheet--} ``` @@ -97,93 +119,93 @@ public static SpreadsheetOptions forOnePagePerSheet() ``` -Initializes new instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) class for rendering whole sheet into page. +Creates a new instance of SpreadsheetOptions class for rendering one sheet into one page. **Returns:** -[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - New instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) class for rendering one sheet into one page. +[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - a new instance of SpreadsheetOptions class for rendering one sheet into one page. ### forSplitSheetIntoPages(int countRowsPerPage) {#forSplitSheetIntoPages-int-} ``` public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage) ``` -Initializes new instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) for rendering sheet into pages. +Creates a new instance of SpreadsheetOptions class for rendering a sheet into multiple pages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| countRowsPerPage | int | Rows count to include into each page. | +| countRowsPerPage | int | The number of rows to include in each page. | **Returns:** -[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - New instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) for rendering sheet into pages. +[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - a new instance of SpreadsheetOptions for rendering a sheet into pages. ### forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage) {#forSplitSheetIntoPages-int-int-} ``` public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage) ``` -Initializes new instance of for rendering sheet into pages. +Initializes a new instance of the SpreadsheetOptions class for rendering a sheet into pages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| countRowsPerPage | int | Rows count to include into each page. | -| countColumnsPerPage | int | Columns count to include into each page. | +| countRowsPerPage | int | The number of rows to include on each page. | +| countColumnsPerPage | int | The number of columns to include on each page. | **Returns:** -[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - New instance of for rendering sheet into pages. +[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - a new instance of the SpreadsheetOptions class for rendering a sheet into pages. ### forRenderingPrintArea() {#forRenderingPrintArea--} ``` public static SpreadsheetOptions forRenderingPrintArea() ``` -Initializes new instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) for rendering print areas only. +Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. **Returns:** -[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - New instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) for rendering print areas only. +[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - a new instance of the SpreadsheetOptions class for rendering print areas only. ### isOnePagePerSheet() {#isOnePagePerSheet--} ``` public final boolean isOnePagePerSheet() ``` -Indicates that one sheet is rendered into one page. +Indicates whether one sheet is rendered into one page. **Returns:** -boolean +boolean - true if one sheet is rendered into one page; false otherwise. ### getCountRowsPerPage() {#getCountRowsPerPage--} ``` public final int getCountRowsPerPage() ``` -The rows count to include into each page when splitting worksheet into pages. +Gets the count of rows to include into each page when splitting the worksheet into pages. **Returns:** -int +int - the count of rows to include into each page. ### getCountColumnsPerPage() {#getCountColumnsPerPage--} ``` public int getCountColumnsPerPage() ``` -The columns count to include into each page when splitting worksheet into pages. +Gets the count of columns to include into each page when splitting the worksheet into pages. **Returns:** -int +int - the count of columns to include into each page. ### setCountColumnsPerPage(int countColumnsPerPage) {#setCountColumnsPerPage-int-} ``` public void setCountColumnsPerPage(int countColumnsPerPage) ``` -The columns count to include into each page when splitting worksheet into pages. +Sets the count of columns to include into each page when splitting the worksheet into pages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| countColumnsPerPage | int | | +| countColumnsPerPage | int | The count of columns to include into each page. | ### isRenderPrintAreaOnly() {#isRenderPrintAreaOnly--} ``` @@ -191,32 +213,32 @@ public final boolean isRenderPrintAreaOnly() ``` -Indicates that only print areas are rendered. +Indicates whether only the print areas are rendered. **Returns:** -boolean +boolean - true if only the print areas are rendered, false otherwise. ### isRenderGridLines() {#isRenderGridLines--} ``` public final boolean isRenderGridLines() ``` -Enables grid lines rendering. +Enables rendering of grid lines. **Returns:** -boolean +boolean - true if grid lines are enabled, false otherwise. ### setRenderGridLines(boolean value) {#setRenderGridLines-boolean-} ``` public final void setRenderGridLines(boolean value) ``` -Enables grid lines rendering. +Enables or disables the rendering of grid lines. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable grid lines rendering, false to disable it. | ### isSkipEmptyRows() {#isSkipEmptyRows--} ``` @@ -224,22 +246,22 @@ public final boolean isSkipEmptyRows() ``` -Disables empty rows rendering. +Indicates whether empty rows should be skipped during rendering. **Returns:** -boolean +boolean - true if empty rows should be skipped, false otherwise. ### setSkipEmptyRows(boolean value) {#setSkipEmptyRows-boolean-} ``` public final void setSkipEmptyRows(boolean value) ``` -Disables empty rows rendering. +Sets whether empty rows should be skipped during rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to skip empty rows, false otherwise. | ### isSkipEmptyColumns() {#isSkipEmptyColumns--} ``` @@ -247,22 +269,22 @@ public final boolean isSkipEmptyColumns() ``` -Disables empty columns rendering. +Indicates whether empty columns should be skipped during rendering. **Returns:** -boolean +boolean - true if empty columns are skipped, false otherwise. ### setSkipEmptyColumns(boolean value) {#setSkipEmptyColumns-boolean-} ``` public final void setSkipEmptyColumns(boolean value) ``` -Disables empty columns rendering. +Sets whether empty columns should be skipped during rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to skip empty columns, false otherwise. | ### isRenderHiddenRows() {#isRenderHiddenRows--} ``` @@ -270,22 +292,22 @@ public final boolean isRenderHiddenRows() ``` -Enables hidden rows rendering. +Determines whether hidden rows should be rendered. **Returns:** -boolean +boolean - true if hidden rows should be rendered, false otherwise. ### setRenderHiddenRows(boolean value) {#setRenderHiddenRows-boolean-} ``` public final void setRenderHiddenRows(boolean value) ``` -Enables hidden rows rendering. +Sets whether hidden rows should be rendered. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable rendering of hidden rows, false to disable it. | ### isRenderHeadings() {#isRenderHeadings--} ``` @@ -293,13 +315,13 @@ public boolean isRenderHeadings() ``` -Is headings rendering enabled. +Checks if headings rendering is enabled. **Returns:** -boolean - headings rendering enabled. -### setRenderHeadings(boolean mRenderHeadings) {#setRenderHeadings-boolean-} +boolean - true if headings rendering is enabled, false otherwise. +### setRenderHeadings(boolean renderHeadings) {#setRenderHeadings-boolean-} ``` -public void setRenderHeadings(boolean mRenderHeadings) +public void setRenderHeadings(boolean renderHeadings) ``` @@ -308,7 +330,7 @@ Enables headings rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| mRenderHeadings | boolean | | +| renderHeadings | boolean | true to enable headings rendering, false to disable. | ### isRenderHiddenColumns() {#isRenderHiddenColumns--} ``` @@ -319,7 +341,7 @@ public final boolean isRenderHiddenColumns() Enables hidden columns rendering. **Returns:** -boolean +boolean - true if hidden columns rendering is enabled, false otherwise. ### setRenderHiddenColumns(boolean value) {#setRenderHiddenColumns-boolean-} ``` public final void setRenderHiddenColumns(boolean value) @@ -331,7 +353,7 @@ Enables hidden columns rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable hidden columns rendering, false to disable. | ### getTextOverflowMode() {#getTextOverflowMode--} ``` @@ -339,22 +361,22 @@ public final TextOverflowMode getTextOverflowMode() ``` -The text overflow mode for rendering spreadsheet documents into HTML. +Returns the text overflow mode for rendering spreadsheet documents into HTML. **Returns:** -[TextOverflowMode](../../com.groupdocs.viewer.options/textoverflowmode) - The text overflow mode for rendering spreadsheet documents into HTML. +[TextOverflowMode](../../com.groupdocs.viewer.options/textoverflowmode) - the text overflow mode. ### setTextOverflowMode(TextOverflowMode value) {#setTextOverflowMode-com.groupdocs.viewer.options.TextOverflowMode-} ``` public final void setTextOverflowMode(TextOverflowMode value) ``` -The text overflow mode for rendering spreadsheet documents into HTML. +Sets the text overflow mode for rendering spreadsheet documents into HTML. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [TextOverflowMode](../../com.groupdocs.viewer.options/textoverflowmode) | The text overflow mode for rendering spreadsheet documents into HTML. | +| value | [TextOverflowMode](../../com.groupdocs.viewer.options/textoverflowmode) | The text overflow mode to be set. | ### forRenderingByPageBreaks() {#forRenderingByPageBreaks--} ``` @@ -362,7 +384,7 @@ public static SpreadsheetOptions forRenderingByPageBreaks() ``` -Initializes new instance of for rendering print areas only. +Initializes a new instance of the SpreadsheetOptions class for rendering print areas only. **Returns:** -[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - New instance of [SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) for rendering by page breaks. The behaviour similar to printing in Excel. +[SpreadsheetOptions](../../com.groupdocs.viewer.options/spreadsheetoptions) - a new instance of SpreadsheetOptions for rendering print areas only. The behavior is similar to printing in Excel, where the worksheet is rendered by page breaks. diff --git a/english/java/com.groupdocs.viewer.options/textoptions/_index.md b/english/java/com.groupdocs.viewer.options/textoptions/_index.md index 1dd8abc9b..a313f5efa 100644 --- a/english/java/com.groupdocs.viewer.options/textoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/textoptions/_index.md @@ -13,47 +13,71 @@ public class TextOptions ``` Text files splitting to pages options. + +The TextOptions class provides options for splitting text files into pages in the GroupDocs.Viewer component. It allows you to control how text files are divided into individual pages for rendering and viewing purposes. + +Example usage: + +``` + + PngViewOptions pngViewOptions = new PngViewOptions(); + TextOptions options = pngViewOptions.getTextOptions(); + options.setMaxCharsPerRow(96); + options.setMaxRowsPerPage(48); + + try (Viewer viewer = new Viewer("document.txt")) { + viewer.view(pngViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [TextOptions()](#TextOptions--) | | +| [TextOptions()](#TextOptions--) | Initializes a new instance of the TextOptions class. | ## Methods | Method | Description | | --- | --- | -| [getMaxCharsPerRow()](#getMaxCharsPerRow--) | Max chars per row on page. | -| [setMaxCharsPerRow(int maxCharsPerRow)](#setMaxCharsPerRow-int-) | Max chars per row on page. | -| [getMaxRowsPerPage()](#getMaxRowsPerPage--) | Max rows per page. | -| [setMaxRowsPerPage(int maxRowsPerPage)](#setMaxRowsPerPage-int-) | Max rows per page. | +| [getMaxCharsPerRow()](#getMaxCharsPerRow--) | Gets the maximum number of characters per row on a page. | +| [setMaxCharsPerRow(int maxCharsPerRow)](#setMaxCharsPerRow-int-) | Sets the maximum number of characters per row on a page. | +| [getMaxRowsPerPage()](#getMaxRowsPerPage--) | Gets the maximum number of rows per page. | +| [setMaxRowsPerPage(int maxRowsPerPage)](#setMaxRowsPerPage-int-) | Sets the maximum number of rows per page. | ### TextOptions() {#TextOptions--} ``` public TextOptions() ``` +Initializes a new instance of the TextOptions class. + ### getMaxCharsPerRow() {#getMaxCharsPerRow--} ``` public int getMaxCharsPerRow() ``` -Max chars per row on page. Default value is 85. +Gets the maximum number of characters per row on a page. + +***Note:** The default value is 85.* **Returns:** -int +int - the maximum number of characters per row on a page. ### setMaxCharsPerRow(int maxCharsPerRow) {#setMaxCharsPerRow-int-} ``` public void setMaxCharsPerRow(int maxCharsPerRow) ``` -Max chars per row on page. Default value is 85. +Sets the maximum number of characters per row on a page. + +***Note:** The default value is 85.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxCharsPerRow | int | | +| maxCharsPerRow | int | The maximum number of characters per row on a page. | ### getMaxRowsPerPage() {#getMaxRowsPerPage--} ``` @@ -61,20 +85,24 @@ public int getMaxRowsPerPage() ``` -Max rows per page. Default value is 55. +Gets the maximum number of rows per page. + +***Note:** The default value is 55.* **Returns:** -int +int - the maximum number of rows. ### setMaxRowsPerPage(int maxRowsPerPage) {#setMaxRowsPerPage-int-} ``` public void setMaxRowsPerPage(int maxRowsPerPage) ``` -Max rows per page. Default value is 55. +Sets the maximum number of rows per page. + +***Note:** The default value is 55.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxRowsPerPage | int | | +| maxRowsPerPage | int | The maximum number of rows. | diff --git a/english/java/com.groupdocs.viewer.options/textoverflowmode/_index.md b/english/java/com.groupdocs.viewer.options/textoverflowmode/_index.md index 250b26a33..51d1234ea 100644 --- a/english/java/com.groupdocs.viewer.options/textoverflowmode/_index.md +++ b/english/java/com.groupdocs.viewer.options/textoverflowmode/_index.md @@ -13,14 +13,32 @@ public enum TextOverflowMode extends Enum ``` Defines text overflow mode for rendering spreadsheet documents into HTML. + +The TextOverflowMode enum represents different modes for handling text overflow in the GroupDocs.Viewer component. It provides a set of predefined options that can be used to control how text is displayed when it exceeds the available space in cells during the rendering of spreadsheet documents into HTML. + +Example usage: + +``` + + HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources(); + + htmlViewOptions.setSpreadsheetOptions(SpreadsheetOptions.forOnePagePerSheet()); + htmlViewOptions.getSpreadsheetOptions().setTextOverflowMode(TextOverflowMode.HIDE_TEXT); + + try (Viewer viewer = new Viewer("document.xlsx")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | | --- | --- | -| [OVERLAY](#OVERLAY) | Overlay next cells even they are not empty. | +| [OVERLAY](#OVERLAY) | Overlay next cells even if they are not empty. | | [OVERLAY_IF_NEXT_IS_EMPTY](#OVERLAY-IF-NEXT-IS-EMPTY) | Overlay next cells only if they are empty. | | [AUTO_FIT_COLUMN](#AUTO-FIT-COLUMN) | Expand columns to fit the text. | -| [HIDE_TEXT](#HIDE-TEXT) | Hide overflow text. | +| [HIDE_TEXT](#HIDE-TEXT) | Hide the overflow text. | ## Methods | Method | Description | @@ -33,7 +51,7 @@ public static final TextOverflowMode OVERLAY ``` -Overlay next cells even they are not empty. +Overlay next cells even if they are not empty. This mode allows the text to overflow into the adjacent cells, regardless of their content. ### OVERLAY_IF_NEXT_IS_EMPTY {#OVERLAY-IF-NEXT-IS-EMPTY} ``` @@ -41,7 +59,7 @@ public static final TextOverflowMode OVERLAY_IF_NEXT_IS_EMPTY ``` -Overlay next cells only if they are empty. +Overlay next cells only if they are empty. This mode allows the text to overflow into the adjacent cells only if those cells are empty. ### AUTO_FIT_COLUMN {#AUTO-FIT-COLUMN} ``` @@ -49,7 +67,7 @@ public static final TextOverflowMode AUTO_FIT_COLUMN ``` -Expand columns to fit the text. +Expand columns to fit the text. This mode automatically adjusts the width of the columns to accommodate the overflowing text. ### HIDE_TEXT {#HIDE-TEXT} ``` @@ -57,7 +75,7 @@ public static final TextOverflowMode HIDE_TEXT ``` -Hide overflow text. +Hide the overflow text. This mode hides the overflowing text, preventing it from being displayed. ### values() {#values--} ``` diff --git a/english/java/com.groupdocs.viewer.options/tile/_index.md b/english/java/com.groupdocs.viewer.options/tile/_index.md index b1cc69733..daa34cf8e 100644 --- a/english/java/com.groupdocs.viewer.options/tile/_index.md +++ b/english/java/com.groupdocs.viewer.options/tile/_index.md @@ -13,19 +13,37 @@ public class Tile ``` Represents drawing region. + +The Tile class represents a drawing region in the GroupDocs.Viewer component. It is used to define a specific area or region within a document that needs to be rendered or processed separately. + +Example usage: + +``` + + Tile tile = new Tile(100, 100, 200, 200); + + PngViewOptions pngViewOptions = new PngViewOptions(); + pngViewOptions.getCadOptions().setTiles(Arrays.asList(tile)); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pngViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [Tile(int startPointX, int startPointY, int width, int height)](#Tile-int-int-int-int-) | Initializes a new instance of the [Tile](../../com.groupdocs.viewer.options/tile) class. | +| [Tile(int startPointX, int startPointY, int width, int height)](#Tile-int-int-int-int-) | Initializes a new instance of the Tile class. | ## Methods | Method | Description | | --- | --- | -| [getStartPointX()](#getStartPointX--) | The X coordinate of the lowest left point on the drawing where the tile begins. | -| [getStartPointY()](#getStartPointY--) | The Y coordinate of the lowest left point on the drawing where the tile begins. | -| [getWidth()](#getWidth--) | The width of the tile in pixels. | -| [getHeight()](#getHeight--) | The height of the tile in pixels. | +| [getStartPointX()](#getStartPointX--) | Gets the X coordinate of the lowest left point on the drawing where the tile begins. | +| [getStartPointY()](#getStartPointY--) | Gets the Y coordinate of the lowest left point on the drawing where the tile begins. | +| [getWidth()](#getWidth--) | Gets the width of the tile in pixels. | +| [getHeight()](#getHeight--) | Gets the height of the tile in pixels. | | [getEndPointX()](#getEndPointX--) | Returns the X coordinate of the highest right point on the drawing where the tile ends. | | [getEndPointY()](#getEndPointY--) | Returns the Y coordinate of the highest right point on the drawing where the tile ends. | ### Tile(int startPointX, int startPointY, int width, int height) {#Tile-int-int-int-int-} @@ -34,12 +52,14 @@ public Tile(int startPointX, int startPointY, int width, int height) ``` -Initializes a new instance of the [Tile](../../com.groupdocs.viewer.options/tile) class. +Initializes a new instance of the Tile class. + +This constructor creates a new tile object with the specified starting point, width, and height. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| startPointX | int | The X coordinate of the lowest left point on the drawing where the tile begins | +| startPointX | int | The X coordinate of the lowest left point on the drawing where the tile begins. | | startPointY | int | The Y coordinate of the lowest left point on the drawing where the tile begins. | | width | int | The width of the tile in pixels. | | height | int | The height of the tile in pixels. | @@ -50,40 +70,40 @@ public final int getStartPointX() ``` -The X coordinate of the lowest left point on the drawing where the tile begins. +Gets the X coordinate of the lowest left point on the drawing where the tile begins. **Returns:** -int +int - the X coordinate of the lowest left point. ### getStartPointY() {#getStartPointY--} ``` public final int getStartPointY() ``` -The Y coordinate of the lowest left point on the drawing where the tile begins. +Gets the Y coordinate of the lowest left point on the drawing where the tile begins. **Returns:** -int +int - the Y coordinate of the lowest left point. ### getWidth() {#getWidth--} ``` public final int getWidth() ``` -The width of the tile in pixels. +Gets the width of the tile in pixels. **Returns:** -int +int - the width of the tile. ### getHeight() {#getHeight--} ``` public final int getHeight() ``` -The height of the tile in pixels. +Gets the height of the tile in pixels. **Returns:** -int +int - the height of the tile. ### getEndPointX() {#getEndPointX--} ``` public final int getEndPointX() @@ -93,7 +113,7 @@ public final int getEndPointX() Returns the X coordinate of the highest right point on the drawing where the tile ends. **Returns:** -int +int - the X coordinate of the highest right point. ### getEndPointY() {#getEndPointY--} ``` public final int getEndPointY() @@ -103,4 +123,4 @@ public final int getEndPointY() Returns the Y coordinate of the highest right point on the drawing where the tile ends. **Returns:** -int +int - the Y coordinate of the highest right point. diff --git a/english/java/com.groupdocs.viewer.options/timeunit/_index.md b/english/java/com.groupdocs.viewer.options/timeunit/_index.md index 40d7ec090..aea8d0f8d 100644 --- a/english/java/com.groupdocs.viewer.options/timeunit/_index.md +++ b/english/java/com.groupdocs.viewer.options/timeunit/_index.md @@ -13,14 +13,31 @@ public enum TimeUnit extends Enum ``` Time unit of the project duration. + +The TimeUnit enum represents different time units for specifying the duration of a project in the GroupDocs.Viewer component. It provides a set of predefined time units that can be used to represent and calculate the duration of a project, such as days, months and so on. + +Example usage: + +``` + + HtmlViewOptions pdfViewOptions = HtmlViewOptions.forEmbeddedResources(); + ProjectManagementOptions projectManagementOptions = pdfViewOptions.getProjectManagementOptions(); + projectManagementOptions.setTimeUnit(TimeUnit.MONTHS); + + try (Viewer viewer = new Viewer("document.mpp")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Fields | Field | Description | | --- | --- | -| [UNSPECIFIED](#UNSPECIFIED) | The unknown, unspecified time scale. | -| [DAYS](#DAYS) | The one day interval. | -| [THIRDS_OF_MONTHS](#THIRDS-OF-MONTHS) | The one third of the month. | -| [MONTHS](#MONTHS) | The one month interval. | +| [UNSPECIFIED](#UNSPECIFIED) | The unknown time scale. | +| [DAYS](#DAYS) | Days time scale. | +| [THIRDS_OF_MONTHS](#THIRDS-OF-MONTHS) | Thirds of months time scale. | +| [MONTHS](#MONTHS) | Months time scale. | ## Methods | Method | Description | @@ -33,7 +50,7 @@ public static final TimeUnit UNSPECIFIED ``` -The unknown, unspecified time scale. +The unknown time scale. This time unit represents an unknown or unspecified time scale. ### DAYS {#DAYS} ``` @@ -41,7 +58,7 @@ public static final TimeUnit DAYS ``` -The one day interval. +Days time scale. This time unit represents a one-day interval. ### THIRDS_OF_MONTHS {#THIRDS-OF-MONTHS} ``` @@ -49,7 +66,7 @@ public static final TimeUnit THIRDS_OF_MONTHS ``` -The one third of the month. +Thirds of months time scale. This time unit represents a one-third of the month interval. ### MONTHS {#MONTHS} ``` @@ -57,7 +74,7 @@ public static final TimeUnit MONTHS ``` -The one month interval. +Months time scale. This time unit represents a one-month interval. ### values() {#values--} ``` diff --git a/english/java/com.groupdocs.viewer.options/viewinfooptions/_index.md b/english/java/com.groupdocs.viewer.options/viewinfooptions/_index.md index 687b8be97..adc2f2503 100644 --- a/english/java/com.groupdocs.viewer.options/viewinfooptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/viewinfooptions/_index.md @@ -16,62 +16,67 @@ public class ViewInfoOptions extends BaseViewOptions implements IMaxSizeOptions ``` Provides options used for retrieving information about view. -## Fields -| Field | Description | -| --- | --- | -| [OPTIONS](#OPTIONS) | | -## Methods +The ViewInfoOptions class encapsulates additional settings and parameters that can be used to retrieve information about a view in the GroupDocs.Viewer component. + +Example usage: -| Method | Description | -| --- | --- | -| [isExtractText()](#isExtractText--) | Indicates that text extraction is enabled. | -| [setExtractText(boolean extractText)](#setExtractText-boolean-) | Indicates that text extraction is enabled. | -| [getMaxWidth()](#getMaxWidth--) | Max width of the output image (for rendering to PNG/JPG only) | -| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Max width of the output image (for rendering to PNG/JPG only) | -| [getMaxHeight()](#getMaxHeight--) | Max height of the output image (for rendering to PNG/JPG only) | -| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Max height of the output image (for rendering to PNG/JPG only) | -| [getWidth()](#getWidth--) | Image width (for rendering to PNG/JPG only) | -| [setWidth(int width)](#setWidth-int-) | Image width (for rendering to PNG/JPG only) | -| [getHeight()](#getHeight--) | Image height (for rendering to PNG/JPG only) | -| [setHeight(int height)](#setHeight-int-) | Image height (for rendering to PNG/JPG only) | -| [forHtmlView()](#forHtmlView--) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into HTML. | -| [forHtmlView(boolean renderSinglePage)](#forHtmlView-boolean-) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into HTML. | -| [forJpgView()](#forJpgView--) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into JPG. | -| [forJpgView(boolean extractText)](#forJpgView-boolean-) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into JPG. | -| [forPngView()](#forPngView--) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into PNG. | -| [forPngView(boolean extractText)](#forPngView-boolean-) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into PNG. | -| [fromHtmlViewOptions(HtmlViewOptions options)](#fromHtmlViewOptions-com.groupdocs.viewer.options.HtmlViewOptions-) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class based on [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) object. | -| [fromPngViewOptions(PngViewOptions options)](#fromPngViewOptions-com.groupdocs.viewer.options.PngViewOptions-) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class based on [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) object. | -| [fromJpgViewOptions(JpgViewOptions options)](#fromJpgViewOptions-com.groupdocs.viewer.options.JpgViewOptions-) | Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class based on [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) object. | -### OPTIONS {#OPTIONS} -``` -public static final String OPTIONS ``` + ViewInfoOptions viewInfoOptions = ViewInfoOptions.forPngView(false); + try (Viewer viewer = new Viewer("document.pdf")) { + ViewInfo viewInfo = viewer.getViewInfo(viewInfoOptions); + // Use the viewInfo object for further operations + } + +``` +***Note:** The ViewInfoOptions class implements the IMaxSizeOptions interface to provide additional settings and size constraints for view information retrieval.* +## Methods + +| Method | Description | +| --- | --- | +| [isExtractText()](#isExtractText--) | Indicates whether text extraction is enabled. | +| [setExtractText(boolean extractText)](#setExtractText-boolean-) | Sets the flag indicating whether text extraction is enabled. | +| [getMaxWidth()](#getMaxWidth--) | Returns the maximum width of the output image for rendering to PNG/JPG. | +| [setMaxWidth(int maxWidth)](#setMaxWidth-int-) | Sets the maximum width of the output image for rendering to PNG/JPG. | +| [getMaxHeight()](#getMaxHeight--) | Returns the maximum height of the output image for rendering to PNG/JPG. | +| [setMaxHeight(int maxHeight)](#setMaxHeight-int-) | Sets the maximum height of the output image for rendering to PNG/JPG. | +| [getWidth()](#getWidth--) | Returns the width of the image for rendering to PNG/JPG. | +| [setWidth(int width)](#setWidth-int-) | Sets the width of the image for rendering to PNG/JPG. | +| [getHeight()](#getHeight--) | Returns the height of the image for rendering to PNG/JPG. | +| [setHeight(int height)](#setHeight-int-) | Sets the height of the image for rendering to PNG/JPG. | +| [forHtmlView()](#forHtmlView--) | Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML. | +| [forHtmlView(boolean renderSinglePage)](#forHtmlView-boolean-) | Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML. | +| [forJpgView()](#forJpgView--) | Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG. | +| [forJpgView(boolean extractText)](#forJpgView-boolean-) | Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG. | +| [forPngView()](#forPngView--) | Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG. | +| [forPngView(boolean extractText)](#forPngView-boolean-) | Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG. | +| [fromHtmlViewOptions(HtmlViewOptions options)](#fromHtmlViewOptions-com.groupdocs.viewer.options.HtmlViewOptions-) | Initializes a new instance of the ViewInfoOptions class based on the [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) object. | +| [fromPngViewOptions(PngViewOptions options)](#fromPngViewOptions-com.groupdocs.viewer.options.PngViewOptions-) | Initializes a new instance of the ViewInfoOptions class based on the [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) object. | +| [fromJpgViewOptions(JpgViewOptions options)](#fromJpgViewOptions-com.groupdocs.viewer.options.JpgViewOptions-) | Initializes a new instance of the ViewInfoOptions class based on the [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) object. | ### isExtractText() {#isExtractText--} ``` public boolean isExtractText() ``` -Indicates that text extraction is enabled. +Indicates whether text extraction is enabled. **Returns:** -boolean +boolean - True if text extraction is enabled, false otherwise. ### setExtractText(boolean extractText) {#setExtractText-boolean-} ``` public void setExtractText(boolean extractText) ``` -Indicates that text extraction is enabled. +Sets the flag indicating whether text extraction is enabled. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| extractText | boolean | | +| extractText | boolean | True to enable text extraction, false to disable. | ### getMaxWidth() {#getMaxWidth--} ``` @@ -79,22 +84,22 @@ public int getMaxWidth() ``` -Max width of the output image (for rendering to PNG/JPG only) +Returns the maximum width of the output image for rendering to PNG/JPG. **Returns:** -int +int - the maximum width of the output image. ### setMaxWidth(int maxWidth) {#setMaxWidth-int-} ``` public void setMaxWidth(int maxWidth) ``` -Max width of the output image (for rendering to PNG/JPG only) +Sets the maximum width of the output image for rendering to PNG/JPG. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxWidth | int | | +| maxWidth | int | The maximum width of the output image. | ### getMaxHeight() {#getMaxHeight--} ``` @@ -102,22 +107,22 @@ public int getMaxHeight() ``` -Max height of the output image (for rendering to PNG/JPG only) +Returns the maximum height of the output image for rendering to PNG/JPG. **Returns:** -int +int - the maximum height of the output image. ### setMaxHeight(int maxHeight) {#setMaxHeight-int-} ``` public void setMaxHeight(int maxHeight) ``` -Max height of the output image (for rendering to PNG/JPG only) +Sets the maximum height of the output image for rendering to PNG/JPG. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| maxHeight | int | | +| maxHeight | int | The maximum height of the output image. | ### getWidth() {#getWidth--} ``` @@ -125,22 +130,22 @@ public int getWidth() ``` -Image width (for rendering to PNG/JPG only) +Returns the width of the image for rendering to PNG/JPG. **Returns:** -int +int - the width of the image. ### setWidth(int width) {#setWidth-int-} ``` public void setWidth(int width) ``` -Image width (for rendering to PNG/JPG only) +Sets the width of the image for rendering to PNG/JPG. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| width | int | | +| width | int | The width of the image. | ### getHeight() {#getHeight--} ``` @@ -148,22 +153,22 @@ public int getHeight() ``` -Image height (for rendering to PNG/JPG only) +Returns the height of the image for rendering to PNG/JPG. **Returns:** -int +int - the height of the image. ### setHeight(int height) {#setHeight-int-} ``` public void setHeight(int height) ``` -Image height (for rendering to PNG/JPG only) +Sets the height of the image for rendering to PNG/JPG. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| height | int | | +| height | int | The height of the image. | ### forHtmlView() {#forHtmlView--} ``` @@ -171,42 +176,44 @@ public static ViewInfoOptions forHtmlView() ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into HTML. +Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML. **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of the ViewInfoOptions class. ### forHtmlView(boolean renderSinglePage) {#forHtmlView-boolean-} ``` public static ViewInfoOptions forHtmlView(boolean renderSinglePage) ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into HTML. +Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML. + +***Note:** By default, HTML content will be rendered on multiple pages.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| renderSinglePage | boolean | Enables HTML content will be rendered to single page. | +| renderSinglePage | boolean | Enables HTML content to be rendered on a single page. | **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. ### forJpgView() {#forJpgView--} ``` public static ViewInfoOptions forJpgView() ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into JPG. +Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG. **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. ### forJpgView(boolean extractText) {#forJpgView-boolean-} ``` public static ViewInfoOptions forJpgView(boolean extractText) ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into JPG. +Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG. **Parameters:** | Parameter | Type | Description | @@ -214,24 +221,24 @@ Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options | extractText | boolean | Enables text extraction. | **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. ### forPngView() {#forPngView--} ``` public static ViewInfoOptions forPngView() ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into PNG. +Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG. **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. ### forPngView(boolean extractText) {#forPngView-boolean-} ``` public static ViewInfoOptions forPngView(boolean extractText) ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class to retrieve information about view when rendering into PNG. +Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG. **Parameters:** | Parameter | Type | Description | @@ -239,14 +246,14 @@ Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options | extractText | boolean | Enables text extraction. | **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. ### fromHtmlViewOptions(HtmlViewOptions options) {#fromHtmlViewOptions-com.groupdocs.viewer.options.HtmlViewOptions-} ``` public static ViewInfoOptions fromHtmlViewOptions(HtmlViewOptions options) ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class based on [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) object. +Initializes a new instance of the ViewInfoOptions class based on the [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) object. **Parameters:** | Parameter | Type | Description | @@ -254,14 +261,14 @@ Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options | options | [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions) | The HTML view options. | **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. ### fromPngViewOptions(PngViewOptions options) {#fromPngViewOptions-com.groupdocs.viewer.options.PngViewOptions-} ``` public static ViewInfoOptions fromPngViewOptions(PngViewOptions options) ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class based on [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) object. +Initializes a new instance of the ViewInfoOptions class based on the [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) object. **Parameters:** | Parameter | Type | Description | @@ -269,14 +276,14 @@ Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options | options | [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) | The PNG view options. | **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. ### fromJpgViewOptions(JpgViewOptions options) {#fromJpgViewOptions-com.groupdocs.viewer.options.JpgViewOptions-} ``` public static ViewInfoOptions fromJpgViewOptions(JpgViewOptions options) ``` -Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class based on [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) object. +Initializes a new instance of the ViewInfoOptions class based on the [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) object. **Parameters:** | Parameter | Type | Description | @@ -284,4 +291,4 @@ Initializes new instance of [ViewInfoOptions](../../com.groupdocs.viewer.options | options | [JpgViewOptions](../../com.groupdocs.viewer.options/jpgviewoptions) | The JPG view options. | **Returns:** -[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) class. +[ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) - New instance of ViewInfoOptions class. diff --git a/english/java/com.groupdocs.viewer.options/viewoptions/_index.md b/english/java/com.groupdocs.viewer.options/viewoptions/_index.md index a9aa1cfea..15aa6cb7b 100644 --- a/english/java/com.groupdocs.viewer.options/viewoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/viewoptions/_index.md @@ -13,6 +13,10 @@ public abstract class ViewOptions extends BaseViewOptions ``` Provides rendering options. + +The ViewOptions class extends the BaseViewOptions class and serves as a base class for rendering options in the GroupDocs.Viewer component. It encapsulates common settings and parameters that can be used for rendering various types of documents into different formats. + +***Note:** The ViewOptions class should not be used directly, use [HtmlViewOptions](../../com.groupdocs.viewer.options/htmlviewoptions), [PdfViewOptions](../../com.groupdocs.viewer.options/pdfviewoptions), [PngViewOptions](../../com.groupdocs.viewer.options/pngviewoptions) and so on instead.* ## Constructors | Constructor | Description | @@ -22,10 +26,10 @@ Provides rendering options. | Method | Description | | --- | --- | -| [getWatermark()](#getWatermark--) | The text watermark applied to each page. | -| [setWatermark(Watermark value)](#setWatermark-com.groupdocs.viewer.options.Watermark-) | The text watermark applied to each page. | -| [rotatePage(int pageNumber, Rotation rotation)](#rotatePage-int-com.groupdocs.viewer.options.Rotation-) | Applies clockwise rotation to the page. | -| [getPageRotations()](#getPageRotations--) | The page rotations. | +| [getWatermark()](#getWatermark--) | Gets the text watermark applied to each page. | +| [setWatermark(Watermark value)](#setWatermark-com.groupdocs.viewer.options.Watermark-) | Sets the text watermark to be applied to each page. | +| [rotatePage(int pageNumber, Rotation rotation)](#rotatePage-int-com.groupdocs.viewer.options.Rotation-) | Applies a clockwise rotation to the specified page. | +| [getPageRotations()](#getPageRotations--) | Retrieves the page rotations. | | [isPageRotationsInitialized_Internal()](#isPageRotationsInitialized-Internal--) | To prevent creating the instance just to check that it is empty | ### ViewOptions() {#ViewOptions--} ``` @@ -39,30 +43,26 @@ public final Watermark getWatermark() ``` -The text watermark applied to each page. +Gets the text watermark applied to each page. --------------------- - -In case both \#setWatermark(Watermark).setWatermark(Watermark) and \#getPageRotations().getPageRotations() are specified than watermark will be applied to the rotated pages. +In case both \#setWatermark(Watermark).setWatermark(Watermark) and \#getPageRotations().getPageRotations() are specified, the watermark will be applied to the rotated pages. **Returns:** -[Watermark](../../com.groupdocs.viewer.options/watermark) +[Watermark](../../com.groupdocs.viewer.options/watermark) - the text watermark applied to each page. ### setWatermark(Watermark value) {#setWatermark-com.groupdocs.viewer.options.Watermark-} ``` public final void setWatermark(Watermark value) ``` -The text watermark applied to each page. - --------------------- +Sets the text watermark to be applied to each page. -In case both ViewOptions.Watermark and \#getPageRotations().getPageRotations() are specified than watermark will be applied to the rotated pages. +In case both ViewOptions.Watermark and \#getPageRotations().getPageRotations() are specified, the watermark will be applied to the rotated pages. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [Watermark](../../com.groupdocs.viewer.options/watermark) | | +| value | [Watermark](../../com.groupdocs.viewer.options/watermark) | The text watermark to be set. | ### rotatePage(int pageNumber, Rotation rotation) {#rotatePage-int-com.groupdocs.viewer.options.Rotation-} ``` @@ -70,7 +70,7 @@ public final void rotatePage(int pageNumber, Rotation rotation) ``` -Applies clockwise rotation to the page. +Applies a clockwise rotation to the specified page. **Parameters:** | Parameter | Type | Description | @@ -84,12 +84,12 @@ public Map getPageRotations() ``` -The page rotations. +Retrieves the page rotations. -In case both ([setWatermark(Watermark)](../../com.groupdocs.viewer.options/viewoptions\#setWatermark-Watermark-)/getPageRotations()) are specified than watermark will be applied to the rotated pages. +If both [setWatermark(Watermark)](../../com.groupdocs.viewer.options/viewoptions\#setWatermark-Watermark-) and getPageRotations() are specified, the watermark will be applied to the rotated pages. **Returns:** -java.util.Map +java.util.Map - a map containing the page numbers as keys and their corresponding rotations as values. ### isPageRotationsInitialized_Internal() {#isPageRotationsInitialized-Internal--} ``` public boolean isPageRotationsInitialized_Internal() diff --git a/english/java/com.groupdocs.viewer.options/visiorenderingoptions/_index.md b/english/java/com.groupdocs.viewer.options/visiorenderingoptions/_index.md index 11136cc46..ee56273da 100644 --- a/english/java/com.groupdocs.viewer.options/visiorenderingoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/visiorenderingoptions/_index.md @@ -13,26 +13,43 @@ public class VisioRenderingOptions ``` The Visio files processing documents view options. + +The VisioRenderingOptions class provides options for processing and rendering Visio files in the GroupDocs.Viewer component. It encapsulates settings and parameters that can be used to control the rendering process and output format for Visio documents. + +Example usage: + +``` + + PngViewOptions pngViewOptions = new PngViewOptions(); + VisioRenderingOptions visioRenderingOptions = pngViewOptions.getVisioRenderingOptions(); + visioRenderingOptions.setRenderFiguresOnly(true); + + try (Viewer viewer = new Viewer(visioDocument)) { + viewer.view(pngViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [VisioRenderingOptions()](#VisioRenderingOptions--) | Initializes new instance of class. | +| [VisioRenderingOptions()](#VisioRenderingOptions--) | Initializes a new instance of the VisioRenderingOptions class. | ## Methods | Method | Description | | --- | --- | -| [isRenderFiguresOnly()](#isRenderFiguresOnly--) | Render only Visio figures, not a diagram | -| [setRenderFiguresOnly(boolean renderFiguresOnly)](#setRenderFiguresOnly-boolean-) | Render only Visio figures, not a diagram | -| [getFigureWidth()](#getFigureWidth--) | Figure width, height will be calculated automatically | -| [setFigureWidth(int figureWidth)](#setFigureWidth-int-) | Figure width, height will be calculated automatically. | +| [isRenderFiguresOnly()](#isRenderFiguresOnly--) | Render only Visio figures, excluding the diagram. | +| [setRenderFiguresOnly(boolean renderFiguresOnly)](#setRenderFiguresOnly-boolean-) | Sets the flag to render only Visio figures, excluding the diagram. | +| [getFigureWidth()](#getFigureWidth--) | Retrieves the width of the figure. | +| [setFigureWidth(int figureWidth)](#setFigureWidth-int-) | Sets the width of the figure. | ### VisioRenderingOptions() {#VisioRenderingOptions--} ``` public VisioRenderingOptions() ``` -Initializes new instance of class. +Initializes a new instance of the VisioRenderingOptions class. ### isRenderFiguresOnly() {#isRenderFiguresOnly--} ``` @@ -40,22 +57,22 @@ public boolean isRenderFiguresOnly() ``` -Render only Visio figures, not a diagram +Render only Visio figures, excluding the diagram. **Returns:** -boolean +boolean - true if only Visio figures should be rendered, false otherwise. ### setRenderFiguresOnly(boolean renderFiguresOnly) {#setRenderFiguresOnly-boolean-} ``` public void setRenderFiguresOnly(boolean renderFiguresOnly) ``` -Render only Visio figures, not a diagram +Sets the flag to render only Visio figures, excluding the diagram. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| renderFiguresOnly | boolean | | +| renderFiguresOnly | boolean | true to render only Visio figures, false to include the diagram. | ### getFigureWidth() {#getFigureWidth--} ``` @@ -63,20 +80,22 @@ public int getFigureWidth() ``` -Figure width, height will be calculated automatically +Retrieves the width of the figure. The height will be calculated automatically. **Returns:** -int +int - the width of the figure. ### setFigureWidth(int figureWidth) {#setFigureWidth-int-} ``` public void setFigureWidth(int figureWidth) ``` -Figure width, height will be calculated automatically. Default value is 100. +Sets the width of the figure. The height will be calculated automatically. + +***Note:** Default value is 100.* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| figureWidth | int | | +| figureWidth | int | The width of the figure. | diff --git a/english/java/com.groupdocs.viewer.options/watermark/_index.md b/english/java/com.groupdocs.viewer.options/watermark/_index.md index ffc237936..2f8e3640d 100644 --- a/english/java/com.groupdocs.viewer.options/watermark/_index.md +++ b/english/java/com.groupdocs.viewer.options/watermark/_index.md @@ -13,36 +13,57 @@ public class Watermark ``` Represents text watermark. + +The Watermark class represents a text watermark in the GroupDocs.Viewer component. It is used to define and apply a watermark to the rendered output of documents. + +Example usage: + +``` + + Watermark watermark = new Watermark("Watermark"); + watermark.setPosition(Position.DIAGONAL); + watermark.setColor(java.awt.Color.GREEN); + watermark.setSize(Size.HALF_SIZE); + + PdfViewOptions pdfViewOptions = new PdfViewOptions(); + pdfViewOptions.setWatermark(watermark); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pdfViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [Watermark(String text)](#Watermark-java.lang.String-) | Initializes new instance of [Watermark](../../com.groupdocs.viewer.options/watermark) class. | +| [Watermark(String text)](#Watermark-java.lang.String-) | Initializes a new instance of the Watermark class. | ## Methods | Method | Description | | --- | --- | -| [getText()](#getText--) | The watermark text. | -| [getColor()](#getColor--) | The watermark color. | -| [setColor(Color value)](#setColor-java.awt.Color-) | The watermark color. | -| [getPosition()](#getPosition--) | The watermark position. | -| [setPosition(Position value)](#setPosition-com.groupdocs.viewer.options.Position-) | The watermark position. | -| [getSize()](#getSize--) | The watermark size. | -| [setSize(Size value)](#setSize-com.groupdocs.viewer.options.Size-) | The watermark size. | -| [getFontName()](#getFontName--) | The font name used for the watermark. | -| [setFontName(String value)](#setFontName-java.lang.String-) | The font name used for the watermark. | +| [getText()](#getText--) | Returns the watermark text. | +| [getColor()](#getColor--) | Returns the watermark color. | +| [setColor(Color value)](#setColor-java.awt.Color-) | Sets the watermark color. | +| [getPosition()](#getPosition--) | Returns the watermark position. | +| [setPosition(Position value)](#setPosition-com.groupdocs.viewer.options.Position-) | Sets the watermark position. | +| [getSize()](#getSize--) | Returns the watermark size. | +| [setSize(Size value)](#setSize-com.groupdocs.viewer.options.Size-) | Sets the watermark size. | +| [getFontName()](#getFontName--) | Returns the font name used for the watermark. | +| [setFontName(String value)](#setFontName-java.lang.String-) | Sets the font name used for the watermark. | ### Watermark(String text) {#Watermark-java.lang.String-} ``` public Watermark(String text) ``` -Initializes new instance of [Watermark](../../com.groupdocs.viewer.options/watermark) class. +Initializes a new instance of the Watermark class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| text | java.lang.String | Watermark text. | +| text | java.lang.String | The watermark text. | ### getText() {#getText--} ``` @@ -50,32 +71,36 @@ public final String getText() ``` -The watermark text. +Returns the watermark text. This method retrieves the text of the watermark applied to the document. **Returns:** -java.lang.String - The watermark text. +java.lang.String - the watermark text. ### getColor() {#getColor--} ``` public final Color getColor() ``` -The watermark color. Default value is Color\#getRed().getRed(). +Returns the watermark color. This method retrieves the color of the watermark applied to the document. + +***Note:** The default value is the red color obtained from Color\#getRed().getRed().* **Returns:** -java.awt.Color +java.awt.Color - the watermark color. ### setColor(Color value) {#setColor-java.awt.Color-} ``` public final void setColor(Color value) ``` -The watermark color. Default value is Color\#getRed().getRed(). +Sets the watermark color. This method sets the color of the watermark applied to the document. + +***Note:** The default value is obtained from Color\#getRed().getRed().* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.awt.Color | | +| value | java.awt.Color | The watermark color to set. | ### getPosition() {#getPosition--} ``` @@ -83,17 +108,21 @@ public final Position getPosition() ``` -The watermark position. Default value is [Position.DIAGONAL](../../com.groupdocs.viewer.options/position\#DIAGONAL). +Returns the watermark position. This method returns the position of the watermark applied to the document. + +***Note:** The default value is [Position.DIAGONAL](../../com.groupdocs.viewer.options/position\#DIAGONAL).* **Returns:** -[Position](../../com.groupdocs.viewer.options/position) - The watermark position. +[Position](../../com.groupdocs.viewer.options/position) - the watermark position. ### setPosition(Position value) {#setPosition-com.groupdocs.viewer.options.Position-} ``` public final void setPosition(Position value) ``` -The watermark position. Default value is [Position.DIAGONAL](../../com.groupdocs.viewer.options/position\#DIAGONAL). +Sets the watermark position. This method sets the position of the watermark applied to the document. + +***Note:** The default value is [Position.DIAGONAL](../../com.groupdocs.viewer.options/position\#DIAGONAL).* **Parameters:** | Parameter | Type | Description | @@ -106,22 +135,26 @@ public final Size getSize() ``` -The watermark size. Default value is [Size.FULL\_SIZE](../../com.groupdocs.viewer.options/size\#FULL-SIZE). +Returns the watermark size. This method retrieves the size of the watermark applied to the document. + +***Note:** The default value is [Size.FULL\_SIZE](../../com.groupdocs.viewer.options/size\#FULL-SIZE).* **Returns:** -[Size](../../com.groupdocs.viewer.options/size) +[Size](../../com.groupdocs.viewer.options/size) - the watermark size. ### setSize(Size value) {#setSize-com.groupdocs.viewer.options.Size-} ``` public final void setSize(Size value) ``` -The watermark size. Default value is [Size.FULL\_SIZE](../../com.groupdocs.viewer.options/size\#FULL-SIZE). +Sets the watermark size. This method sets the size of the watermark to be applied to the document. + +***Note:** The default value is [Size.FULL\_SIZE](../../com.groupdocs.viewer.options/size\#FULL-SIZE).* **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | [Size](../../com.groupdocs.viewer.options/size) | | +| value | [Size](../../com.groupdocs.viewer.options/size) | The watermark size. | ### getFontName() {#getFontName--} ``` @@ -129,20 +162,20 @@ public final String getFontName() ``` -The font name used for the watermark. +Returns the font name used for the watermark. **Returns:** -java.lang.String +java.lang.String - the font name used for the watermark. ### setFontName(String value) {#setFontName-java.lang.String-} ``` public final void setFontName(String value) ``` -The font name used for the watermark. +Sets the font name used for the watermark. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.lang.String | | +| value | java.lang.String | The font name used for the watermark. | diff --git a/english/java/com.groupdocs.viewer.options/wordprocessingoptions/_index.md b/english/java/com.groupdocs.viewer.options/wordprocessingoptions/_index.md index 692ef0df0..e50ef3aff 100644 --- a/english/java/com.groupdocs.viewer.options/wordprocessingoptions/_index.md +++ b/english/java/com.groupdocs.viewer.options/wordprocessingoptions/_index.md @@ -13,57 +13,110 @@ public class WordProcessingOptions ``` Provides options for rendering word processing documents. + +The WordProcessingOptions class provides options for rendering word processing documents in the GroupDocs.Viewer component. It encapsulates settings and parameters that can be used to control the rendering process and output format for word processing files. + +Example usage: + +``` + + PngViewOptions pngViewOptions = new PngViewOptions(); + WordProcessingOptions wordProcessingOptions = pngViewOptions.getWordProcessingOptions(); + wordProcessingOptions.setRenderTrackedChanges(true); + wordProcessingOptions.setLeftMargin(32f); + + try (Viewer viewer = new Viewer("document.docx")) { + viewer.view(pngViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [WordProcessingOptions()](#WordProcessingOptions--) | | +| [WordProcessingOptions()](#WordProcessingOptions--) | Initializes a new instance of the WordProcessingOptions class. | ## Methods | Method | Description | | --- | --- | -| [isRenderTrackedChanges()](#isRenderTrackedChanges--) | Enables tracked changes (revisions) rendering. | -| [setRenderTrackedChanges(boolean value)](#setRenderTrackedChanges-boolean-) | Enables tracked changes (revisions) rendering. | -| [getLeftMargin()](#getLeftMargin--) | Left page margin (for HTML rendering only) | -| [setLeftMargin(Float leftMargin)](#setLeftMargin-java.lang.Float-) | Left page margin (for HTML rendering only) | -| [getRightMargin()](#getRightMargin--) | Right page margin (for HTML rendering only) | -| [setRightMargin(Float rightMargin)](#setRightMargin-java.lang.Float-) | Right page margin (for HTML rendering only) | -| [getTopMargin()](#getTopMargin--) | Top page margin (for HTML rendering only) | -| [setTopMargin(Float topMargin)](#setTopMargin-java.lang.Float-) | Top page margin (for HTML rendering only) | +| [getPageSize()](#getPageSize--) | Retrieves the page size for rendering HTM and HTML files. | +| [setPageSize(PageSize pageSize)](#setPageSize-com.groupdocs.viewer.options.PageSize-) | Sets the page size for rendering HTM and HTML files. | +| [isRenderTrackedChanges()](#isRenderTrackedChanges--) | Indicates whether tracked changes (revisions) rendering is enabled. | +| [setRenderTrackedChanges(boolean value)](#setRenderTrackedChanges-boolean-) | Sets whether tracked changes (revisions) rendering is enabled. | +| [getLeftMargin()](#getLeftMargin--) | Retrieves the left page margin for HTML rendering. | +| [setLeftMargin(Float leftMargin)](#setLeftMargin-java.lang.Float-) | Sets the left page margin for HTML rendering. | +| [getRightMargin()](#getRightMargin--) | Gets the right page margin for HTML rendering. | +| [setRightMargin(Float rightMargin)](#setRightMargin-java.lang.Float-) | Sets the right page margin for HTML rendering. | +| [getTopMargin()](#getTopMargin--) | Retrieves the top page margin for HTML rendering. | +| [setTopMargin(Float topMargin)](#setTopMargin-java.lang.Float-) | Sets the top page margin for HTML rendering. | | [isEnableOpenTypeFeatures()](#isEnableOpenTypeFeatures--) | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. | | [setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures)](#setEnableOpenTypeFeatures-boolean-) | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. | | [getBottomMargin()](#getBottomMargin--) | Bottom page margin (for HTML rendering only) | -| [setBottomMargin(Float bottomMargin)](#setBottomMargin-java.lang.Float-) | Bottom page margin (for HTML rendering only) | -| [equals(Object o)](#equals-java.lang.Object-) | Check options are changed | -| [hashCode()](#hashCode--) | | +| [setBottomMargin(Float bottomMargin)](#setBottomMargin-java.lang.Float-) | Sets the bottom page margin for HTML rendering. | +| [equals(Object o)](#equals-java.lang.Object-) | Check if the options are changed. | +| [hashCode()](#hashCode--) | \{@inheritDoc\} | ### WordProcessingOptions() {#WordProcessingOptions--} ``` public WordProcessingOptions() ``` +Initializes a new instance of the WordProcessingOptions class. + +### getPageSize() {#getPageSize--} +``` +public PageSize getPageSize() +``` + + +Retrieves the page size for rendering HTM and HTML files. + +When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using [PageSize.A3](../../com.groupdocs.viewer.options/pagesize\#A3). + +***Note:** The default value is [PageSize.UNSPECIFIED](../../com.groupdocs.viewer.options/pagesize\#UNSPECIFIED), which means that a page size set in the page settings (Page Setup) will be used.* + +**Returns:** +[PageSize](../../com.groupdocs.viewer.options/pagesize) - The size of the output page. +### setPageSize(PageSize pageSize) {#setPageSize-com.groupdocs.viewer.options.PageSize-} +``` +public void setPageSize(PageSize pageSize) +``` + + +Sets the page size for rendering HTM and HTML files. + +When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using [PageSize.A3](../../com.groupdocs.viewer.options/pagesize\#A3). + +***Note:** The default value is [PageSize.UNSPECIFIED](../../com.groupdocs.viewer.options/pagesize\#UNSPECIFIED), which means that a page size set in the page settings (Page Setup) will be used.* + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| pageSize | [PageSize](../../com.groupdocs.viewer.options/pagesize) | The size of the output page. | + ### isRenderTrackedChanges() {#isRenderTrackedChanges--} ``` public final boolean isRenderTrackedChanges() ``` -Enables tracked changes (revisions) rendering. +Indicates whether tracked changes (revisions) rendering is enabled. **Returns:** -boolean +boolean - true if tracked changes rendering is enabled, false otherwise. ### setRenderTrackedChanges(boolean value) {#setRenderTrackedChanges-boolean-} ``` public final void setRenderTrackedChanges(boolean value) ``` -Enables tracked changes (revisions) rendering. +Sets whether tracked changes (revisions) rendering is enabled. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | | +| value | boolean | true to enable tracked changes rendering, false to disable it. | ### getLeftMargin() {#getLeftMargin--} ``` @@ -71,22 +124,22 @@ public Float getLeftMargin() ``` -Left page margin (for HTML rendering only) +Retrieves the left page margin for HTML rendering. **Returns:** -java.lang.Float +java.lang.Float - the left page margin value. ### setLeftMargin(Float leftMargin) {#setLeftMargin-java.lang.Float-} ``` public void setLeftMargin(Float leftMargin) ``` -Left page margin (for HTML rendering only) +Sets the left page margin for HTML rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| leftMargin | java.lang.Float | | +| leftMargin | java.lang.Float | The left page margin value to set. | ### getRightMargin() {#getRightMargin--} ``` @@ -94,22 +147,22 @@ public Float getRightMargin() ``` -Right page margin (for HTML rendering only) +Gets the right page margin for HTML rendering. **Returns:** -java.lang.Float +java.lang.Float - the right page margin value. ### setRightMargin(Float rightMargin) {#setRightMargin-java.lang.Float-} ``` public void setRightMargin(Float rightMargin) ``` -Right page margin (for HTML rendering only) +Sets the right page margin for HTML rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| rightMargin | java.lang.Float | | +| rightMargin | java.lang.Float | The right page margin value to set. | ### getTopMargin() {#getTopMargin--} ``` @@ -117,22 +170,22 @@ public Float getTopMargin() ``` -Top page margin (for HTML rendering only) +Retrieves the top page margin for HTML rendering. **Returns:** -java.lang.Float +java.lang.Float - the top page margin. ### setTopMargin(Float topMargin) {#setTopMargin-java.lang.Float-} ``` public void setTopMargin(Float topMargin) ``` -Top page margin (for HTML rendering only) +Sets the top page margin for HTML rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| topMargin | java.lang.Float | | +| topMargin | java.lang.Float | The top page margin to set. | ### isEnableOpenTypeFeatures() {#isEnableOpenTypeFeatures--} ``` @@ -143,7 +196,7 @@ public boolean isEnableOpenTypeFeatures() This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. **Returns:** -boolean +boolean - True if OpenType features are enabled, false otherwise. ### setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures) {#setEnableOpenTypeFeatures-boolean-} ``` public void setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures) @@ -155,7 +208,7 @@ This option enables kerning and other OpenType Features when rendering Arabic, H **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| enableOpenTypeFeatures | boolean | | +| enableOpenTypeFeatures | boolean | True to enable OpenType features, false otherwise. | ### getBottomMargin() {#getBottomMargin--} ``` @@ -166,19 +219,19 @@ public Float getBottomMargin() Bottom page margin (for HTML rendering only) **Returns:** -java.lang.Float +java.lang.Float - the bottom page margin. ### setBottomMargin(Float bottomMargin) {#setBottomMargin-java.lang.Float-} ``` public void setBottomMargin(Float bottomMargin) ``` -Bottom page margin (for HTML rendering only) +Sets the bottom page margin for HTML rendering. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| bottomMargin | java.lang.Float | | +| bottomMargin | java.lang.Float | The bottom page margin to set. | ### equals(Object o) {#equals-java.lang.Object-} ``` @@ -186,22 +239,24 @@ public boolean equals(Object o) ``` -Check options are changed +Check if the options are changed. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| o | java.lang.Object | | +| o | java.lang.Object | The object to compare for equality. | **Returns:** -boolean +boolean - true if the options are equal to the specified object, false otherwise. ### hashCode() {#hashCode--} ``` public int hashCode() ``` +Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets. +**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class. **Returns:** -int +int - the hash code value for this object. diff --git a/english/java/com.groupdocs.viewer.results/_index.md b/english/java/com.groupdocs.viewer.results/_index.md index c635f05f6..59e745694 100644 --- a/english/java/com.groupdocs.viewer.results/_index.md +++ b/english/java/com.groupdocs.viewer.results/_index.md @@ -1,13 +1,26 @@ --- title: com.groupdocs.viewer.results second_title: GroupDocs.Viewer for Java API Reference -description: The package provides classes which represent document rendering results. +description: The package provides classes and interfaces that represent document rendering results. type: docs weight: 18 url: /java/com.groupdocs.viewer.results/ --- -The package provides classes which represent document rendering results. +The package provides classes and interfaces that represent document rendering results. + +These classes encapsulate information about various elements and components of the rendered document, such as pages, attachments, views, resources, and more. + +The main classes in this package are: + + * [Page](../../com.groupdocs.viewer.results/page) - Represents a single page that can be viewed. + * [Attachment](../../com.groupdocs.viewer.results/attachment) - Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file. + * [PdfViewInfo](../../com.groupdocs.viewer.results/pdfviewinfo) - Represents view information for a PDF document. + +For more details on working with document rendering results using GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Classes @@ -20,19 +33,19 @@ The package provides classes which represent document rendering results. | Interface | Description | | --- | --- | -| [ArchiveViewInfo](../com.groupdocs.viewer.results/archiveviewinfo) | Represents view information for archive file. | -| [Attachment](../com.groupdocs.viewer.results/attachment) | Represents attachment file contained by email message, archive, PDF document or Outlook data file. | -| [CadViewInfo](../com.groupdocs.viewer.results/cadviewinfo) | Represents view information for CAD drawing. | -| [Character](../com.groupdocs.viewer.results/character) | Represents relatively positioned rectangle which contains single character. | -| [FileInfo](../com.groupdocs.viewer.results/fileinfo) | Contains information about file. | -| [Layer](../com.groupdocs.viewer.results/layer) | Represents layer contained by the CAD drawing. | -| [Layout](../com.groupdocs.viewer.results/layout) | Represents layout contained by the CAD drawing. | -| [Line](../com.groupdocs.viewer.results/line) | Represents relatively positioned rectangle which contains single line. | -| [LotusNotesViewInfo](../com.groupdocs.viewer.results/lotusnotesviewinfo) | Represents view information for Lotus notes database storage Default implementation is LotusNotesViewInfoImpl | -| [OutlookViewInfo](../com.groupdocs.viewer.results/outlookviewinfo) | Represents view information for Outlook Data file. | -| [Page](../com.groupdocs.viewer.results/page) | Represents single page that can be viewed. | -| [PdfViewInfo](../com.groupdocs.viewer.results/pdfviewinfo) | Represents view information for PDF document. | -| [ProjectManagementViewInfo](../com.groupdocs.viewer.results/projectmanagementviewinfo) | Represents view information for MS Project document. | -| [TextElement](../com.groupdocs.viewer.results/textelement) | Represents generic text element. | -| [ViewInfo](../com.groupdocs.viewer.results/viewinfo) | Represents view information for generic document. | -| [Word](../com.groupdocs.viewer.results/word) | Represents relatively positioned rectangle which contains single word. | +| [ArchiveViewInfo](../com.groupdocs.viewer.results/archiveviewinfo) | Represents view information for an archive file. | +| [Attachment](../com.groupdocs.viewer.results/attachment) | Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file. | +| [CadViewInfo](../com.groupdocs.viewer.results/cadviewinfo) | Represents view information for a CAD drawing. | +| [Character](../com.groupdocs.viewer.results/character) | Represents a relatively positioned rectangle that contains a single character. | +| [FileInfo](../com.groupdocs.viewer.results/fileinfo) | Contains information about a file. | +| [Layer](../com.groupdocs.viewer.results/layer) | Represents a layer contained by a CAD drawing. | +| [Layout](../com.groupdocs.viewer.results/layout) | Represents a layout contained by a CAD drawing. | +| [Line](../com.groupdocs.viewer.results/line) | Represents a relatively positioned rectangle that contains a single line. | +| [LotusNotesViewInfo](../com.groupdocs.viewer.results/lotusnotesviewinfo) | Represents view information for Lotus Notes database storage. | +| [OutlookViewInfo](../com.groupdocs.viewer.results/outlookviewinfo) | Represents view information for an Outlook Data file. | +| [Page](../com.groupdocs.viewer.results/page) | Represents a single page that can be viewed. | +| [PdfViewInfo](../com.groupdocs.viewer.results/pdfviewinfo) | Represents view information for a PDF document. | +| [ProjectManagementViewInfo](../com.groupdocs.viewer.results/projectmanagementviewinfo) | Represents view information for an MS Project document. | +| [TextElement](../com.groupdocs.viewer.results/textelement) | Represents a generic text element. | +| [ViewInfo](../com.groupdocs.viewer.results/viewinfo) | Represents view information for a generic document. | +| [Word](../com.groupdocs.viewer.results/word) | Represents a relatively positioned rectangle that contains a single word. | diff --git a/english/java/com.groupdocs.viewer.results/archiveviewinfo/_index.md b/english/java/com.groupdocs.viewer.results/archiveviewinfo/_index.md index 6ef76a33e..22ee24dab 100644 --- a/english/java/com.groupdocs.viewer.results/archiveviewinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/archiveviewinfo/_index.md @@ -1,7 +1,7 @@ --- title: ArchiveViewInfo second_title: GroupDocs.Viewer for Java API Reference -description: Represents view information for archive file. +description: Represents view information for an archive file. type: docs weight: 11 url: /java/com.groupdocs.viewer.results/archiveviewinfo/ @@ -12,19 +12,35 @@ url: /java/com.groupdocs.viewer.results/archiveviewinfo/ public interface ArchiveViewInfo extends ViewInfo ``` -Represents view information for archive file. Default implementation is ArchiveViewInfoImpl +Represents view information for an archive file. + +The ArchiveViewInfo interface defines the contract for retrieving view information specific to an archive file in the GroupDocs.Viewer component. It provides methods to access details such as page count, dimensions, and rendering options specific to archive files. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.zip")) { + ArchiveViewInfo viewInfo = (ArchiveViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + + // Use the viewInfo object for further operations + } + +``` + +***Note:** The default implementation of this interface is ArchiveViewInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [getFolders()](#getFolders--) | The folders contained by the archive file. | +| [getFolders()](#getFolders--) | Retrieves the list of folders contained within the archive file. | ### getFolders() {#getFolders--} ``` public abstract List getFolders() ``` -The folders contained by the archive file. +Retrieves the list of folders contained within the archive file. **Returns:** -java.util.List - The folders contained by the archive file. +java.util.List - the list of folders. diff --git a/english/java/com.groupdocs.viewer.results/attachment/_index.md b/english/java/com.groupdocs.viewer.results/attachment/_index.md index 4bfdadd5e..319f18e9d 100644 --- a/english/java/com.groupdocs.viewer.results/attachment/_index.md +++ b/english/java/com.groupdocs.viewer.results/attachment/_index.md @@ -1,7 +1,7 @@ --- title: Attachment second_title: GroupDocs.Viewer for Java API Reference -description: Represents attachment file contained by email message archive PDF document or Outlook data file. +description: Represents an attachment file contained by an email message archive PDF document or Outlook data file. type: docs weight: 12 url: /java/com.groupdocs.viewer.results/attachment/ @@ -9,63 +9,79 @@ url: /java/com.groupdocs.viewer.results/attachment/ public interface Attachment ``` -Represents attachment file contained by email message, archive, PDF document or Outlook data file. Default implementation is [Attachment](../../com.groupdocs.viewer.results/attachment) +Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file. + +The Attachment interface defines the contract for accessing and manipulating attachment files in the GroupDocs.Viewer component. It provides methods to retrieve information such as file name, size, and content type of the attachment. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.eml")) { + List attachments = viewer.getAttachments(); + + // Use the attachments object for further operations + } + +``` + +***Note:** The default implementation of this interface is AttachmentImpl.* ## Methods | Method | Description | | --- | --- | -| [getId()](#getId--) | Unique identifier of the attachment in context of a single file that contains this attachment. | -| [getFileName()](#getFileName--) | Attachment file name. | -| [getFilePath()](#getFilePath--) | Attachment relative path e.g. "folder/file.docx"" or filename when the file is located in the root of an archive, in e-mail message or data file. | -| [getSize()](#getSize--) | Attachment file size in bytes. | -| [getFileType()](#getFileType--) | Attachment file type. | +| [getId()](#getId--) | Retrieves the unique identifier of the attachment within the context of a single file that contains this attachment. | +| [getFileName()](#getFileName--) | Retrieves the file name of the attachment. | +| [getFilePath()](#getFilePath--) | Retrieves the relative path of the attachment. | +| [getSize()](#getSize--) | Retrieves the file size of the attachment in bytes. | +| [getFileType()](#getFileType--) | Retrieves the file type of the attachment. | ### getId() {#getId--} ``` public abstract String getId() ``` -Unique identifier of the attachment in context of a single file that contains this attachment. +Retrieves the unique identifier of the attachment within the context of a single file that contains this attachment. **Returns:** -java.lang.String +java.lang.String - the unique identifier of the attachment. ### getFileName() {#getFileName--} ``` public abstract String getFileName() ``` -Attachment file name. +Retrieves the file name of the attachment. **Returns:** -java.lang.String +java.lang.String - the file name of the attachment. ### getFilePath() {#getFilePath--} ``` public abstract String getFilePath() ``` -Attachment relative path e.g. "folder/file.docx"" or filename when the file is located in the root of an archive, in e-mail message or data file. +Retrieves the relative path of the attachment. The path can be in the format "folder/file.docx" when the file is located within a folder, or it can be the filename when the file is located in the root of an archive, an e-mail message, or a data file. **Returns:** -java.lang.String +java.lang.String - the relative path of the attachment. ### getSize() {#getSize--} ``` public abstract long getSize() ``` -Attachment file size in bytes. +Retrieves the file size of the attachment in bytes. **Returns:** -long +long - the file size of the attachment. ### getFileType() {#getFileType--} ``` public abstract FileType getFileType() ``` -Attachment file type. +Retrieves the file type of the attachment. **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) +[FileType](../../com.groupdocs.viewer/filetype) - the file type of the attachment. diff --git a/english/java/com.groupdocs.viewer.results/cadviewinfo/_index.md b/english/java/com.groupdocs.viewer.results/cadviewinfo/_index.md index e70da0d31..8f5054307 100644 --- a/english/java/com.groupdocs.viewer.results/cadviewinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/cadviewinfo/_index.md @@ -1,7 +1,7 @@ --- title: CadViewInfo second_title: GroupDocs.Viewer for Java API Reference -description: Represents view information for CAD drawing. +description: Represents view information for a CAD drawing. type: docs weight: 13 url: /java/com.groupdocs.viewer.results/cadviewinfo/ @@ -12,30 +12,46 @@ url: /java/com.groupdocs.viewer.results/cadviewinfo/ public interface CadViewInfo extends ViewInfo ``` -Represents view information for CAD drawing. Default implementation is CadViewInfoImpl +Represents view information for a CAD drawing. + +The CadViewInfo interface defines the contract for retrieving view information specific to a CAD drawing in the GroupDocs.Viewer component. It provides methods to access to CAD drawings layers. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.plt")) { + CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + + // Use the viewInfo object for further operations + } + +``` + +***Note:** The default implementation of this interface is CadViewInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [getLayers()](#getLayers--) | The list of layers contained by the CAD drawing. | -| [getLayouts()](#getLayouts--) | The list of layouts contained by the CAD drawing. | +| [getLayers()](#getLayers--) | Retrieves the list of layers in the CAD drawing. | +| [getLayouts()](#getLayouts--) | Retrieves the list of layouts contained within the CAD drawing. | ### getLayers() {#getLayers--} ``` public abstract List getLayers() ``` -The list of layers contained by the CAD drawing. +Retrieves the list of layers in the CAD drawing. **Returns:** -java.util.List +java.util.List - the layers in the CAD drawing. ### getLayouts() {#getLayouts--} ``` public abstract List getLayouts() ``` -The list of layouts contained by the CAD drawing. +Retrieves the list of layouts contained within the CAD drawing. **Returns:** -java.util.List +java.util.List - the layouts in the CAD drawing. diff --git a/english/java/com.groupdocs.viewer.results/character/_index.md b/english/java/com.groupdocs.viewer.results/character/_index.md index b27df7759..3d41a24af 100644 --- a/english/java/com.groupdocs.viewer.results/character/_index.md +++ b/english/java/com.groupdocs.viewer.results/character/_index.md @@ -1,7 +1,7 @@ --- title: Character second_title: GroupDocs.Viewer for Java API Reference -description: Represents relatively positioned rectangle which contains single character. +description: Represents a relatively positioned rectangle that contains a single character. type: docs weight: 14 url: /java/com.groupdocs.viewer.results/character/ @@ -12,4 +12,22 @@ com.groupdocs.viewer.results.TextElement, java.io.Serializable public interface Character extends TextElement, Serializable ``` -Represents relatively positioned rectangle which contains single character. Default implementation is CharacterImpl +Represents a relatively positioned rectangle that contains a single character. + +The Character interface defines the contract for accessing and manipulating a character represented by a rectangle in the GroupDocs.Viewer component. It provides methods to retrieve information such as the character itself, position, and size of the rectangle. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.pdf")) { + PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + List characters = viewInfo.getPages().get(0).getLines().get(0).getWords().get(0).getCharacters(); + Character character = characters.get(0); + + // Use the character object for further operations + } + +``` + +***Note:** The default implementation of this interface is CharacterImpl.* diff --git a/english/java/com.groupdocs.viewer.results/fileinfo/_index.md b/english/java/com.groupdocs.viewer.results/fileinfo/_index.md index c74088a52..01a12869c 100644 --- a/english/java/com.groupdocs.viewer.results/fileinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/fileinfo/_index.md @@ -1,7 +1,7 @@ --- title: FileInfo second_title: GroupDocs.Viewer for Java API Reference -description: Contains information about file. +description: Contains information about a file. type: docs weight: 15 url: /java/com.groupdocs.viewer.results/fileinfo/ @@ -9,44 +9,60 @@ url: /java/com.groupdocs.viewer.results/fileinfo/ public interface FileInfo ``` -Contains information about file. Default implementation is FileInfoImpl +Contains information about a file. + +The FileInfo interface defines the contract for accessing and retrieving information about a file in the GroupDocs.Viewer component. It provides methods to retrieve details such as the file type, encryption and so on. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.pdf")) { + FileInfo fileInfo = viewer.getFileInfo(); + + // Use the fileInfo object for further operations + } + +``` + +***Note:** The default implementation of this interface is FileInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [getFileType()](#getFileType--) | The type of the file. | -| [isEncrypted()](#isEncrypted--) | Indicates that file is encrypted. | -| [setEncrypted(boolean encrypted)](#setEncrypted-boolean-) | Indicates that file is encrypted. | +| [getFileType()](#getFileType--) | Retrieves the type of the file. | +| [isEncrypted()](#isEncrypted--) | Checks if the file is encrypted. | +| [setEncrypted(boolean encrypted)](#setEncrypted-boolean-) | Sets the encryption status of the file. | ### getFileType() {#getFileType--} ``` public abstract FileType getFileType() ``` -The type of the file. +Retrieves the type of the file. **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) +[FileType](../../com.groupdocs.viewer/filetype) - the file type. ### isEncrypted() {#isEncrypted--} ``` public abstract boolean isEncrypted() ``` -Indicates that file is encrypted. +Checks if the file is encrypted. **Returns:** -boolean +boolean - true if the file is encrypted, false otherwise. ### setEncrypted(boolean encrypted) {#setEncrypted-boolean-} ``` public abstract void setEncrypted(boolean encrypted) ``` -Indicates that file is encrypted. +Sets the encryption status of the file. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| encrypted | boolean | | +| encrypted | boolean | true to indicate that the file is encrypted, false otherwise. | diff --git a/english/java/com.groupdocs.viewer.results/layer/_index.md b/english/java/com.groupdocs.viewer.results/layer/_index.md index 0e3362d86..77d6efba3 100644 --- a/english/java/com.groupdocs.viewer.results/layer/_index.md +++ b/english/java/com.groupdocs.viewer.results/layer/_index.md @@ -1,7 +1,7 @@ --- title: Layer second_title: GroupDocs.Viewer for Java API Reference -description: Represents layer contained by the CAD drawing. +description: Represents a layer contained by a CAD drawing. type: docs weight: 16 url: /java/com.groupdocs.viewer.results/layer/ @@ -12,46 +12,68 @@ java.io.Serializable public interface Layer extends Serializable ``` -Represents layer contained by the CAD drawing. Default implementation is LayerImpl +Represents a layer contained by a CAD drawing. + +The Layer interface defines the contract for accessing and manipulating a layer within a CAD drawing in the GroupDocs.Viewer component. It provides methods to retrieve information such as the layer name, visibility, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.mpt")) { + CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + List layers = viewInfo.getLayers(); + for (Layer layer : layers) { + // Use the layer object for further operations + } + } + +``` + +***Note:** The default implementation of this interface is LayerImpl.* ## Methods | Method | Description | | --- | --- | -| [getName()](#getName--) | The name of the layer. | -| [isVisible()](#isVisible--) | The layer visibility indicator. | -| [equals(Object other)](#equals-java.lang.Object-) | Checks equality | +| [getName()](#getName--) | Retrieves the name of the layer. | +| [isVisible()](#isVisible--) | Checks the visibility of the layer. | +| [equals(Object other)](#equals-java.lang.Object-) | Checks if this object is equal to the provided object. | ### getName() {#getName--} ``` public abstract String getName() ``` -The name of the layer. Layer names are case sensitive. +Retrieves the name of the layer. + +**Note:** Layer names are case sensitive. **Returns:** -java.lang.String +java.lang.String - the name of the layer. ### isVisible() {#isVisible--} ``` public abstract boolean isVisible() ``` -The layer visibility indicator. The CAD drawing layers that are switched off or frozen are invisible. To render layers that are invisible, use [CadOptions.setLayers(List)](../../com.groupdocs.viewer.options/cadoptions\#setLayers-List-) option. +Checks the visibility of the layer. + +The CAD drawing layers that are switched off or frozen are invisible. To render layers that are invisible, use the [CadOptions.setLayers(List)](../../com.groupdocs.viewer.options/cadoptions\#setLayers-List-) option. **Returns:** -boolean +boolean - true if the layer is visible, false otherwise. ### equals(Object other) {#equals-java.lang.Object-} ``` public abstract boolean equals(Object other) ``` -Checks equality +Checks if this object is equal to the provided object. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| other | java.lang.Object | object to compare | +| other | java.lang.Object | The object to compare. | **Returns:** -boolean - true if equal, otherwise false +boolean - true if the objects are equal, false otherwise. diff --git a/english/java/com.groupdocs.viewer.results/layout/_index.md b/english/java/com.groupdocs.viewer.results/layout/_index.md index 5e2286136..4e3ca79cc 100644 --- a/english/java/com.groupdocs.viewer.results/layout/_index.md +++ b/english/java/com.groupdocs.viewer.results/layout/_index.md @@ -1,7 +1,7 @@ --- title: Layout second_title: GroupDocs.Viewer for Java API Reference -description: Represents layout contained by the CAD drawing. +description: Represents a layout contained by a CAD drawing. type: docs weight: 17 url: /java/com.groupdocs.viewer.results/layout/ @@ -12,57 +12,75 @@ java.io.Serializable public interface Layout extends Serializable ``` -Represents layout contained by the CAD drawing. Default implementation is LayoutImpl +Represents a layout contained by a CAD drawing. + +The Layout interface defines the contract for accessing and manipulating a layout within a CAD drawing in the GroupDocs.Viewer component. It provides methods to retrieve information such as the layout name, dimensions, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.mpt")) { + CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + List layouts = viewInfo.getLayouts(); + for (Layout layout : layouts) { + // Use the layout object for further operations + } + } + +``` + +***Note:** The default implementation of this interface is LayoutImpl.* ## Methods | Method | Description | | --- | --- | -| [getName()](#getName--) | The name of the layout. | -| [getWidth()](#getWidth--) | The width of the layout. | -| [getHeight()](#getHeight--) | The height of the layout. | -| [equals(Object other)](#equals-java.lang.Object-) | Checks equality | +| [getName()](#getName--) | Retrieves the name of the layout. | +| [getWidth()](#getWidth--) | Retrieves the width of the layout. | +| [getHeight()](#getHeight--) | Retrieves the height of the layout. | +| [equals(Object other)](#equals-java.lang.Object-) | Checks if this object is equal to the provided object. | ### getName() {#getName--} ``` public abstract String getName() ``` -The name of the layout. +Retrieves the name of the layout. **Returns:** -java.lang.String +java.lang.String - the name of the layout. ### getWidth() {#getWidth--} ``` public abstract double getWidth() ``` -The width of the layout. +Retrieves the width of the layout. **Returns:** -double +double - the width of the layout. ### getHeight() {#getHeight--} ``` public abstract double getHeight() ``` -The height of the layout. +Retrieves the height of the layout. **Returns:** -double +double - the height of the layout. ### equals(Object other) {#equals-java.lang.Object-} ``` public abstract boolean equals(Object other) ``` -Checks equality +Checks if this object is equal to the provided object. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| other | java.lang.Object | object to compare | +| other | java.lang.Object | The object to compare. | **Returns:** -boolean - true if equal, otherwise false +boolean - true if the objects are equal, false otherwise. diff --git a/english/java/com.groupdocs.viewer.results/line/_index.md b/english/java/com.groupdocs.viewer.results/line/_index.md index e412681c5..85fe9ba19 100644 --- a/english/java/com.groupdocs.viewer.results/line/_index.md +++ b/english/java/com.groupdocs.viewer.results/line/_index.md @@ -1,7 +1,7 @@ --- title: Line second_title: GroupDocs.Viewer for Java API Reference -description: Represents relatively positioned rectangle which contains single line. +description: Represents a relatively positioned rectangle that contains a single line. type: docs weight: 18 url: /java/com.groupdocs.viewer.results/line/ @@ -12,19 +12,37 @@ com.groupdocs.viewer.results.TextElement, java.io.Serializable public interface Line extends TextElement, Serializable ``` -Represents relatively positioned rectangle which contains single line. Default implementation is LineImpl +Represents a relatively positioned rectangle that contains a single line. + +The Line interface defines the contract for accessing and manipulating a line represented by a rectangle in the GroupDocs.Viewer component. It provides methods to retrieve information such as the line text, position, and size of the rectangle. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.pdf")) { + PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + List lines = viewInfo.getPages().get(0).getLines(); + for (Line line : lines) { + // Use the line object for further operations + } + } + +``` + +***Note:** The default implementation of this interface is LineImpl.* ## Methods | Method | Description | | --- | --- | -| [getWords()](#getWords--) | The words contained by the line. | +| [getWords()](#getWords--) | Retrieves the words contained in the line. | ### getWords() {#getWords--} ``` public abstract List getWords() ``` -The words contained by the line. +Retrieves the words contained in the line. **Returns:** -java.util.List - The words contained by the line. +java.util.List - the words contained in the line. diff --git a/english/java/com.groupdocs.viewer.results/lotusnotesviewinfo/_index.md b/english/java/com.groupdocs.viewer.results/lotusnotesviewinfo/_index.md index 5b7ab86d3..e0195fdc3 100644 --- a/english/java/com.groupdocs.viewer.results/lotusnotesviewinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/lotusnotesviewinfo/_index.md @@ -1,7 +1,7 @@ --- title: LotusNotesViewInfo second_title: GroupDocs.Viewer for Java API Reference -description: Represents view information for Lotus notes database storage Default implementation is LotusNotesViewInfoImpl +description: Represents view information for Lotus Notes database storage. type: docs weight: 19 url: /java/com.groupdocs.viewer.results/lotusnotesviewinfo/ @@ -12,19 +12,34 @@ url: /java/com.groupdocs.viewer.results/lotusnotesviewinfo/ public interface LotusNotesViewInfo extends ViewInfo ``` -Represents view information for Lotus notes database storage Default implementation is LotusNotesViewInfoImpl +Represents view information for Lotus Notes database storage. + +The LotusNotesViewInfo interface defines the contract for accessing and manipulating view information for Lotus Notes database storage in the GroupDocs.Viewer component. It provides methods to retrieve information such as notes count, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.nsf")) { + final LotusNotesViewInfo viewInfo = (LotusNotesViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + // Use the viewInfo object for further operations + } + +``` + +***Note:** The default implementation of this interface is LotusNotesViewInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [getNotesCount()](#getNotesCount--) | Notes count in storage | +| [getNotesCount()](#getNotesCount--) | Retrieves the count of notes in the storage. | ### getNotesCount() {#getNotesCount--} ``` public abstract int getNotesCount() ``` -Notes count in storage +Retrieves the count of notes in the storage. **Returns:** -int +int - the count of notes in the storage. diff --git a/english/java/com.groupdocs.viewer.results/outlookviewinfo/_index.md b/english/java/com.groupdocs.viewer.results/outlookviewinfo/_index.md index 13ee4f1ab..70795285e 100644 --- a/english/java/com.groupdocs.viewer.results/outlookviewinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/outlookviewinfo/_index.md @@ -1,7 +1,7 @@ --- title: OutlookViewInfo second_title: GroupDocs.Viewer for Java API Reference -description: Represents view information for Outlook Data file. +description: Represents view information for an Outlook Data file. type: docs weight: 20 url: /java/com.groupdocs.viewer.results/outlookviewinfo/ @@ -12,19 +12,34 @@ url: /java/com.groupdocs.viewer.results/outlookviewinfo/ public interface OutlookViewInfo extends ViewInfo ``` -Represents view information for Outlook Data file. Default implementation is OutlookViewInfoImpl +Represents view information for an Outlook Data file. + +The OutlookViewInfo interface defines the contract for accessing and manipulating view information for an Outlook Data file in the GroupDocs.Viewer component. It provides methods to retrieve information such as a list of folders, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.pst")) { + final OutlookViewInfo viewInfo = (OutlookViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + // Use the viewInfo object for further operations + } + +``` + +***Note:** The default implementation of this interface is OutlookViewInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [getFolders()](#getFolders--) | The list of folders contained by the Outlook Data file. | +| [getFolders()](#getFolders--) | Retrieves the list of folders contained in the Outlook Data file. | ### getFolders() {#getFolders--} ``` public abstract List getFolders() ``` -The list of folders contained by the Outlook Data file. +Retrieves the list of folders contained in the Outlook Data file. **Returns:** -java.util.List +java.util.List - the list of folders. diff --git a/english/java/com.groupdocs.viewer.results/page/_index.md b/english/java/com.groupdocs.viewer.results/page/_index.md index d3f3a253e..38c2f47ac 100644 --- a/english/java/com.groupdocs.viewer.results/page/_index.md +++ b/english/java/com.groupdocs.viewer.results/page/_index.md @@ -1,7 +1,7 @@ --- title: Page second_title: GroupDocs.Viewer for Java API Reference -description: Represents single page that can be viewed. +description: Represents a single page that can be viewed. type: docs weight: 21 url: /java/com.groupdocs.viewer.results/page/ @@ -12,74 +12,92 @@ java.io.Serializable public interface Page extends Serializable ``` -Represents single page that can be viewed. Default implementation is PageImpl +Represents a single page that can be viewed. + +The Page interface defines the contract for accessing and manipulating a single page that can be viewed in the GroupDocs.Viewer component. It provides methods to retrieve information such as the page number, size, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.pst")) { + final OutlookViewInfo viewInfo = (OutlookViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + List pages = viewInfo.getPages(); + for (Page page : pages) { + // Use the page object for further operations + } + } + +``` + +***Note:** The default implementation of this interface is PageImpl.* ## Methods | Method | Description | | --- | --- | -| [getName()](#getName--) | The worksheet or page name. | -| [getNumber()](#getNumber--) | The page number. | -| [isVisible()](#isVisible--) | The page visibility indicator. | -| [getWidth()](#getWidth--) | The width of the page in pixels when viewing as JPG or PNG. | -| [getHeight()](#getHeight--) | The height of the page in pixels when viewing as JPG or PNG. | -| [getLines()](#getLines--) | The lines contained by the page when viewing as JPG or PNG with enabled Text Extraction. | +| [getName()](#getName--) | Retrieves the name of the worksheet or page. | +| [getNumber()](#getNumber--) | Retrieves the page number. | +| [isVisible()](#isVisible--) | Retrieves the page visibility indicator. | +| [getWidth()](#getWidth--) | Retrieves the width of the page in pixels when viewing as JPG or PNG. | +| [getHeight()](#getHeight--) | Retrieves the height of the page in pixels when viewing as JPG or PNG. | +| [getLines()](#getLines--) | Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction. | ### getName() {#getName--} ``` public abstract String getName() ``` -The worksheet or page name. +Retrieves the name of the worksheet or page. **Returns:** -java.lang.String +java.lang.String - the name of the worksheet or page. ### getNumber() {#getNumber--} ``` public abstract int getNumber() ``` -The page number. +Retrieves the page number. **Returns:** -int +int - the page number. ### isVisible() {#isVisible--} ``` public abstract boolean isVisible() ``` -The page visibility indicator. +Retrieves the page visibility indicator. **Returns:** -boolean +boolean - the page visibility indicator. ### getWidth() {#getWidth--} ``` public abstract int getWidth() ``` -The width of the page in pixels when viewing as JPG or PNG. +Retrieves the width of the page in pixels when viewing as JPG or PNG. **Returns:** -int +int - the width of the page. ### getHeight() {#getHeight--} ``` public abstract int getHeight() ``` -The height of the page in pixels when viewing as JPG or PNG. +Retrieves the height of the page in pixels when viewing as JPG or PNG. **Returns:** -int +int - the height of the page. ### getLines() {#getLines--} ``` public abstract List getLines() ``` -The lines contained by the page when viewing as JPG or PNG with enabled Text Extraction. +Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction. **Returns:** -java.util.List +java.util.List - the lines contained in the page. diff --git a/english/java/com.groupdocs.viewer.results/pdfviewinfo/_index.md b/english/java/com.groupdocs.viewer.results/pdfviewinfo/_index.md index fb5691412..89e52b79c 100644 --- a/english/java/com.groupdocs.viewer.results/pdfviewinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/pdfviewinfo/_index.md @@ -1,7 +1,7 @@ --- title: PdfViewInfo second_title: GroupDocs.Viewer for Java API Reference -description: Represents view information for PDF document. +description: Represents view information for a PDF document. type: docs weight: 22 url: /java/com.groupdocs.viewer.results/pdfviewinfo/ @@ -12,19 +12,34 @@ url: /java/com.groupdocs.viewer.results/pdfviewinfo/ public interface PdfViewInfo extends ViewInfo ``` -Represents view information for PDF document. Default implementation is PdfViewInfoImpl +Represents view information for a PDF document. + +The PdfViewInfo interface defines the contract for accessing and manipulating view information for a PDF document in the GroupDocs.Viewer component. It provides methods to retrieve information such as allowing printing, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.pdf")) { + final PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forPngView()); + // Use the viewInfo object for further operations + } + +``` + +***Note:** The default implementation of this interface is PdfViewInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [isPrintingAllowed()](#isPrintingAllowed--) | Indicates if printing of the document is allowed. | +| [isPrintingAllowed()](#isPrintingAllowed--) | Checks if printing of the document is allowed. | ### isPrintingAllowed() {#isPrintingAllowed--} ``` public abstract boolean isPrintingAllowed() ``` -Indicates if printing of the document is allowed. +Checks if printing of the document is allowed. **Returns:** -boolean +boolean - true if printing is allowed, false otherwise. diff --git a/english/java/com.groupdocs.viewer.results/projectmanagementviewinfo/_index.md b/english/java/com.groupdocs.viewer.results/projectmanagementviewinfo/_index.md index 7fc14d1e1..1ad889735 100644 --- a/english/java/com.groupdocs.viewer.results/projectmanagementviewinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/projectmanagementviewinfo/_index.md @@ -1,7 +1,7 @@ --- title: ProjectManagementViewInfo second_title: GroupDocs.Viewer for Java API Reference -description: Represents view information for MS Project document. +description: Represents view information for an MS Project document. type: docs weight: 23 url: /java/com.groupdocs.viewer.results/projectmanagementviewinfo/ @@ -12,30 +12,45 @@ url: /java/com.groupdocs.viewer.results/projectmanagementviewinfo/ public interface ProjectManagementViewInfo extends ViewInfo ``` -Represents view information for MS Project document. Default implementation is ProjectManagementViewInfoImpl +Represents view information for an MS Project document. + +The ProjectManagementViewInfo interface defines the contract for accessing and manipulating view information for an MS Project document in the GroupDocs.Viewer component. It provides methods to retrieve information such as the start and end dates, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.mpp")) { + final ProjectManagementViewInfo viewInfo = (ProjectManagementViewInfo) viewer.getViewInfo(ViewInfoOptions.forPngView()); + // Use the viewInfo object for further operations + } + +``` + +***Note:** The default implementation of this interface is ProjectManagementViewInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [getStartDate()](#getStartDate--) | The date time from which the project started. | -| [getEndDate()](#getEndDate--) | The date time when the project is to be completed. | +| [getStartDate()](#getStartDate--) | Retrieves the date and time from which the project started. | +| [getEndDate()](#getEndDate--) | Retrieves the date and time when the project is to be completed. | ### getStartDate() {#getStartDate--} ``` public abstract Date getStartDate() ``` -The date time from which the project started. +Retrieves the date and time from which the project started. **Returns:** -java.util.Date +java.util.Date - the start date and time of the project. ### getEndDate() {#getEndDate--} ``` public abstract Date getEndDate() ``` -The date time when the project is to be completed. +Retrieves the date and time when the project is to be completed. **Returns:** -java.util.Date +java.util.Date - the end date and time of the project. diff --git a/english/java/com.groupdocs.viewer.results/resource/_index.md b/english/java/com.groupdocs.viewer.results/resource/_index.md index 497a381e5..37e2f56e9 100644 --- a/english/java/com.groupdocs.viewer.results/resource/_index.md +++ b/english/java/com.groupdocs.viewer.results/resource/_index.md @@ -16,17 +16,36 @@ public class Resource implements Serializable ``` Represents HTML resource such as font, style, image or graphics. + +The Resource class represents a resource used in HTML rendering in the GroupDocs.Viewer component. It can represent various types of resources, such as fonts, styles, images, or graphics, that are included or referenced in the generated HTML output during the rendering process. + +Example usage: + +``` + + final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(pageNumber -> , new ReleaseResourceStream() { + @Override + public void invoke(int pageNumber, Resource resource, OutputStream resourceStream) { + // Handle resource + } + }); + try (Viewer viewer = new Viewer("document.pdf")) { + viewer.view(htmlViewOptions); + // Use the viewer object for further operations + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [Resource(String fileName, boolean nested)](#Resource-java.lang.String-boolean-) | Creates new instance of [Resource](../../com.groupdocs.viewer.results/resource) class. | +| [Resource(String fileName, boolean nested)](#Resource-java.lang.String-boolean-) | Creates a new instance of the Resource class. | ## Methods | Method | Description | | --- | --- | -| [getFileName()](#getFileName--) | The resource file name. | -| [isNested()](#isNested--) | Indicates whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource. | +| [getFileName()](#getFileName--) | Returns the file name of the resource. | +| [isNested()](#isNested--) | Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource. | | [toString()](#toString--) | Returns a string that represents the current object. | ### Resource(String fileName, boolean nested) {#Resource-java.lang.String-boolean-} ``` @@ -34,13 +53,13 @@ public Resource(String fileName, boolean nested) ``` -Creates new instance of [Resource](../../com.groupdocs.viewer.results/resource) class. +Creates a new instance of the Resource class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileName | java.lang.String | Resource file name. | -| nested | boolean | Indicates whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource. | +| fileName | java.lang.String | The resource file name. | +| nested | boolean | Indicates whether the resource resides inside another resource, e.g., a font resource that resides in a CSS or SVG resource. | ### getFileName() {#getFileName--} ``` @@ -48,20 +67,20 @@ public final String getFileName() ``` -The resource file name. +Returns the file name of the resource. **Returns:** -java.lang.String - The resource file name. +java.lang.String - the file name of the resource. ### isNested() {#isNested--} ``` public final boolean isNested() ``` -Indicates whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource. +Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource. **Returns:** -boolean - whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource. +boolean - Whether the resource resides inside another resource. ### toString() {#toString--} ``` public String toString() @@ -71,4 +90,4 @@ public String toString() Returns a string that represents the current object. **Returns:** -java.lang.String - A string that represents the current object. +java.lang.String - the string representation of the current object. diff --git a/english/java/com.groupdocs.viewer.results/textelement/_index.md b/english/java/com.groupdocs.viewer.results/textelement/_index.md index 21f542e64..167c9e151 100644 --- a/english/java/com.groupdocs.viewer.results/textelement/_index.md +++ b/english/java/com.groupdocs.viewer.results/textelement/_index.md @@ -1,7 +1,7 @@ --- title: TextElement second_title: GroupDocs.Viewer for Java API Reference -description: Represents generic text element. +description: Represents a generic text element. type: docs weight: 24 url: /java/com.groupdocs.viewer.results/textelement/ @@ -9,65 +9,67 @@ url: /java/com.groupdocs.viewer.results/textelement/ public interface TextElement ``` -Represents generic text element. +Represents a generic text element. -Default implementation is TextElementImpl +The TextElement interface defines the contract for a generic text element in the GroupDocs.Viewer component. It represents a text element with a specific type and provides methods to access and manipulate the text content. + +***Note:** The default implementation of this interface is TextElementImpl.* ## Methods | Method | Description | | --- | --- | -| [getValue()](#getValue--) | The element value. | -| [getX()](#getX--) | The X coordinate of the highest left point on the page layout where the rectangle that contains element begins. | -| [getY()](#getY--) | The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins. | -| [getWidth()](#getWidth--) | The width of the rectangle which contains the element (in pixels). | -| [getHeight()](#getHeight--) | The height of the rectangle which contains the element (in pixels). | +| [getValue()](#getValue--) | Retrieves the value of the text element. | +| [getX()](#getX--) | Retrieves the X coordinate of the highest left point on the page layout where the rectangle that contains the element begins. | +| [getY()](#getY--) | Retrieves the Y coordinate of the highest left point on the page layout where the rectangle that contains the element begins. | +| [getWidth()](#getWidth--) | Retrieves the width of the rectangle that contains the element (in pixels). | +| [getHeight()](#getHeight--) | Retrieves the height of the rectangle that contains the element (in pixels). | ### getValue() {#getValue--} ``` public abstract T getValue() ``` -The element value. +Retrieves the value of the text element. **Returns:** -T +T - the value of the text element. ### getX() {#getX--} ``` public abstract double getX() ``` -The X coordinate of the highest left point on the page layout where the rectangle that contains element begins. +Retrieves the X coordinate of the highest left point on the page layout where the rectangle that contains the element begins. **Returns:** -double +double - the X coordinate of the starting point. ### getY() {#getY--} ``` public abstract double getY() ``` -The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins. +Retrieves the Y coordinate of the highest left point on the page layout where the rectangle that contains the element begins. **Returns:** -double +double - the Y coordinate of the starting point. ### getWidth() {#getWidth--} ``` public abstract double getWidth() ``` -The width of the rectangle which contains the element (in pixels). +Retrieves the width of the rectangle that contains the element (in pixels). **Returns:** -double +double - the width of the rectangle. ### getHeight() {#getHeight--} ``` public abstract double getHeight() ``` -The height of the rectangle which contains the element (in pixels). +Retrieves the height of the rectangle that contains the element (in pixels). **Returns:** -double +double - the height of the rectangle. diff --git a/english/java/com.groupdocs.viewer.results/viewinfo/_index.md b/english/java/com.groupdocs.viewer.results/viewinfo/_index.md index b6058403b..a9df066bf 100644 --- a/english/java/com.groupdocs.viewer.results/viewinfo/_index.md +++ b/english/java/com.groupdocs.viewer.results/viewinfo/_index.md @@ -1,7 +1,7 @@ --- title: ViewInfo second_title: GroupDocs.Viewer for Java API Reference -description: Represents view information for generic document. +description: Represents view information for a generic document. type: docs weight: 25 url: /java/com.groupdocs.viewer.results/viewinfo/ @@ -9,30 +9,49 @@ url: /java/com.groupdocs.viewer.results/viewinfo/ public interface ViewInfo ``` -Represents view information for generic document. Default implementation is ViewInfoImpl +Represents view information for a generic document. + +The ViewInfo interface defines the contract for accessing and manipulating view information for a generic document in the GroupDocs.Viewer component. It provides methods to retrieve information such as the file type, pages, and other properties. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.mpp")) { + final ViewInfo viewInfo = viewer.getViewInfo(ViewInfoOptions.forPngView()); + if (viewInfo instanceof ProjectManagementViewInfo) { + ProjectManagementViewInfo projectManagementViewInfo = (ProjectManagementViewInfo) viewInfo; + // Use the projectManagementViewInfo object for further operations + } + // ... + } + +``` + +***Note:** The default implementation of this interface is ViewInfoImpl.* ## Methods | Method | Description | | --- | --- | -| [getFileType()](#getFileType--) | The type of the file. | -| [getPages()](#getPages--) | The list of pages to view. | +| [getFileType()](#getFileType--) | Retrieves the type of the file. | +| [getPages()](#getPages--) | Retrieves the list of pages to view. | ### getFileType() {#getFileType--} ``` public abstract FileType getFileType() ``` -The type of the file. +Retrieves the type of the file. **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) +[FileType](../../com.groupdocs.viewer/filetype) - the file type. ### getPages() {#getPages--} ``` public abstract List getPages() ``` -The list of pages to view. +Retrieves the list of pages to view. **Returns:** -java.util.List +java.util.List - the list of pages. diff --git a/english/java/com.groupdocs.viewer.results/word/_index.md b/english/java/com.groupdocs.viewer.results/word/_index.md index e04510784..957d08010 100644 --- a/english/java/com.groupdocs.viewer.results/word/_index.md +++ b/english/java/com.groupdocs.viewer.results/word/_index.md @@ -1,7 +1,7 @@ --- title: Word second_title: GroupDocs.Viewer for Java API Reference -description: Represents relatively positioned rectangle which contains single word. +description: Represents a relatively positioned rectangle that contains a single word. type: docs weight: 26 url: /java/com.groupdocs.viewer.results/word/ @@ -12,19 +12,37 @@ com.groupdocs.viewer.results.TextElement, java.io.Serializable public interface Word extends TextElement, Serializable ``` -Represents relatively positioned rectangle which contains single word. Default implementation is WordImpl +Represents a relatively positioned rectangle that contains a single word. + +The Word interface represents a word within a relatively positioned rectangle in the GroupDocs.Viewer component. It extends the TextElement interface and provides additional methods to access and manipulate the word content. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("document.pdf")) { + PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView()); + List words = viewInfo.getPages().get(0).getLines().get(0).getWords(); + for (Word word : words) { + // Use the word object for further operations + } + } + +``` + +***Note:** The default implementation of this interface is WordImpl.* ## Methods | Method | Description | | --- | --- | -| [getCharacters()](#getCharacters--) | The characters contained by the word. | +| [getCharacters()](#getCharacters--) | Retrieves the characters contained by the word. | ### getCharacters() {#getCharacters--} ``` public abstract List getCharacters() ``` -The characters contained by the word. +Retrieves the characters contained by the word. **Returns:** -java.util.List +java.util.List - the list of characters. diff --git a/english/java/com.groupdocs.viewer.utils/_index.md b/english/java/com.groupdocs.viewer.utils/_index.md index 3c3908431..601b548d2 100644 --- a/english/java/com.groupdocs.viewer.utils/_index.md +++ b/english/java/com.groupdocs.viewer.utils/_index.md @@ -1,18 +1,30 @@ --- title: com.groupdocs.viewer.utils second_title: GroupDocs.Viewer for Java API Reference -description: The package provides helpers and utils classes. +description: The package provides helper and utility classes for various functionalities. type: docs weight: 19 url: /java/com.groupdocs.viewer.utils/ --- -The package provides helpers and utils classes. +The package provides helper and utility classes for various functionalities. + +These classes offer convenient methods and functionalities to assist in different operations. + +The main classes in this package are: + + * [MemoryCleaner](../../com.groupdocs.viewer.utils/memorycleaner) - Provides methods to clean up resources and free memory. + * [PathUtils](../../com.groupdocs.viewer.utils/pathutils) - Represents the type for working with paths. + +For more details on using the utility classes in the com.groupdocs.viewer.utils package, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Classes | Class | Description | | --- | --- | -| [MemoryCleaner](../com.groupdocs.viewer.utils/memorycleaner) | Cleanes different resources to free memory | -| [PathUtils](../com.groupdocs.viewer.utils/pathutils) | The type Path. | +| [MemoryCleaner](../com.groupdocs.viewer.utils/memorycleaner) | Cleans different resources to free memory. | +| [PathUtils](../com.groupdocs.viewer.utils/pathutils) | The PathUtils class provides utility methods for working with file paths. | diff --git a/english/java/com.groupdocs.viewer.utils/memorycleaner/_index.md b/english/java/com.groupdocs.viewer.utils/memorycleaner/_index.md index 7e4babd9d..4c9529781 100644 --- a/english/java/com.groupdocs.viewer.utils/memorycleaner/_index.md +++ b/english/java/com.groupdocs.viewer.utils/memorycleaner/_index.md @@ -1,7 +1,7 @@ --- title: MemoryCleaner second_title: GroupDocs.Viewer for Java API Reference -description: Cleanes different resources to free memory +description: Cleans different resources to free memory. type: docs weight: 10 url: /java/com.groupdocs.viewer.utils/memorycleaner/ @@ -12,7 +12,33 @@ java.lang.Object public final class MemoryCleaner ``` -Cleanes different resources to free memory +Cleans different resources to free memory. + +This class provides methods to clear heap memory, delete temp files, and clear font registry information. It also includes a method to safely clear thread-local instances for the current thread. + +Example usage: + +``` + + // Clean heap memory, keeping font settings + MemoryCleaner.clearKeepingFontSettings(); + + // Clean heap memory and delete temp files + MemoryCleaner.clear(); + + // Clean heap memory from static PDF instances + MemoryCleaner.clearStaticInstances(); + + // Delete all temp files created by PDF in the system temp directory + MemoryCleaner.clearAllTempFiles(); + + // Clear font registry information from heap memory + MemoryCleaner.clearFontRegistry(); + + // Safely clear thread-local instances for the current thread + MemoryCleaner.clearCurrentThreadLocals(); + +``` ## Constructors | Constructor | Description | @@ -22,12 +48,12 @@ Cleanes different resources to free memory | Method | Description | | --- | --- | -| [clearKeepingFontSettings()](#clearKeepingFontSettings--) | Clears Heap memory from static PDF instances (static and threadLocal) and deletes all temp files. | -| [clear()](#clear--) | Clears Heap memory from static PDF instances (static and threadLocal) and deletes all temp files. | -| [clearStaticInstances()](#clearStaticInstances--) | Clears Heap memory from static PDF instances. | -| [clearAllTempFiles()](#clearAllTempFiles--) | Clears temp files, created by PDF in system temp directory. | -| [clearFontRegistry()](#clearFontRegistry--) | Clears FontRegistry information from the Heap memory. | -| [clearCurrentThreadLocals()](#clearCurrentThreadLocals--) | Safely clears Heap memory from ThreadLocal instances for current thread | +| [clearKeepingFontSettings()](#clearKeepingFontSettings--) | Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files. | +| [clear()](#clear--) | Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files. | +| [clearStaticInstances()](#clearStaticInstances--) | Clears heap memory from static PDF instances. | +| [clearAllTempFiles()](#clearAllTempFiles--) | Clears temp files created by GroupDocs.Viewer in the system temp directory. | +| [clearFontRegistry()](#clearFontRegistry--) | Clears font registry information from heap memory. | +| [clearCurrentThreadLocals()](#clearCurrentThreadLocals--) | Safely clears heap memory from thread-local instances for the current thread. | ### MemoryCleaner() {#MemoryCleaner--} ``` public MemoryCleaner() @@ -40,7 +66,7 @@ public static void clearKeepingFontSettings() ``` -Clears Heap memory from static PDF instances (static and threadLocal) and deletes all temp files. +Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files. This method does not affect font settings. ### clear() {#clear--} ``` @@ -48,7 +74,7 @@ public static void clear() ``` -Clears Heap memory from static PDF instances (static and threadLocal) and deletes all temp files. +Clears heap memory from static PDF instances (static and threadLocal) and deletes all temp files. ### clearStaticInstances() {#clearStaticInstances--} ``` @@ -56,7 +82,7 @@ public static void clearStaticInstances() ``` -Clears Heap memory from static PDF instances. +Clears heap memory from static PDF instances. ### clearAllTempFiles() {#clearAllTempFiles--} ``` @@ -64,7 +90,7 @@ public static void clearAllTempFiles() ``` -Clears temp files, created by PDF in system temp directory. +Clears temp files created by GroupDocs.Viewer in the system temp directory. ### clearFontRegistry() {#clearFontRegistry--} ``` @@ -72,7 +98,7 @@ public static void clearFontRegistry() ``` -Clears FontRegistry information from the Heap memory. +Clears font registry information from heap memory. ### clearCurrentThreadLocals() {#clearCurrentThreadLocals--} ``` @@ -80,5 +106,5 @@ public static void clearCurrentThreadLocals() ``` -Safely clears Heap memory from ThreadLocal instances for current thread +Safely clears heap memory from thread-local instances for the current thread. diff --git a/english/java/com.groupdocs.viewer.utils/pathutils/_index.md b/english/java/com.groupdocs.viewer.utils/pathutils/_index.md index d5ab789c9..f01087c2a 100644 --- a/english/java/com.groupdocs.viewer.utils/pathutils/_index.md +++ b/english/java/com.groupdocs.viewer.utils/pathutils/_index.md @@ -1,7 +1,7 @@ --- title: PathUtils second_title: GroupDocs.Viewer for Java API Reference -description: The type Path. +description: The PathUtils class provides utility methods for working with file paths. type: docs weight: 11 url: /java/com.groupdocs.viewer.utils/pathutils/ @@ -12,7 +12,18 @@ java.lang.Object public class PathUtils ``` -The type Path. +The PathUtils class provides utility methods for working with file paths. + +The PathUtils class contains static methods that allow you to perform various operations on file paths in the GroupDocs.Viewer component. + +Example usage: + +``` + + String combinedPath = PathUtils.combine("part", "of", "path"); + String fileName = PathUtils.getFileName("/path/to/file.txt"); + +``` ## Methods | Method | Description | diff --git a/english/java/com.groupdocs.viewer/_index.md b/english/java/com.groupdocs.viewer/_index.md index 689697e4e..9a34fb1a5 100644 --- a/english/java/com.groupdocs.viewer/_index.md +++ b/english/java/com.groupdocs.viewer/_index.md @@ -1,26 +1,37 @@ --- title: com.groupdocs.viewer second_title: GroupDocs.Viewer for Java API Reference -description: The package provides classes for rendering documents in HTML5 Image or PDF modes fast and with high quality. +description: The package provides classes for rendering documents in HTML5 Image or PDF modes with fast and high-quality results. type: docs weight: 10 url: /java/com.groupdocs.viewer/ --- -The package provides classes for rendering documents in HTML5, Image or PDF modes fast and with high quality. +The package provides classes for rendering documents in HTML5, Image, or PDF modes with fast and high-quality results. + +The main classes in this package are: + + * [License](../../com.groupdocs.viewer/license) - Provides methods for licensing Viewer. + * [Viewer](../../com.groupdocs.viewer/viewer) - Represents the main class that controls the document rendering process. + * [ViewerSettings](../../com.groupdocs.viewer/viewersettings) - Defines settings for customizing the behavior of the Viewer. + +For more details on working with the document rendering process using GroupDocs.Viewer for Java, please refer to the [GroupDocs.Viewer Documentation][]. + + +[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/ ## Classes | Class | Description | | --- | --- | -| [License](../com.groupdocs.viewer/license) | Provides methods to license the component. | -| [Metered](../com.groupdocs.viewer/metered) | Provides methods for applying [Metered][] license.[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered | -| [Viewer](../com.groupdocs.viewer/viewer) | Represents main class that controls document rendering process. | -| [ViewerSettings](../com.groupdocs.viewer/viewersettings) | Defines settings for customizing [Viewer](../com.groupdocs.viewer/viewer) behaviour. | +| [License](../com.groupdocs.viewer/license) | Provides methods to license the component and unlock its full functionality. | +| [Metered](../com.groupdocs.viewer/metered) | Provides methods for applying metered license to the GroupDocs.Viewer component. | +| [Viewer](../com.groupdocs.viewer/viewer) | Represents the main class that controls the document rendering process. | +| [ViewerSettings](../com.groupdocs.viewer/viewersettings) | Defines settings for customizing the behavior of the Viewer component. | ## Enumerations | Enum | Description | | --- | --- | -| [FileType](../com.groupdocs.viewer/filetype) | Represents file type. | +| [FileType](../com.groupdocs.viewer/filetype) | Represents the file type. | diff --git a/english/java/com.groupdocs.viewer/filetype/_index.md b/english/java/com.groupdocs.viewer/filetype/_index.md index e2929ab92..5ca71d2f0 100644 --- a/english/java/com.groupdocs.viewer/filetype/_index.md +++ b/english/java/com.groupdocs.viewer/filetype/_index.md @@ -1,7 +1,7 @@ --- title: FileType second_title: GroupDocs.Viewer for Java API Reference -description: Represents file type. +description: Represents the file type. type: docs weight: 14 url: /java/com.groupdocs.viewer/filetype/ @@ -15,224 +15,243 @@ com.aspose.ms.System.IEquatable, com.groupdocs.viewer.caching.Cacheable public enum FileType extends Enum implements System.IEquatable, Cacheable ``` -Represents file type. Provides methods to obtain list of all file types supported by **GroupDocs.Viewer**. +Represents the file type. Provides methods to obtain a list of all file types supported by the GroupDocs.Viewer component. + +The FileType enum provides constants representing different file types that are supported by the GroupDocs.Viewer component. You can use the methods in this enum to obtain a list of all supported file types or check if a specific file type is supported. + +Example usage: + +``` + + // Try to detect file type using stream + final FileType fileTypeFromStream = FileType.fromStream(new FileInputStream("document.pdf")); + // Detect file type by extension + final FileType fileTypeFromExtension = FileType.fromExtension(".png"); + // Iterate all supported file types + for (FileType supportedFileType : FileType.getSupportedFileTypes()) { + System.out.println("File type: " + supportedFileType); + } + final LoadOptions loadOptions = new LoadOptions(fileTypeFromExtension); + // Usage of loadOptions + +``` ## Fields | Field | Description | | --- | --- | -| [UNKNOWN](#UNKNOWN) | Represents unknown file type. | -| [ZIP](#ZIP) | Zipped File (.zip) represents archives that can hold one or more files or directories. | -| [TAR](#TAR) | Consolidated Unix File Archive (.tar) are archives created with Unix-based utility for collecting one or more files. | -| [XZ](#XZ) | XZ file (.xz) is archive compressed a high-ratio compression algorithm based on the LZMA algorithm. | -| [TXZ](#TXZ) | Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. | -| [TARXZ](#TARXZ) | Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. | -| [TGZ](#TGZ) | Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. | -| [TARGZ](#TARGZ) | Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. | -| [BZ_2](#BZ-2) | Bzip2 Compressed File (.bz2) are compressed files generated using the BZIP2 open source compression method, mostly on UNIX or Linux system. | -| [RAR](#RAR) | Roshal ARchive (.rar) are compressed files generated using the RAR (WINRAR version 4) compression method. | -| [GZ](#GZ) | Gnu Zipped File (.gz) are compressed files created with gzip compression application. | -| [GZIP](#GZIP) | Gnu Zipped File (.gzip) was introduced as a free utility for replacing the Compress program used in Unix systems. | -| [SEVEN_ZIP](#SEVEN-ZIP) | 7Zip (.7z, .7zip) is free open source archiver with LZMA and LZMA2 compression. | -| [DXF](#DXF) | Drawing Exchange Format File (.dxf) is a tagged data representation of AutoCAD drawing file. | -| [DWG](#DWG) | AutoCAD Drawing Database File (.dwg) represents proprietary binary files used for containing 2D and 3D design data. | -| [DWT](#DWT) | AutoCAD Drawing Template (.dwt) is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files. | -| [STL](#STL) | Stereolithography File (.stl) is an interchangeable file format that represents 3-dimensional surface geometry. | -| [IFC](#IFC) | Industry Foundation Classes File (.ifc) is a file format that establishes international standards to import and export building objects and their properties. | -| [DWF](#DWF) | Design Web Format File (.dwf) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files. | -| [FBX](#FBX) | Autodesk FBX Interchange File (FilmBoX) (.fbx) represents 3D model format. | -| [DWFX](#DWFX) | Design Web Format File XPS (.dwfx) represents 2D/3D drawing as XPS document in compressed format for viewing, reviewing or printing design files. | -| [DGN](#DGN) | MicroStation Design File (.dgn) are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. | -| [PLT](#PLT) | PLT (HPGL) (.plt) is a vector-based plotter file introduced by Autodesk, Inc. | -| [CF2](#CF2) | Common File Format File. | -| [OBJ](#OBJ) | Wavefront 3D Object File (.obj) is 3D image file introduced by Wavefront Technologies. | -| [HPG](#HPG) | PLT (HPGL) (.hpg). | -| [IGS](#IGS) | Initial Graphics Exchange Specification (IGES) (.igs). | -| [VSD](#VSD) | Visio Drawing File (.vsd) are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. | -| [VSDX](#VSDX) | Visio Drawing (.vsdx) represents Microsoft Visio file format introduced from Microsoft Office 2013 onwards. | -| [VSS](#VSS) | Visio Stencil File(.vss) are stencil files created with Microsoft Visio 2007 and earlier. | -| [VSSX](#VSSX) | Visio Stencil File (.vssx) are drawing stencils created with Microsoft Visio 2013 and above. | -| [VSDM](#VSDM) | Visio Macro-Enabled Drawing (.vsdm) are drawing files created with Microsoft Visio application that supports macros. | -| [VST](#VST) | Visio Drawing Template (.vst) are vector image files created with Microsoft Visio and act as template for creating further files. | -| [VSTX](#VSTX) | Visio Drawing Template (.vstx) are drawing template files created with Microsoft Visio 2013 and above. | -| [VSTM](#VSTM) | Visio Macro-Enabled Drawing Template (.vstm) are template files created with Microsoft Visio that support macros. | -| [VSSM](#VSSM) | Visio Macro-Enabled Stencil File (.vssm) are Microsoft Visio Stencil files that support provide support for macros. | -| [VSX](#VSX) | Visio Stencil XML File (.vsx) refers to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. | -| [VTX](#VTX) | Visio Template XML File (.vtx) is a Microsoft Visio drawing template that is saved to disc in XML file format. | -| [VDW](#VDW) | Visio Web Drawing (.vdw) represents file format that specifies the streams and storages required for rendering a Web drawing. | -| [VDX](#VDX) | Visio Drawing XML File (.vdx) represents any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. | -| [EPUB](#EPUB) | Open eBook File (.epub) is an e-book file format that provide a standard digital publication format for publishers and consumers. | -| [MOBI](#MOBI) | Mobipocket eBook (.mobi) is one of the most widely used ebook file format. | -| [MSG](#MSG) | Outlook Mail Message (.msg) is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. | -| [EML](#EML) | E-Mail Message (.eml) represents email messages saved using Outlook and other relevant applications. | -| [EMLX](#EMLX) | Apple Mail Message (.emlx) is implemented and developed by Apple. | -| [PST](#PST) | Outlook Personal Information Store File (.pst) represents Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. | -| [OST](#OST) | Outlook Offline Data File (.ost) represents user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. | -| [TIF](#TIF) | Tagged Image File (.tif) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. | -| [TIFF](#TIFF) | Tagged Image File Format (.tiff) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. | -| [JPG](#JPG) | JPEG Image (.jpg) is a type of image format that is saved using the method of lossy compression. | -| [JPEG](#JPEG) | JPEG Image (.jpeg) is a type of image format that is saved using the method of lossy compression. | -| [PNG](#PNG) | Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. | -| [GIF](#GIF) | Graphical Interchange Format File (.gif) is a type of highly compressed image. | -| [APNG](#APNG) | Animated Portable Network Graphic (.apng) is extension of PNG format that support animation. | -| [BMP](#BMP) | Bitmap Image File (.bmp) is used to store bitmap digital images. | -| [ICO](#ICO) | Icon File (.ico) are image file types used as icon for representation of an application on Microsoft Windows. | -| [TGA](#TGA) | Truevision TGA (Truevision Advanced Raster Adapter - TARGA) is used to store bitmap digital images developed by TRUEVISION. | -| [JP_2](#JP-2) | JPEG 2000 Core Image File (.jp2) is an image coding system and state-of-the-art image compression standard. | -| [JPF](#JPF) | JPEG 2000 Image File (.jpf) | -| [JPX](#JPX) | JPEG 2000 Image File (.jpx) | -| [JPM](#JPM) | JPEG 2000 Image File (.jpm) | -| [J2C](#J2C) | JPEG 2000 Code InputStream (.j2c) | -| [J2K](#J2K) | JPEG 2000 Code Stream (.j2k) is an image that is compressed using the wavelet compression instead of DCT compression. | -| [JPC](#JPC) | JPEG 2000 Code InputStream (.jpc) | -| [JLS](#JLS) | JPEG-LS (JLS) (.jls) | -| [DIB](#DIB) | Device Independent Bitmap File (.dib) | -| [WMF](#WMF) | Windows Metafile (.wmf) represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. | -| [WMZ](#WMZ) | ompressed Windows Metafile (.wmz) represents Microsoft Windows Metafile (WMF) compressed in GZIP archvive - for storing vector as well as bitmap-format images data. | -| [EMF](#EMF) | Enhanced Windows Metafile (.emf) represents graphical images device-independently. | -| [EMZ](#EMZ) | Enhanced Windows Metafile compressed (.emz) represents graphical images device-independently compressed by GZIP. | -| [WEBP](#WEBP) | WebP Image (.webp) is a modern raster web image file format that is based on lossless and lossy compression. | -| [DNG](#DNG) | Digital Negative Specification (.dng) is a digital camera image format used for the storage of raw files. | -| [CDR](#CDR) | CorelDraw Vector Graphic Drawing (.cdr) is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. | -| [CMX](#CMX) | Corel Exchange (.cmx) is a drawing image file that may contain vector graphics as well as bitmap graphics. | -| [DJVU](#DJVU) | DjVu Image (.djvu) is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. | -| [CGM](#CGM) | Computer Graphics Metafile (.cgm) is a free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. | -| [PCL](#PCL) | Printer Command Language Document (.pcl) | -| [PSD](#PSD) | Adobe Photoshop Document (.psd) represents Adobe Photoshop's native file format used for graphics designing and development. | -| [PSB](#PSB) | Photoshop Large Document Format (.psb) represents Photoshop Large Document Format used for graphics designing and development. | -| [DCM](#DCM) | DICOM Image (.dcm) represents digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. | -| [PS](#PS) | PostScript File (.ps) | -| [EPS](#EPS) | Encapsulated PostScript File (.eps) describes an Encapsulated PostScript language program that describes the appearance of a single page. | -| [ODG](#ODG) | OpenDocument Graphic File (.odg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. | -| [FODG](#FODG) | Flat XML ODF Template (.fodg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. | -| [SVG](#SVG) | Scalable Vector Graphics File (.svg) is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. | -| [SVGZ](#SVGZ) | Scalable Vector Graphics File (.svgz) is a Scalar Vector Graphics file that uses XML based text format, compressed by GZIP for describing the appearance of an image. | -| [OTG](#OTG) | OpenDocument Graphic Template (.otg) | -| [HTM](#HTM) | Hypertext Markup Language File (.htm) is the extension for web pages created for display in browsers. | -| [HTML](#HTML) | Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. | -| [MHT](#MHT) | MHTML Web Archive (.mht) | -| [NSF](#NSF) | Lotus Notes Database (.nsf) Learn more about this file format https://fileinfo.com/extension/nsf | -| [MBOX](#MBOX) | Email Mailbox File (.mbox). | -| [MHTML](#MHTML) | MIME HTML File (.mhtml) | -| [XML](#XML) | XML File (.xml) | -| [ONE](#ONE) | OneNote Document (.one) is created by Microsoft OneNote application. | -| [PDF](#PDF) | Portable Document Format File (.pdf) is a type of document created by Adobe back in 1990s. | -| [XPS](#XPS) | XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. | -| [OXPS](#OXPS) | OpenXPS File (.oxps) | -| [TEX](#TEX) | LaTeX Source Document (.tex) is a language that comprises of programming as well as mark-up features, used to typeset documents. | -| [PPT](#PPT) | PowerPoint Presentation (.ppt) represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. | -| [PPTX](#PPTX) | PowerPoint Open XML Presentation (.pptx) are presentation files created with popular Microsoft PowerPoint application. | -| [PPS](#PPS) | PowerPoint Slide Show (.pps) are created using Microsoft PowerPoint for Slide Show purpose. | -| [PPSX](#PPSX) | PowerPoint Open XML Slide Show (.ppsx) files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. | -| [ODP](#ODP) | OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. | -| [FODP](#FODP) | OpenDocument Presentation (.fodp) represents OpenDocument Flat XML Presentation. | -| [POT](#POT) | PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. | -| [PPTM](#PPTM) | PowerPoint Open XML Macro-Enabled Presentation are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. | -| [POTX](#POTX) | PowerPoint Open XML Presentation Template (.potx) represents Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. | -| [POTM](#POTM) | PowerPoint Open XML Macro-Enabled Presentation Template (.potm) are Microsoft PowerPoint template files with support for Macros. | -| [PPSM](#PPSM) | PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. | -| [OTP](#OTP) | OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. | -| [XLS](#XLS) | Excel Spreadsheet (.xls) represents Excel Binary File Format. | -| [EXCEL_2003_XML](#EXCEL-2003-XML) | Excel 2003 XML (SpreadsheetML) represents Excel Binary File Format. | -| [NUMBERS](#NUMBERS) | Apple numbers represents Excel like Binary File Format. | -| [XLSX](#XLSX) | Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. | -| [XLSM](#XLSM) | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. | -| [XLSB](#XLSB) | Excel Binary Spreadsheet (.xlsb) specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. | -| [CSV](#CSV) | Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. | -| [TSV](#TSV) | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. | -| [ODS](#ODS) | OpenDocument Spreadsheet (.ods) stands for OpenDocument Spreadsheet Document format that are editable by user. | -| [FODS](#FODS) | OpenDocument Flat XML Spreadsheet (.fods) | -| [OTS](#OTS) | OpenDocument Spreadsheet Template (.ots) | -| [XLAM](#XLAM) | Microsoft Excel Add-in (.xlam) | -| [XLTM](#XLTM) | Microsoft Excel Macro-Enabled Template (.xltm) represents files that are generated by Microsoft Excel as Macro-enabled template files. | -| [XLT](#XLT) | Microsoft Excel Template (.xlt) are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. | -| [XLTX](#XLTX) | Excel Open XML Spreadsheet Template (.xltx) represents Microsoft Excel Template that are based on the Office OpenXML file format specifications. | -| [SXC](#SXC) | StarOffice Calc Spreadsheet (.sxc) | -| [MPP](#MPP) | Microsoft Project File (.mpp) is Microsoft Project data file that stores information related to project management in an integrated manner. | -| [MPT](#MPT) | Microsoft Project Template (.mpt) contains basic information and structure along with document settings for creating .MPP files. | -| [MPX](#MPX) | Microsoft Project Exchange file (.mpx) is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating. | -| [AS](#AS) | ActionScript File (.as) | -| [AS_3](#AS-3) | ActionScript File (.as) | -| [ASM](#ASM) | Assembly Language Source Code File (.asm) | -| [BAT](#BAT) | DOS Batch File (.bat) | -| [C](#C) | C/C++ Source Code File (.c) | -| [CC](#CC) | C++ Source Code File (.cc) | -| [CMAKE](#CMAKE) | CMake File (.cmake) | -| [CPP](#CPP) | C++ Source Code File (.cpp) | -| [CS](#CS) | C\# Source Code File (.cs) is a source code file for C\# programming language. | -| [VB](#VB) | Visual Basic Project Item File (.vb) is a source code file created in Visual Basic language that was created by Microsoft for development of .NET applications. | -| [CSS](#CSS) | Cascading Style Sheet (.css) | -| [CXX](#CXX) | C++ Source Code File (.cxx) | -| [DIFF](#DIFF) | Patch File (.diff) | -| [ERB](#ERB) | Ruby ERB Script (.erb) | -| [GROOVY](#GROOVY) | Groovy Source Code File (.groovy) | -| [H](#H) | C/C++/Objective-C Header File (.h) | -| [HAML](#HAML) | Haml Source Code File (.haml) | -| [HH](#HH) | C++ Header File (.hh) | -| [JAVA](#JAVA) | Java Source Code File (.java) | -| [JS](#JS) | JavaScript File (.js) | -| [JSON](#JSON) | JavaScript Object Notation File (.json) | -| [LESS](#LESS) | LESS Style Sheet (.less) | -| [LOG](#LOG) | Log File (.log) | -| [M](#M) | Objective-C Implementation File (.m) | -| [MAKE](#MAKE) | Xcode Makefile Script (.make) | -| [MD](#MD) | Markdown Documentation File (.md) | -| [ML](#ML) | ML Source Code File (.ml) | -| [MM](#MM) | Objective-C++ Source File (.mm) | -| [PHP](#PHP) | PHP Source Code File (.php) | -| [PL](#PL) | Perl Script (.pl) | -| [PROPERTIES](#PROPERTIES) | Java Properties File (.properties) | -| [PY](#PY) | Python Script (.py) | -| [RB](#RB) | Ruby Source Code (.rb) | -| [RST](#RST) | reStructuredText File (.rst) | -| [SASS](#SASS) | Syntactically Awesome StyleSheets File (.sass) | -| [SCALA](#SCALA) | Scala Source Code File (.scala) | -| [SCM](#SCM) | Scheme Source Code File (.scm) | -| [SCRIPT](#SCRIPT) | Generic Script File (.script) | -| [SH](#SH) | Bash Shell Script (.sh) | -| [SML](#SML) | Standard ML Source Code File (.sml) | -| [SQL](#SQL) | Structured Query Language Data File (.sql) | -| [VIM](#VIM) | Vim Settings File (.vim) | -| [YAML](#YAML) | YAML Document (.yaml) | -| [DOC](#DOC) | Microsoft Word Document (.doc) represents documents generated by Microsoft Word or other word processing documents in binary file format. | -| [DOCX](#DOCX) | Microsoft Word Open XML Document (.docx) is a well-known format for Microsoft Word documents. | -| [CHM](#CHM) | Microsoft Compiled HTML Help File (.chm) is a well-known format for HELP (documentation to some application) documents. | -| [DOCM](#DOCM) | Word Open XML Macro-Enabled Document (.docm) is a Microsoft Word 2007 or higher generated documents with the ability to run macros. | -| [DOT](#DOT) | Word Document Template (.dot) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. | -| [DOTX](#DOTX) | Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. | -| [DOTM](#DOTM) | Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. | -| [RTF](#RTF) | Rich Text Format File (.rtf) represents a method of encoding formatted text and graphics for use within applications. | -| [TXT](#TXT) | Plain Text File (.txt) represents a text document that contains plain text in the form of lines. | -| [ODT](#ODT) | OpenDocument Text Document (.odt) are type of documents created with word processing applications that are based on OpenDocument Text File format. | -| [OTT](#OTT) | OpenDocument Document Template (.ott) represents template documents generated by applications in compliance with the OASIS' OpenDocument standard format. | -| [VCF](#VCF) | vCard File (.vcf) is a digital file format for storing contact information. | -| [AI](#AI) | Adobe Illustrator (.ai) is a file format for Adobe Illustrator drawings. | -| [PSM1](#PSM1) | PowerShell script module (.psm1) a file format for PowerShell module scripts. | -| [PS1](#PS1) | PowerShell script file (.ps1) a file format for Windows PowerShell Cmdlet files. | -| [PSD1](#PSD1) | PowerShell script module manifest (.psd1) a file format for PowerShell module manifest scripts. | +| [UNKNOWN](#UNKNOWN) | Represents an unknown file type. | +| [ZIP](#ZIP) | Represents a zipped file (.zip) that can hold one or more files or directories. | +| [TAR](#TAR) | Represents a consolidated Unix file archive (.tar) created for collecting one or more files. | +| [XZ](#XZ) | Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm. | +| [TXZ](#TXZ) | Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. | +| [TARXZ](#TARXZ) | Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. | +| [TGZ](#TGZ) | Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. | +| [TARGZ](#TARGZ) | Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. | +| [BZ_2](#BZ-2) | Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method. | +| [RAR](#RAR) | Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method. | +| [GZ](#GZ) | Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application. | +| [GZIP](#GZIP) | Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems. | +| [SEVEN_ZIP](#SEVEN-ZIP) | Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression. | +| [DXF](#DXF) | Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file. | +| [DWG](#DWG) | Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data. | +| [DWT](#DWT) | Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a starter for creating drawings that can be saved as DWG files. | +| [STL](#STL) | Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry. | +| [IFC](#IFC) | Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties. | +| [DWF](#DWF) | Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings. | +| [FBX](#FBX) | Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format. | +| [DWFX](#DWFX) | Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document. | +| [DGN](#DGN) | Represents a MicroStation Design File (.dgn), which are drawings created and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. | +| [PLT](#PLT) | Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc. | +| [CF2](#CF2) | Represents a Common File Format File (.cf2). | +| [OBJ](#OBJ) | Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies. | +| [HPG](#HPG) | Represents a PLT (HPGL) File (.hpg). | +| [IGS](#IGS) | Represents an Initial Graphics Exchange Specification (IGES) File (.igs). | +| [VSD](#VSD) | Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections. | +| [VSDX](#VSDX) | Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards. | +| [VSS](#VSS) | Represents a Visio Stencil File (.vss), which are stencil files created with Microsoft Visio 2007 and earlier. | +| [VSSX](#VSSX) | Represents a Visio Stencil File (.vssx), which are drawing stencils created with Microsoft Visio 2013 and above. | +| [VSDM](#VSDM) | Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support macros. | +| [VST](#VST) | Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio. | +| [VSTX](#VSTX) | Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above. | +| [VSTM](#VSTM) | Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros. | +| [VSSM](#VSSM) | Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros. | +| [VSX](#VSX) | Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio. | +| [VTX](#VTX) | Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format. | +| [VDW](#VDW) | Represents a Visio Web Drawing (.vdw), which specifies the streams and storages required for rendering a web drawing. | +| [VDX](#VDX) | Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension. | +| [EPUB](#EPUB) | Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers. | +| [MOBI](#MOBI) | Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats. | +| [MSG](#MSG) | Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks. | +| [EML](#EML) | Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications. | +| [EMLX](#EMLX) | Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple. | +| [PST](#PST) | Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information. | +| [OST](#OST) | Represents an Outlook Offline Data File (.ost), which represents a user's mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook. | +| [TIF](#TIF) | Represents a Tagged Image File (.tif), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. | +| [TIFF](#TIFF) | Represents a Tagged Image File Format (.tiff), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. | +| [JPG](#JPG) | Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression. | +| [JPEG](#JPEG) | Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression. | +| [PNG](#PNG) | Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression. | +| [GIF](#GIF) | Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image. | +| [APNG](#APNG) | Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation. | +| [BMP](#BMP) | Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images. | +| [ICO](#ICO) | Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows. | +| [TGA](#TGA) | Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION. | +| [JP_2](#JP-2) | Represents a JPEG 2000 Core Image File (.jp2), which is an image coding system and state-of-the-art image compression standard. | +| [JPF](#JPF) | Represents a JPEG 2000 Image File (.jpf). | +| [JPX](#JPX) | Represents a JPEG 2000 Image File (.jpx). | +| [JPM](#JPM) | Represents a JPEG 2000 Image File (.jpm). | +| [J2C](#J2C) | Represents a JPEG 2000 Code InputStream (.j2c). | +| [J2K](#J2K) | Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression. | +| [JPC](#JPC) | Represents a JPEG 2000 Code Stream (.jpc). | +| [JLS](#JLS) | Represents a JPEG-LS (JLS) file (.jls). | +| [DIB](#DIB) | Represents a Device Independent Bitmap File (.dib). | +| [WMF](#WMF) | Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data. | +| [WMZ](#WMZ) | Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data. | +| [EMF](#EMF) | Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently. | +| [EMZ](#EMZ) | Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP. | +| [WEBP](#WEBP) | Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression. | +| [DNG](#DNG) | Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files. | +| [CDR](#CDR) | Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images. | +| [CMX](#CMX) | Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics. | +| [DJVU](#DJVU) | Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs. | +| [CGM](#CGM) | Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text. | +| [PCL](#PCL) | Represents a Printer Command Language Document (.pcl). | +| [PSD](#PSD) | Represents an Adobe Photoshop Document (.psd), which is Adobe Photoshop's native file format used for graphics designing and development. | +| [PSB](#PSB) | Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop. | +| [DCM](#DCM) | Represents a DICOM Image (.dcm), which represents a digital image that stores medical information of patients such as MRIs, CT scans, and ultrasound images. | +| [PS](#PS) | Represents a PostScript File (.ps). | +| [EPS](#EPS) | Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page. | +| [ODG](#ODG) | Represents an OpenDocument Graphic File (.odg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. | +| [FODG](#FODG) | Represents a Flat XML ODF Template (.fodg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. | +| [SVG](#SVG) | Represents a Scalable Vector Graphics File (.svg), which is a Scalar Vector Graphics file that uses XML-based text format for describing the appearance of an image. | +| [SVGZ](#SVGZ) | Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image. | +| [OTG](#OTG) | Represents an OpenDocument Graphic Template (.otg). | +| [HTM](#HTM) | Represents a Hypertext Markup Language File (.htm), which is the extension for web pages created for display in browsers. | +| [HTML](#HTML) | Represents a Hypertext Markup Language File (.html), which is the extension for web pages created for display in browsers. | +| [MHT](#MHT) | Represents an MHTML Web Archive (.mht). | +| [NSF](#NSF) | Represents a Lotus Notes Database (.nsf). | +| [MBOX](#MBOX) | Represents an Email Mailbox File (.mbox). | +| [MHTML](#MHTML) | Represents a MIME HTML File (.mhtml). | +| [XML](#XML) | Represents an XML File (.xml). | +| [ONE](#ONE) | Represents a OneNote Document (.one) created by Microsoft OneNote application. | +| [PDF](#PDF) | Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s. | +| [XPS](#XPS) | Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft. | +| [OXPS](#OXPS) | Represents an OpenXPS File (.oxps). | +| [TEX](#TEX) | Represents a LaTeX Source Document (.tex), which is a language that comprises programming as well as mark-up features used to typeset documents. | +| [PPT](#PPT) | Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a slideshow. | +| [PPTX](#PPTX) | Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application. | +| [PPS](#PPS) | Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes. | +| [PPSX](#PPSX) | Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes. | +| [ODP](#ODP) | Represents an OpenDocument Presentation (.odp), which represents a presentation file format used by OpenOffice.org in the OASISOpen standard. | +| [FODP](#FODP) | Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation. | +| [POT](#POT) | Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. | +| [PPTM](#PPTM) | Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions. | +| [POTX](#POTX) | Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above. | +| [POTM](#POTM) | Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros. | +| [PPSM](#PPSM) | Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a macro-enabled slide show file format created with Microsoft PowerPoint 2007 or higher. | +| [OTP](#OTP) | Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format. | +| [XLS](#XLS) | Represents an Excel Spreadsheet (.xls), which represents the Excel Binary File Format. | +| [EXCEL_2003_XML](#EXCEL-2003-XML) | Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the Excel Binary File Format. | +| [NUMBERS](#NUMBERS) | Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format. | +| [XLSX](#XLSX) | Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. | +| [XLSM](#XLSM) | Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros. | +| [XLSB](#XLSB) | Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format. | +| [CSV](#CSV) | Represents a Comma Separated Values File (.csv), which represents plain text files that contain records of data with comma-separated values. | +| [TSV](#TSV) | Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format. | +| [ODS](#ODS) | Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user. | +| [FODS](#FODS) | Represents an OpenDocument Flat XML Spreadsheet (.fods). | +| [OTS](#OTS) | Represents an OpenDocument Spreadsheet Template (.ots). | +| [XLAM](#XLAM) | Represents a Microsoft Excel Add-in (.xlam). | +| [XLTM](#XLTM) | Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files. | +| [XLT](#XLT) | Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite. | +| [XLTX](#XLTX) | Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates based on the Office OpenXML file format specifications. | +| [SXC](#SXC) | Represents a StarOffice Calc Spreadsheet (.sxc). | +| [MPP](#MPP) | Represents a Microsoft Project File (.mpp), which is a Microsoft Project data file that stores information related to project management in an integrated manner. | +| [MPT](#MPT) | Represents a Microsoft Project Template (.mpt), which contains basic information and structure along with document settings for creating .MPP files. | +| [MPX](#MPX) | Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring project information between Microsoft Project (MSP) and other applications that support the MPX file format, such as Primavera Project Planner, Sciforma, and Timerline Precision Estimating. | +| [AS](#AS) | Represents an ActionScript File (.as). | +| [AS_3](#AS-3) | Represents an ActionScript File (.as3). | +| [ASM](#ASM) | Represents an Assembly Language Source Code File (.asm). | +| [BAT](#BAT) | Represents a DOS Batch File (.bat). | +| [C](#C) | Represents a C/C++ Source Code File (.c). | +| [CC](#CC) | Represents a C++ Source Code File (.cc). | +| [CMAKE](#CMAKE) | Represents a CMake File (.cmake). | +| [CPP](#CPP) | Represents a C++ Source Code File (.cpp). | +| [CS](#CS) | Represents a C\# Source Code File (.cs), which is a source code file for the C\# programming language. | +| [VB](#VB) | Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language. | +| [CSS](#CSS) | Represents a Cascading Style Sheet (.css) file. | +| [CXX](#CXX) | Represents a C++ Source Code File (.cxx). | +| [DIFF](#DIFF) | Represents a Patch File (.diff). | +| [ERB](#ERB) | Represents a Ruby ERB Script (.erb). | +| [GROOVY](#GROOVY) | Represents a Groovy Source Code File (.groovy). | +| [H](#H) | Represents a C/C++/Objective-C Header File (.h). | +| [HAML](#HAML) | Represents a Haml Source Code File (.haml). | +| [HH](#HH) | Represents a C++ Header File (.hh). | +| [JAVA](#JAVA) | Represents a Java Source Code File (.java). | +| [JS](#JS) | Represents a JavaScript File (.js). | +| [JSON](#JSON) | Represents a JavaScript Object Notation File (.json). | +| [LESS](#LESS) | Represents a LESS Style Sheet (.less) file. | +| [LOG](#LOG) | Represents a Log File (.log). | +| [M](#M) | Represents an Objective-C Implementation File (.m). | +| [MAKE](#MAKE) | Represents an Xcode Makefile Script (.make). | +| [MD](#MD) | Represents a Markdown Documentation File (.md). | +| [ML](#ML) | Represents an ML Source Code File (.ml). | +| [MM](#MM) | Represents an Objective-C++ Source File (.mm). | +| [PHP](#PHP) | Represents a PHP Source Code File (.php). | +| [PL](#PL) | Represents a Perl Script (.pl). | +| [PROPERTIES](#PROPERTIES) | Represents a Java Properties File (.properties). | +| [PY](#PY) | Represents a Python Script (.py). | +| [RB](#RB) | Represents a Ruby Source Code (.rb) file. | +| [RST](#RST) | Represents a reStructuredText File (.rst). | +| [SASS](#SASS) | Represents a Syntactically Awesome StyleSheets File (.sass). | +| [SCALA](#SCALA) | Represents a Scala Source Code File (.scala). | +| [SCM](#SCM) | Represents a Scheme Source Code File (.scm). | +| [SCRIPT](#SCRIPT) | Represents a Generic Script File (.script). | +| [SH](#SH) | Represents a Bash Shell Script (.sh). | +| [SML](#SML) | Represents a Standard ML Source Code File (.sml). | +| [SQL](#SQL) | Represents a Structured Query Language Data File (.sql). | +| [VIM](#VIM) | Represents a Vim Settings File (.vim). | +| [YAML](#YAML) | Represents a YAML Document (.yaml). | +| [DOC](#DOC) | Represents a Microsoft Word Document (.doc) file. | +| [DOCX](#DOCX) | Represents a Microsoft Word Open XML Document (.docx) file. | +| [CHM](#CHM) | Represents a Microsoft Compiled HTML Help File (.chm). | +| [DOCM](#DOCM) | Represents a Word Open XML Macro-Enabled Document (.docm) file. | +| [DOT](#DOT) | Represents a Word Document Template (.dot) file. | +| [DOTX](#DOTX) | Represents a Word Open XML Document Template (.dotx) file. | +| [DOTM](#DOTM) | Represents a Word Open XML Macro-Enabled Document Template (.dotm) file. | +| [RTF](#RTF) | Represents a Rich Text Format File (.rtf). | +| [TXT](#TXT) | Represents a Plain Text File (.txt). | +| [ODT](#ODT) | Represents an OpenDocument Text Document (.odt). | +| [OTT](#OTT) | Represents an OpenDocument Document Template (.ott). | +| [VCF](#VCF) | Represents a vCard File (.vcf), which is a digital file format for storing contact information. | +| [AI](#AI) | Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings. | +| [PSM1](#PSM1) | Represents a PowerShell script module file (.psm1). | +| [PS1](#PS1) | Represents a PowerShell script file (.ps1). | +| [PSD1](#PSD1) | Represents a PowerShell script module manifest file (.psd1). | ## Methods | Method | Description | | --- | --- | | [values()](#values--) | | | [valueOf(String name)](#valueOf-java.lang.String-) | | -| [fromExtension(String extension)](#fromExtension-java.lang.String-) | Maps file extension to file type. | -| [fromFilePath(String filePath)](#fromFilePath-java.lang.String-) | Extracts file extension and maps it to file type. | -| [fromMediaType(String mediaType)](#fromMediaType-java.lang.String-) | Maps file media type to file type e.g. 'application/pdf' will be mapped to [FileType](../../com.groupdocs.viewer/filetype).PDF. | -| [fromStream(InputStream stream)](#fromStream-java.io.InputStream-) | Detects file type by reading the file signature. | -| [fromStream(InputStream stream, String password)](#fromStream-java.io.InputStream-java.lang.String-) | Detects file type by reading the file signature. | -| [fromStream(InputStream stream, ILogger logger)](#fromStream-java.io.InputStream-com.groupdocs.foundation.logging.ILogger-) | Detects file type by reading the file signature. | -| [fromStream(InputStream stream, String password, ILogger logger)](#fromStream-java.io.InputStream-java.lang.String-com.groupdocs.foundation.logging.ILogger-) | Detects file type by reading the file signature. | -| [getSupportedFileTypes()](#getSupportedFileTypes--) | Retrieves supported file types | -| [getFileFormat()](#getFileFormat--) | File type name e.g. "Microsoft Word Document". | -| [getExtension()](#getExtension--) | Filename suffix (including the period ".") e.g. ".doc". | -| [toString()](#toString--) | Returns a String that represents the current object. | +| [fromExtension(String extension)](#fromExtension-java.lang.String-) | Maps a file extension to a file type. | +| [fromFilePath(String filePath)](#fromFilePath-java.lang.String-) | Extracts the file extension from a file name or file path and maps it to a file type. | +| [fromMediaType(String mediaType)](#fromMediaType-java.lang.String-) | Maps a file media type to a file type. | +| [fromStream(InputStream stream)](#fromStream-java.io.InputStream-) | Detects the file type by reading the file signature. | +| [fromStream(InputStream stream, String password)](#fromStream-java.io.InputStream-java.lang.String-) | Detects the file type by reading the file signature. | +| [fromStream(InputStream stream, ILogger logger)](#fromStream-java.io.InputStream-com.groupdocs.foundation.logging.ILogger-) | Detects the file type by reading the file signature. | +| [fromStream(InputStream stream, String password, ILogger logger)](#fromStream-java.io.InputStream-java.lang.String-com.groupdocs.foundation.logging.ILogger-) | Detects the file type by reading the file signature. | +| [getSupportedFileTypes()](#getSupportedFileTypes--) | Retrieves the supported file types. | +| [getFileFormat()](#getFileFormat--) | Gets the name of the file format, e.g., "Microsoft Word Document". | +| [getExtension()](#getExtension--) | Gets the file extension suffix (including the period "."), e.g., ".doc". | +| [toString()](#toString--) | Returns a string representation of the current object. | ### UNKNOWN {#UNKNOWN} ``` public static final FileType UNKNOWN ``` -Represents unknown file type. +Represents an unknown file type. ### ZIP {#ZIP} ``` @@ -240,7 +259,7 @@ public static final FileType ZIP ``` -Zipped File (.zip) represents archives that can hold one or more files or directories. Learn more about this file format [here][]. +Represents a zipped file (.zip) that can hold one or more files or directories. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/compression/zip @@ -251,7 +270,7 @@ public static final FileType TAR ``` -Consolidated Unix File Archive (.tar) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here][]. +Represents a consolidated Unix file archive (.tar) created for collecting one or more files. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/compression/tar @@ -262,7 +281,7 @@ public static final FileType XZ ``` -XZ file (.xz) is archive compressed a high-ratio compression algorithm based on the LZMA algorithm. Learn more about this file format [here][]. +Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/xz @@ -273,7 +292,7 @@ public static final FileType TXZ ``` -Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here][]. +Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/txz @@ -284,7 +303,7 @@ public static final FileType TARXZ ``` -Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here][]. +Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/txz @@ -295,7 +314,7 @@ public static final FileType TGZ ``` -Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here][]. +Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/tgz @@ -306,7 +325,7 @@ public static final FileType TARGZ ``` -Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here][]. +Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/tgz @@ -317,7 +336,7 @@ public static final FileType BZ_2 ``` -Bzip2 Compressed File (.bz2) are compressed files generated using the BZIP2 open source compression method, mostly on UNIX or Linux system. Learn more about this file format [here][]. +Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/compression/bz2 @@ -328,7 +347,7 @@ public static final FileType RAR ``` -Roshal ARchive (.rar) are compressed files generated using the RAR (WINRAR version 4) compression method. Learn more about this file format [here][]. +Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/compression/rar @@ -339,7 +358,7 @@ public static final FileType GZ ``` -Gnu Zipped File (.gz) are compressed files created with gzip compression application. It can contain multiple compressed files and is commonly used on UNIX and Linux systems. Learn more about this file format [here][]. +Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/compression/gz @@ -350,7 +369,7 @@ public static final FileType GZIP ``` -Gnu Zipped File (.gzip) was introduced as a free utility for replacing the Compress program used in Unix systems. Such files can be opened and extracted with a several applications such as WinZip which is available on both Windows and MacOS. Learn more about this file format [here][]. +Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/compression/gz @@ -361,7 +380,7 @@ public static final FileType SEVEN_ZIP ``` -7Zip (.7z, .7zip) is free open source archiver with LZMA and LZMA2 compression. Learn more about this file format [here][]. +Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression. Learn more about this file format [here][]. [here]: https://docs.fileformat.com/compression/7z/ @@ -372,7 +391,7 @@ public static final FileType DXF ``` -Drawing Exchange Format File (.dxf) is a tagged data representation of AutoCAD drawing file. Learn more about this file format [here][]. +Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/dxf @@ -383,7 +402,7 @@ public static final FileType DWG ``` -AutoCAD Drawing Database File (.dwg) represents proprietary binary files used for containing 2D and 3D design data. Like DXF, which are ASCII files, DWG represent the binary file format for CAD (Computer Aided Design) drawings. Learn more about this file format [here][]. +Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/dwg @@ -394,7 +413,7 @@ public static final FileType DWT ``` -AutoCAD Drawing Template (.dwt) is an AutoCAD drawing template file that is used as starter for creating drawings that can be saved as DWG files. Learn more about this file format [here][]. +Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a starter for creating drawings that can be saved as DWG files. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/dwt @@ -405,7 +424,7 @@ public static final FileType STL ``` -Stereolithography File (.stl) is an interchangeable file format that represents 3-dimensional surface geometry. The file format finds its usage in several fields such as rapid prototyping, 3D printing and computer-aided manufacturing. Learn more about this file format [here][]. +Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry. It is commonly used in rapid prototyping, 3D printing, and computer-aided manufacturing. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/stl @@ -416,7 +435,7 @@ public static final FileType IFC ``` -Industry Foundation Classes File (.ifc) is a file format that establishes international standards to import and export building objects and their properties. This file format provides interoperability between different software applications. Learn more about this file format [here][]. +Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties. It enables interoperability between different software applications. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/ifc @@ -427,7 +446,7 @@ public static final FileType DWF ``` -Design Web Format File (.dwf) represents 2D/3D drawing in compressed format for viewing, reviewing or printing design files. It contains graphics and text as part of design data and reduce the size of the file due to its compressed format. Learn more about this file format [here][]. +Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/dwf @@ -438,9 +457,7 @@ public static final FileType FBX ``` -Autodesk FBX Interchange File (FilmBoX) (.fbx) represents 3D model format. - -Learn more about this file format [here][]. +Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/fbx @@ -451,7 +468,7 @@ public static final FileType DWFX ``` -Design Web Format File XPS (.dwfx) represents 2D/3D drawing as XPS document in compressed format for viewing, reviewing or printing design files. It contains graphics and text as part of design data and reduce the size of the file due to its compressed format. Learn more about this file format [here][]. +Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/dwfx @@ -462,7 +479,7 @@ public static final FileType DGN ``` -MicroStation Design File (.dgn) are drawings created by and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. Learn more about this file format [here][]. +Represents a MicroStation Design File (.dgn), which are drawings created and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/dgn @@ -473,7 +490,7 @@ public static final FileType PLT ``` -PLT (HPGL) (.plt) is a vector-based plotter file introduced by Autodesk, Inc. and contains information for a certain CAD file. Plotting details require accuracy and precision in production, and usage of PLT file guarantee this as all images are printed using lines instead of dots. Learn more about this file format [here][]. +Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc. It contains information for a certain CAD file, and all images are printed using lines instead of dots, ensuring accuracy and precision in production. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/cad/plt @@ -484,7 +501,7 @@ public static final FileType CF2 ``` -Common File Format File. Learn more about this file format [here][]. +Represents a Common File Format File (.cf2). Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/cf2 @@ -495,7 +512,7 @@ public static final FileType OBJ ``` -Wavefront 3D Object File (.obj) is 3D image file introduced by Wavefront Technologies. Learn more about this file format [here][]. +Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/3d/obj/ @@ -506,7 +523,10 @@ public static final FileType HPG ``` -PLT (HPGL) (.hpg). +Represents a PLT (HPGL) File (.hpg). It is a file format used for plotter files in the HP Graphics Language (HPGL). Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/hpg ### IGS {#IGS} ``` @@ -514,7 +534,7 @@ public static final FileType IGS ``` -Initial Graphics Exchange Specification (IGES) (.igs). +Represents an Initial Graphics Exchange Specification (IGES) File (.igs). ### VSD {#VSD} ``` @@ -522,7 +542,7 @@ public static final FileType VSD ``` -Visio Drawing File (.vsd) are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Learn more about this file format [here][]. +Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vsd @@ -533,7 +553,7 @@ public static final FileType VSDX ``` -Visio Drawing (.vsdx) represents Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It was developed to replace the binary file format, .VSD, which is supported by earlier versions of Microsoft Visio. Learn more about this file format [here][]. +Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It replaced the binary file format (.VSD) supported by earlier versions of Microsoft Visio. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vsdx @@ -544,7 +564,7 @@ public static final FileType VSS ``` -Visio Stencil File(.vss) are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing. Learn more about this file format [here][]. +Represents a Visio Stencil File (.vss), which are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vss @@ -555,7 +575,7 @@ public static final FileType VSSX ``` -Visio Stencil File (.vssx) are drawing stencils created with Microsoft Visio 2013 and above. The VSSX file format can be opened with Visio 2013 and above. Visio files are known for representation of a variety of drawing elements such as collection of shapes, connectors, flowcharts, network layout, UML diagrams, Learn more about this file format [here][]. +Represents a Visio Stencil File (.vssx), which are drawing stencils created with Microsoft Visio 2013 and above. The VSSX file format can be opened with Visio 2013 and above. Visio files are known for representing a variety of drawing elements such as shapes, connectors, flowcharts, network layout, UML diagrams, etc. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vssx @@ -566,7 +586,7 @@ public static final FileType VSDM ``` -Visio Macro-Enabled Drawing (.vsdm) are drawing files created with Microsoft Visio application that supports macros. VSDM files are OPC/XML drawings that are similar to VSDX, but also provide the capability to run macros when the file is opened. Learn more about this file format [here][]. +Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support macros. VSDM files are OPC/XML drawings that are similar to VSDX, but also provide the capability to run macros when the file is opened. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vsdm @@ -577,7 +597,7 @@ public static final FileType VST ``` -Visio Drawing Template (.vst) are vector image files created with Microsoft Visio and act as template for creating further files. These template files are in binary file format and contain the default layout and settings that are utilized for creation of new Visio drawings. Learn more about this file format [here][]. +Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio. They act as templates for creating further files and contain the default layout and settings used for creating new Visio drawings. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vst @@ -588,7 +608,7 @@ public static final FileType VSTX ``` -Visio Drawing Template (.vstx) are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide starting point for creating Visio drawings, saved as .VSDX files, with default layout and settings. Learn more about this file format [here][]. +Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide a starting point for creating Visio drawings saved as .VSDX files, with default layout and settings. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vstx @@ -599,7 +619,7 @@ public static final FileType VSTM ``` -Visio Macro-Enabled Drawing Template (.vstm) are template files created with Microsoft Visio that support macros. Unlike VSDX files, files created from VSTM templates can run macros that are developed in Visual Basic for Applications (VBA) code. Learn more about this file format [here][]. +Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros. Files created from VSTM templates can run macros developed in Visual Basic for Applications (VBA) code. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vstm @@ -610,7 +630,7 @@ public static final FileType VSSM ``` -Visio Macro-Enabled Stencil File (.vssm) are Microsoft Visio Stencil files that support provide support for macros. A VSSM file when opened allows to run the macros to achieve desired formatting and placement of shapes in a diagram. Learn more about this file format [here][]. +Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros. When a VSSM file is opened, macros can be run to achieve desired formatting and placement of shapes in a diagram. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vssm @@ -621,7 +641,7 @@ public static final FileType VSX ``` -Visio Stencil XML File (.vsx) refers to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and was supported till Visio 2013. Learn more about this file format [here][]. +Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and were supported until Visio 2013. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vsx @@ -632,7 +652,7 @@ public static final FileType VTX ``` -Visio Template XML File (.vtx) is a Microsoft Visio drawing template that is saved to disc in XML file format. The template is aimed to provide a file with basic settings that can be used to create multiple Visio files of the same settings. Learn more about this file format [here][]. +Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format. The template provides basic settings for creating multiple Visio files with the same settings. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vtx @@ -643,7 +663,7 @@ public static final FileType VDW ``` -Visio Web Drawing (.vdw) represents file format that specifies the streams and storages required for rendering a Web drawing. Learn more about this file format [here][]. +Represents a Visio Web Drawing (.vdw), which specifies the streams and storages required for rendering a web drawing. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/web/vdw @@ -654,7 +674,7 @@ public static final FileType VDX ``` -Visio Drawing XML File (.vdx) represents any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. A Visio drawing XML file is created in Visio software, which is developed by Microsoft. Learn more about this file format [here][]. +Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension. A Visio drawing XML file is created in the Visio software developed by Microsoft. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/vdx @@ -665,7 +685,7 @@ public static final FileType EPUB ``` -Open eBook File (.epub) is an e-book file format that provide a standard digital publication format for publishers and consumers. The format has been so common by now that it is supported by many e-readers and software applications. Learn more about this file format [here][]. +Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers. The format is supported by many e-readers and software applications. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/ebook/epub @@ -676,7 +696,7 @@ public static final FileType MOBI ``` -Mobipocket eBook (.mobi) is one of the most widely used ebook file format. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as proprietary format for Mobipocket Reader. Learn more about this file format [here][]. +Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as a proprietary format for Mobipocket Reader. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/ebook/mobi @@ -687,7 +707,7 @@ public static final FileType MSG ``` -Outlook Mail Message (.msg) is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Learn more about this file format [here][]. +Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/email/msg @@ -698,7 +718,7 @@ public static final FileType EML ``` -E-Mail Message (.eml) represents email messages saved using Outlook and other relevant applications. Almost all emailing clients support this file format for its compliance with RFC-822 Internet Message Format Standard. Learn more about this file format [here][]. +Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications. Almost all email clients support this file format due to its compliance with the RFC-822 Internet Message Format Standard. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/email/eml @@ -709,7 +729,7 @@ public static final FileType EMLX ``` -Apple Mail Message (.emlx) is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting the emails. Learn more about this file format [here][]. +Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting emails. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/email/emlx @@ -720,7 +740,7 @@ public static final FileType PST ``` -Outlook Personal Information Store File (.pst) represents Outlook Personal Storage Files (also called Personal Storage Table) that store variety of user information. Learn more about this file format [here][]. +Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/email/pst @@ -731,7 +751,7 @@ public static final FileType OST ``` -Outlook Offline Data File (.ost) represents user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format [here][]. +Represents an Outlook Offline Data File (.ost), which represents a user's mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/email/ost @@ -742,7 +762,7 @@ public static final FileType TIF ``` -Tagged Image File (.tif) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here][]. +Represents a Tagged Image File (.tif), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color, and full-color image data in several color spaces. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/tiff @@ -753,7 +773,7 @@ public static final FileType TIFF ``` -Tagged Image File Format (.tiff) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format [here][]. +Represents a Tagged Image File Format (.tiff), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color, and full-color image data in several color spaces. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/tiff @@ -764,7 +784,7 @@ public static final FileType JPG ``` -JPEG Image (.jpg) is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here][]. +Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression. The output image, as a result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/jpeg @@ -775,7 +795,7 @@ public static final FileType JPEG ``` -JPEG Image (.jpeg) is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here][]. +Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression. The output image, as a result of compression, is a trade-off between storage size and image quality. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/jpeg @@ -786,7 +806,7 @@ public static final FileType PNG ``` -Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. This file format was created as a replacement of Graphics Interchange Format (GIF) and has no copyright limitations. Learn more about this file format [here][]. +Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression. This file format was created as a replacement for the Graphics Interchange Format (GIF) and has no copyright limitations. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/png @@ -797,7 +817,7 @@ public static final FileType GIF ``` -Graphical Interchange Format File (.gif) is a type of highly compressed image. For each image GIF typically allow up to 8 bits per pixel and up to 256 colours are allowed across the image. Learn more about this file format [here][]. +Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image. For each image, GIF typically allows up to 8 bits per pixel, and up to 256 colors are allowed across the image. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/gif @@ -808,7 +828,7 @@ public static final FileType APNG ``` -Animated Portable Network Graphic (.apng) is extension of PNG format that support animation. Learn more about this file format [here][]. +Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/apng @@ -819,7 +839,7 @@ public static final FileType BMP ``` -Bitmap Image File (.bmp) is used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format [here][]. +Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images. These images are independent of the graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/bmp @@ -830,7 +850,7 @@ public static final FileType ICO ``` -Icon File (.ico) are image file types used as icon for representation of an application on Microsoft Windows. Learn more about this file format [here][]. +Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/ico @@ -841,7 +861,7 @@ public static final FileType TGA ``` -Truevision TGA (Truevision Advanced Raster Adapter - TARGA) is used to store bitmap digital images developed by TRUEVISION. Learn more about this file format [here][]. +Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/tga @@ -852,7 +872,7 @@ public static final FileType JP_2 ``` -JPEG 2000 Core Image File (.jp2) is an image coding system and state-of-the-art image compression standard. Learn more about this file format [here][]. +Represents a JPEG 2000 Core Image File (.jp2), which is an image coding system and state-of-the-art image compression standard. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/jp2 @@ -863,7 +883,10 @@ public static final FileType JPF ``` -JPEG 2000 Image File (.jpf) +Represents a JPEG 2000 Image File (.jpf). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/image/jpf ### JPX {#JPX} ``` @@ -871,7 +894,10 @@ public static final FileType JPX ``` -JPEG 2000 Image File (.jpx) +Represents a JPEG 2000 Image File (.jpx). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/image/jpx ### JPM {#JPM} ``` @@ -879,7 +905,10 @@ public static final FileType JPM ``` -JPEG 2000 Image File (.jpm) +Represents a JPEG 2000 Image File (.jpm). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/image/jpm ### J2C {#J2C} ``` @@ -887,7 +916,10 @@ public static final FileType J2C ``` -JPEG 2000 Code InputStream (.j2c) +Represents a JPEG 2000 Code InputStream (.j2c). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/image/j2c ### J2K {#J2K} ``` @@ -895,7 +927,7 @@ public static final FileType J2K ``` -JPEG 2000 Code Stream (.j2k) is an image that is compressed using the wavelet compression instead of DCT compression. Learn more about this file format [here][]. +Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/j2k @@ -906,7 +938,10 @@ public static final FileType JPC ``` -JPEG 2000 Code InputStream (.jpc) +Represents a JPEG 2000 Code Stream (.jpc). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/image/jpc ### JLS {#JLS} ``` @@ -914,7 +949,10 @@ public static final FileType JLS ``` -JPEG-LS (JLS) (.jls) +Represents a JPEG-LS (JLS) file (.jls). Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/jls ### DIB {#DIB} ``` @@ -922,7 +960,10 @@ public static final FileType DIB ``` -Device Independent Bitmap File (.dib) +Represents a Device Independent Bitmap File (.dib). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/image/dib ### WMF {#WMF} ``` @@ -930,7 +971,7 @@ public static final FileType WMF ``` -Windows Metafile (.wmf) represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. Learn more about this file format [here][]. +Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/wmf @@ -941,7 +982,7 @@ public static final FileType WMZ ``` -ompressed Windows Metafile (.wmz) represents Microsoft Windows Metafile (WMF) compressed in GZIP archvive - for storing vector as well as bitmap-format images data. Learn more about this file format [here][]. +Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/wmz#compressed_windows_metafile @@ -952,7 +993,7 @@ public static final FileType EMF ``` -Enhanced Windows Metafile (.emf) represents graphical images device-independently. Metafiles of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format [here][]. +Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently. Metafiles of EMF comprise variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/emf @@ -963,7 +1004,7 @@ public static final FileType EMZ ``` -Enhanced Windows Metafile compressed (.emz) represents graphical images device-independently compressed by GZIP. Metafiles of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format [here][]. +Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP. Metafiles of EMF comprise variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/emz @@ -974,7 +1015,7 @@ public static final FileType WEBP ``` -WebP Image (.webp) is a modern raster web image file format that is based on lossless and lossy compression. It provides same image quality while considerably reducing the image size. Learn more about this file format [here][]. +Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression. It provides the same image quality while considerably reducing the image size. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/webp @@ -985,7 +1026,7 @@ public static final FileType DNG ``` -Digital Negative Specification (.dng) is a digital camera image format used for the storage of raw files. It has been developed by Adobe in September 2004. It was basically developed for digital photography. Learn more about this file format [here][]. +Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files. It was developed by Adobe in September 2004 and is primarily used for digital photography. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/dng @@ -996,7 +1037,7 @@ public static final FileType CDR ``` -CorelDraw Vector Graphic Drawing (.cdr) is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. Such a drawing file contains text, lines, shapes, images, colours and effects for vector representation of image contents. Learn more about this file format [here][]. +Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images. A CDR drawing file contains text, lines, shapes, images, colors, and effects for vector representation of image contents. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/cdr @@ -1007,7 +1048,7 @@ public static final FileType CMX ``` -Corel Exchange (.cmx) is a drawing image file that may contain vector graphics as well as bitmap graphics. Learn more about this file format [here][]. +Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/cmx @@ -1018,7 +1059,7 @@ public static final FileType DJVU ``` -DjVu Image (.djvu) is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. Learn more about this file format [here][]. +Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/djvu @@ -1029,7 +1070,7 @@ public static final FileType CGM ``` -Computer Graphics Metafile (.cgm) is a free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. CGM uses object-oriented approach and many function provisions for image production. Learn more about this file format [here][]. +Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text. CGM uses an object-oriented approach and provides many functions for image production. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/page-description-language/cgm @@ -1040,7 +1081,10 @@ public static final FileType PCL ``` -Printer Command Language Document (.pcl) +Represents a Printer Command Language Document (.pcl). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/page-description-language/pcl ### PSD {#PSD} ``` @@ -1048,7 +1092,7 @@ public static final FileType PSD ``` -Adobe Photoshop Document (.psd) represents Adobe Photoshop's native file format used for graphics designing and development. Learn more about this file format [here][]. +Represents an Adobe Photoshop Document (.psd), which is Adobe Photoshop's native file format used for graphics designing and development. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/psd @@ -1059,7 +1103,7 @@ public static final FileType PSB ``` -Photoshop Large Document Format (.psb) represents Photoshop Large Document Format used for graphics designing and development. Learn more about this file format [here][]. +Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/psb @@ -1070,7 +1114,7 @@ public static final FileType DCM ``` -DICOM Image (.dcm) represents digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format [here][]. +Represents a DICOM Image (.dcm), which represents a digital image that stores medical information of patients such as MRIs, CT scans, and ultrasound images. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/dcm @@ -1081,7 +1125,10 @@ public static final FileType PS ``` -PostScript File (.ps) +Represents a PostScript File (.ps). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/page-description-language/ps ### EPS {#EPS} ``` @@ -1089,7 +1136,7 @@ public static final FileType EPS ``` -Encapsulated PostScript File (.eps) describes an Encapsulated PostScript language program that describes the appearance of a single page. Learn more about this file format [here][]. +Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/page-description-language/eps @@ -1100,7 +1147,7 @@ public static final FileType ODG ``` -OpenDocument Graphic File (.odg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. Learn more about this file format [here][]. +Represents an OpenDocument Graphic File (.odg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/odg @@ -1111,7 +1158,7 @@ public static final FileType FODG ``` -Flat XML ODF Template (.fodg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. Learn more about this file format [here][]. +Represents a Flat XML ODF Template (.fodg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/image/fodg @@ -1122,7 +1169,7 @@ public static final FileType SVG ``` -Scalable Vector Graphics File (.svg) is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. Learn more about this file format [here][]. +Represents a Scalable Vector Graphics File (.svg), which is a Scalar Vector Graphics file that uses XML-based text format for describing the appearance of an image. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/page-description-language/svg @@ -1133,7 +1180,7 @@ public static final FileType SVGZ ``` -Scalable Vector Graphics File (.svgz) is a Scalar Vector Graphics file that uses XML based text format, compressed by GZIP for describing the appearance of an image. Learn more about this file format [here][]. +Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/svgz @@ -1144,7 +1191,10 @@ public static final FileType OTG ``` -OpenDocument Graphic Template (.otg) +Represents an OpenDocument Graphic Template (.otg). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/image/otg ### HTM {#HTM} ``` @@ -1152,7 +1202,7 @@ public static final FileType HTM ``` -Hypertext Markup Language File (.htm) is the extension for web pages created for display in browsers. Learn more about this file format [here][]. +Represents a Hypertext Markup Language File (.htm), which is the extension for web pages created for display in browsers. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/web/html @@ -1163,7 +1213,7 @@ public static final FileType HTML ``` -Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. Learn more about this file format [here][]. +Represents a Hypertext Markup Language File (.html), which is the extension for web pages created for display in browsers. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/web/html @@ -1174,7 +1224,10 @@ public static final FileType MHT ``` -MHTML Web Archive (.mht) +Represents an MHTML Web Archive (.mht). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/web/mht ### NSF {#NSF} ``` @@ -1182,7 +1235,10 @@ public static final FileType NSF ``` -Lotus Notes Database (.nsf) Learn more about this file format https://fileinfo.com/extension/nsf +Represents a Lotus Notes Database (.nsf). Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/nsf ### MBOX {#MBOX} ``` @@ -1190,7 +1246,7 @@ public static final FileType MBOX ``` -Email Mailbox File (.mbox). Learn more about this file format [here][]. +Represents an Email Mailbox File (.mbox). Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/mbox @@ -1201,7 +1257,10 @@ public static final FileType MHTML ``` -MIME HTML File (.mhtml) +Represents a MIME HTML File (.mhtml). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/web/mhtml ### XML {#XML} ``` @@ -1209,7 +1268,10 @@ public static final FileType XML ``` -XML File (.xml) +Represents an XML File (.xml). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/web/xml ### ONE {#ONE} ``` @@ -1217,7 +1279,7 @@ public static final FileType ONE ``` -OneNote Document (.one) is created by Microsoft OneNote application. OneNote lets you gather information using the application as if you are using your draftpad for taking notes. Learn more about this file format [here][]. +Represents a OneNote Document (.one) created by Microsoft OneNote application. OneNote lets you gather information using the application as if you are using your draftpad for taking notes. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/note-taking/one @@ -1228,7 +1290,7 @@ public static final FileType PDF ``` -Portable Document Format File (.pdf) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format [here][]. +Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s. The purpose of this file format was to introduce a standard for the representation of documents and other reference material in a format that is independent of application software, hardware, and operating systems. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/view/pdf @@ -1239,7 +1301,7 @@ public static final FileType XPS ``` -XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement of EMF file format and is similar to PDF file format, but uses XML in layout, appearance, and printing information of a document. Learn more about this file format [here][]. +Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement for the EMF file format and is similar to the PDF file format, but uses XML in the layout, appearance, and printing information of a document. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/page-description-language/xps @@ -1250,7 +1312,10 @@ public static final FileType OXPS ``` -OpenXPS File (.oxps) +Represents an OpenXPS File (.oxps). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/page-description-language/oxps ### TEX {#TEX} ``` @@ -1258,7 +1323,7 @@ public static final FileType TEX ``` -LaTeX Source Document (.tex) is a language that comprises of programming as well as mark-up features, used to typeset documents. Learn more about this file format [here][]. +Represents a LaTeX Source Document (.tex), which is a language that comprises programming as well as mark-up features used to typeset documents. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/page-description-language/tex @@ -1269,7 +1334,7 @@ public static final FileType PPT ``` -PowerPoint Presentation (.ppt) represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format [here][]. +Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a slideshow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/ppt @@ -1280,7 +1345,7 @@ public static final FileType PPTX ``` -PowerPoint Open XML Presentation (.pptx) are presentation files created with popular Microsoft PowerPoint application. Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based on the Microsoft PowerPoint open XML presentation file format. Learn more about this file format [here][]. +Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application. Unlike the previous version of the presentation file format PPT, which was binary, the PPTX format is based on the Microsoft PowerPoint Open XML presentation file format. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/pptx @@ -1291,7 +1356,7 @@ public static final FileType PPS ``` -PowerPoint Slide Show (.pps) are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003. Learn more about this file format [here][]. +Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes. PPS file reading and creation are supported by Microsoft PowerPoint 97-2003. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/pps @@ -1302,7 +1367,7 @@ public static final FileType PPSX ``` -PowerPoint Open XML Slide Show (.ppsx) files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here][]. +Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/ppsx @@ -1313,7 +1378,7 @@ public static final FileType ODP ``` -OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here][]. +Represents an OpenDocument Presentation (.odp), which represents a presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/odp @@ -1324,7 +1389,7 @@ public static final FileType FODP ``` -OpenDocument Presentation (.fodp) represents OpenDocument Flat XML Presentation. Learn more about this file format [here][]. +Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/fodp @@ -1335,7 +1400,7 @@ public static final FileType POT ``` -PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format [here][]. +Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/pot @@ -1346,7 +1411,7 @@ public static final FileType PPTM ``` -PowerPoint Open XML Macro-Enabled Presentation are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format [here][]. +Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/pptm @@ -1357,7 +1422,7 @@ public static final FileType POTX ``` -PowerPoint Open XML Presentation Template (.potx) represents Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. Learn more about this file format [here][]. +Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/potx @@ -1368,7 +1433,7 @@ public static final FileType POTM ``` -PowerPoint Open XML Macro-Enabled Presentation Template (.potm) are Microsoft PowerPoint template files with support for Macros. POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files. Learn more about this file format [here][]. +Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros. POTM files are created with PowerPoint 2007 or above and contain default settings that can be used to create further presentation files. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/potm @@ -1379,7 +1444,7 @@ public static final FileType PPSM ``` -PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format [here][]. +Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a macro-enabled slide show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/ppsm @@ -1390,7 +1455,7 @@ public static final FileType OTP ``` -OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here][]. +Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/presentation/otp @@ -1401,7 +1466,7 @@ public static final FileType XLS ``` -Excel Spreadsheet (.xls) represents Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format [here][]. +Represents an Excel Spreadsheet (.xls), which represents the Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xls @@ -1412,7 +1477,7 @@ public static final FileType EXCEL_2003_XML ``` -Excel 2003 XML (SpreadsheetML) represents Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format [here][]. +Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xls @@ -1423,7 +1488,7 @@ public static final FileType NUMBERS ``` -Apple numbers represents Excel like Binary File Format. Such files can be created by Apple numbers application. Learn more about this file format [here][]. +Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format. Such files can be created by Apple Numbers application. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/numbers @@ -1434,7 +1499,7 @@ public static final FileType XLSX ``` -Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format [here][]. +Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xlsx @@ -1445,7 +1510,7 @@ public static final FileType XLSM ``` -Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. Learn more about this file format [here][]. +Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xlsm @@ -1456,7 +1521,7 @@ public static final FileType XLSB ``` -Excel Binary Spreadsheet (.xlsb) specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. Learn more about this file format [here][]. +Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format. It is a collection of records and structures that specify Excel workbook content. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xlsb @@ -1467,7 +1532,7 @@ public static final FileType CSV ``` -Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. Learn more about this file format [here][]. +Represents a Comma Separated Values File (.csv), which represents plain text files that contain records of data with comma-separated values. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/csv @@ -1478,7 +1543,7 @@ public static final FileType TSV ``` -Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format [here][]. +Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/tsv @@ -1489,7 +1554,7 @@ public static final FileType ODS ``` -OpenDocument Spreadsheet (.ods) stands for OpenDocument Spreadsheet Document format that are editable by user. Data is stored inside ODF file into rows and columns. Learn more about this file format [here][]. +Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user. Data is stored inside ODF files in rows and columns. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/ods @@ -1500,7 +1565,10 @@ public static final FileType FODS ``` -OpenDocument Flat XML Spreadsheet (.fods) +Represents an OpenDocument Flat XML Spreadsheet (.fods). It is a spreadsheet document format based on XML used by OpenOffice and LibreOffice. Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/spreadsheet/fods ### OTS {#OTS} ``` @@ -1508,7 +1576,10 @@ public static final FileType OTS ``` -OpenDocument Spreadsheet Template (.ots) +Represents an OpenDocument Spreadsheet Template (.ots). It is a template document format used by OpenOffice and LibreOffice for spreadsheets. Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/spreadsheet/ots ### XLAM {#XLAM} ``` @@ -1516,7 +1587,10 @@ public static final FileType XLAM ``` -Microsoft Excel Add-in (.xlam) +Represents a Microsoft Excel Add-in (.xlam). It is a file format used by Microsoft Excel to create add-ins with custom functionality. Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/xlam ### XLTM {#XLTM} ``` @@ -1524,7 +1598,7 @@ public static final FileType XLTM ``` -Microsoft Excel Macro-Enabled Template (.xltm) represents files that are generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure other than that the later doesn't support creating template files with macros. Learn more about this file format [here][]. +Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure except that the latter doesn't support creating template files with macros. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xltm @@ -1535,7 +1609,7 @@ public static final FileType XLT ``` -Microsoft Excel Template (.xlt) are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening these. Learn more about this file format [here][]. +Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening them. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xlt @@ -1546,7 +1620,7 @@ public static final FileType XLTX ``` -Excel Open XML Spreadsheet Template (.xltx) represents Microsoft Excel Template that are based on the Office OpenXML file format specifications. It is used to create a standard template file that can be utilized to generate XLSX files that exhibit the same settings as specified in the XLTX file. Learn more about this file format [here][]. +Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates based on the Office OpenXML file format specifications. It is used to create a standard template file that can be utilized to generate XLSX files with the same settings specified in the XLTX file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/spreadsheet/xltx @@ -1557,7 +1631,10 @@ public static final FileType SXC ``` -StarOffice Calc Spreadsheet (.sxc) +Represents a StarOffice Calc Spreadsheet (.sxc). It is a spreadsheet document created with StarOffice Calc, a spreadsheet program. Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/spreadsheet/sxc ### MPP {#MPP} ``` @@ -1565,7 +1642,7 @@ public static final FileType MPP ``` -Microsoft Project File (.mpp) is Microsoft Project data file that stores information related to project management in an integrated manner. Learn more about this file format [here][]. +Represents a Microsoft Project File (.mpp), which is a Microsoft Project data file that stores information related to project management in an integrated manner. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/project-management/mpp @@ -1576,7 +1653,7 @@ public static final FileType MPT ``` -Microsoft Project Template (.mpt) contains basic information and structure along with document settings for creating .MPP files. Learn more about this file format [here][]. +Represents a Microsoft Project Template (.mpt), which contains basic information and structure along with document settings for creating .MPP files. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/project-management/mpt @@ -1587,7 +1664,7 @@ public static final FileType MPX ``` -Microsoft Project Exchange file (.mpx) is an ASCII file format for transferring of project information between Microsoft Project (MSP) and other applications that support the MPX file format such as Primavera Project Planner, Sciforma and Timerline Precision Estimating. Learn more about this file format [here][]. +Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring project information between Microsoft Project (MSP) and other applications that support the MPX file format, such as Primavera Project Planner, Sciforma, and Timerline Precision Estimating. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/project-management/mpx @@ -1598,7 +1675,10 @@ public static final FileType AS ``` -ActionScript File (.as) +Represents an ActionScript File (.as). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/as ### AS_3 {#AS-3} ``` @@ -1606,7 +1686,10 @@ public static final FileType AS_3 ``` -ActionScript File (.as) +Represents an ActionScript File (.as3). Learn more about this file format [here][]. + + +[here]: https://datatypes.net/open-as3-files ### ASM {#ASM} ``` @@ -1614,7 +1697,10 @@ public static final FileType ASM ``` -Assembly Language Source Code File (.asm) +Represents an Assembly Language Source Code File (.asm). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/cad/asm ### BAT {#BAT} ``` @@ -1622,7 +1708,10 @@ public static final FileType BAT ``` -DOS Batch File (.bat) +Represents a DOS Batch File (.bat). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/executable/bat ### C {#C} ``` @@ -1630,7 +1719,10 @@ public static final FileType C ``` -C/C++ Source Code File (.c) +Represents a C/C++ Source Code File (.c). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/c ### CC {#CC} ``` @@ -1638,7 +1730,10 @@ public static final FileType CC ``` -C++ Source Code File (.cc) +Represents a C++ Source Code File (.cc). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/cc ### CMAKE {#CMAKE} ``` @@ -1646,7 +1741,10 @@ public static final FileType CMAKE ``` -CMake File (.cmake) +Represents a CMake File (.cmake). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/cmake ### CPP {#CPP} ``` @@ -1654,7 +1752,10 @@ public static final FileType CPP ``` -C++ Source Code File (.cpp) +Represents a C++ Source Code File (.cpp). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/cpp ### CS {#CS} ``` @@ -1662,7 +1763,7 @@ public static final FileType CS ``` -C\# Source Code File (.cs) is a source code file for C\# programming language. Introduced by Microsoft for use with the .NET Framework. Learn more about this file format [here][]. +Represents a C\# Source Code File (.cs), which is a source code file for the C\# programming language. It was introduced by Microsoft for use with the .NET Framework. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/programming/cs @@ -1673,7 +1774,7 @@ public static final FileType VB ``` -Visual Basic Project Item File (.vb) is a source code file created in Visual Basic language that was created by Microsoft for development of .NET applications. Learn more about this file format [here][]. +Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language. It was created by Microsoft for the development of .NET applications. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/programming/vb @@ -1684,7 +1785,10 @@ public static final FileType CSS ``` -Cascading Style Sheet (.css) +Represents a Cascading Style Sheet (.css) file. Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/web/css ### CXX {#CXX} ``` @@ -1692,7 +1796,10 @@ public static final FileType CXX ``` -C++ Source Code File (.cxx) +Represents a C++ Source Code File (.cxx). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/cxx ### DIFF {#DIFF} ``` @@ -1700,7 +1807,10 @@ public static final FileType DIFF ``` -Patch File (.diff) +Represents a Patch File (.diff). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/diff ### ERB {#ERB} ``` @@ -1708,7 +1818,10 @@ public static final FileType ERB ``` -Ruby ERB Script (.erb) +Represents a Ruby ERB Script (.erb). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/erb ### GROOVY {#GROOVY} ``` @@ -1716,7 +1829,10 @@ public static final FileType GROOVY ``` -Groovy Source Code File (.groovy) +Represents a Groovy Source Code File (.groovy). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/groovy ### H {#H} ``` @@ -1724,7 +1840,10 @@ public static final FileType H ``` -C/C++/Objective-C Header File (.h) +Represents a C/C++/Objective-C Header File (.h). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/h ### HAML {#HAML} ``` @@ -1732,7 +1851,10 @@ public static final FileType HAML ``` -Haml Source Code File (.haml) +Represents a Haml Source Code File (.haml). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/haml ### HH {#HH} ``` @@ -1740,7 +1862,10 @@ public static final FileType HH ``` -C++ Header File (.hh) +Represents a C++ Header File (.hh). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/hh ### JAVA {#JAVA} ``` @@ -1748,7 +1873,10 @@ public static final FileType JAVA ``` -Java Source Code File (.java) +Represents a Java Source Code File (.java). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/java ### JS {#JS} ``` @@ -1756,7 +1884,10 @@ public static final FileType JS ``` -JavaScript File (.js) +Represents a JavaScript File (.js). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/web/js ### JSON {#JSON} ``` @@ -1764,7 +1895,10 @@ public static final FileType JSON ``` -JavaScript Object Notation File (.json) +Represents a JavaScript Object Notation File (.json). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/web/json ### LESS {#LESS} ``` @@ -1772,7 +1906,10 @@ public static final FileType LESS ``` -LESS Style Sheet (.less) +Represents a LESS Style Sheet (.less) file. Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/web/less ### LOG {#LOG} ``` @@ -1780,7 +1917,10 @@ public static final FileType LOG ``` -Log File (.log) +Represents a Log File (.log). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/database/log ### M {#M} ``` @@ -1788,7 +1928,10 @@ public static final FileType M ``` -Objective-C Implementation File (.m) +Represents an Objective-C Implementation File (.m). Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/m ### MAKE {#MAKE} ``` @@ -1796,7 +1939,10 @@ public static final FileType MAKE ``` -Xcode Makefile Script (.make) +Represents an Xcode Makefile Script (.make). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/make ### MD {#MD} ``` @@ -1804,7 +1950,10 @@ public static final FileType MD ``` -Markdown Documentation File (.md) +Represents a Markdown Documentation File (.md). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/word-processing/md ### ML {#ML} ``` @@ -1812,7 +1961,10 @@ public static final FileType ML ``` -ML Source Code File (.ml) +Represents an ML Source Code File (.ml). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/ml ### MM {#MM} ``` @@ -1820,7 +1972,10 @@ public static final FileType MM ``` -Objective-C++ Source File (.mm) +Represents an Objective-C++ Source File (.mm). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/mm ### PHP {#PHP} ``` @@ -1828,7 +1983,10 @@ public static final FileType PHP ``` -PHP Source Code File (.php) +Represents a PHP Source Code File (.php). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/programming/php ### PL {#PL} ``` @@ -1836,7 +1994,10 @@ public static final FileType PL ``` -Perl Script (.pl) +Represents a Perl Script (.pl). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/pl ### PROPERTIES {#PROPERTIES} ``` @@ -1844,7 +2005,10 @@ public static final FileType PROPERTIES ``` -Java Properties File (.properties) +Represents a Java Properties File (.properties). Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/properties ### PY {#PY} ``` @@ -1852,7 +2016,10 @@ public static final FileType PY ``` -Python Script (.py) +Represents a Python Script (.py). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/py ### RB {#RB} ``` @@ -1860,7 +2027,10 @@ public static final FileType RB ``` -Ruby Source Code (.rb) +Represents a Ruby Source Code (.rb) file. Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/rb ### RST {#RST} ``` @@ -1868,7 +2038,10 @@ public static final FileType RST ``` -reStructuredText File (.rst) +Represents a reStructuredText File (.rst). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/rst ### SASS {#SASS} ``` @@ -1876,7 +2049,10 @@ public static final FileType SASS ``` -Syntactically Awesome StyleSheets File (.sass) +Represents a Syntactically Awesome StyleSheets File (.sass). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/web/sass ### SCALA {#SCALA} ``` @@ -1884,7 +2060,10 @@ public static final FileType SCALA ``` -Scala Source Code File (.scala) +Represents a Scala Source Code File (.scala). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/scala ### SCM {#SCM} ``` @@ -1892,7 +2071,10 @@ public static final FileType SCM ``` -Scheme Source Code File (.scm) +Represents a Scheme Source Code File (.scm). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/scm ### SCRIPT {#SCRIPT} ``` @@ -1900,7 +2082,10 @@ public static final FileType SCRIPT ``` -Generic Script File (.script) +Represents a Generic Script File (.script). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/script ### SH {#SH} ``` @@ -1908,7 +2093,10 @@ public static final FileType SH ``` -Bash Shell Script (.sh) +Represents a Bash Shell Script (.sh). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/cs/programming/sh ### SML {#SML} ``` @@ -1916,7 +2104,10 @@ public static final FileType SML ``` -Standard ML Source Code File (.sml) +Represents a Standard ML Source Code File (.sml). Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/sml ### SQL {#SQL} ``` @@ -1924,7 +2115,10 @@ public static final FileType SQL ``` -Structured Query Language Data File (.sql) +Represents a Structured Query Language Data File (.sql). Learn more about this file format [here][]. + + +[here]: https://wiki.fileformat.com/database/sql ### VIM {#VIM} ``` @@ -1932,7 +2126,10 @@ public static final FileType VIM ``` -Vim Settings File (.vim) +Represents a Vim Settings File (.vim). Learn more about this file format [here][]. + + +[here]: https://fileinfo.com/extension/vim ### YAML {#YAML} ``` @@ -1940,7 +2137,10 @@ public static final FileType YAML ``` -YAML Document (.yaml) +Represents a YAML Document (.yaml). Learn more about this file format [here][]. + + +[here]: https://docs.fileformat.com/programming/yaml ### DOC {#DOC} ``` @@ -1948,7 +2148,7 @@ public static final FileType DOC ``` -Microsoft Word Document (.doc) represents documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here][]. +Represents a Microsoft Word Document (.doc) file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/doc @@ -1959,7 +2159,7 @@ public static final FileType DOCX ``` -Microsoft Word Open XML Document (.docx) is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files. Learn more about this file format [here][]. +Represents a Microsoft Word Open XML Document (.docx) file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/docx @@ -1970,10 +2170,10 @@ public static final FileType CHM ``` -Microsoft Compiled HTML Help File (.chm) is a well-known format for HELP (documentation to some application) documents. Learn more about this file format [here][]. +Represents a Microsoft Compiled HTML Help File (.chm). Learn more about this file format [here][]. -[here]: https://docs.fileformat.com/web/chm/ +[here]: https://docs.fileformat.com/web/chm ### DOCM {#DOCM} ``` @@ -1981,7 +2181,7 @@ public static final FileType DOCM ``` -Word Open XML Macro-Enabled Document (.docm) is a Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format [here][]. +Represents a Word Open XML Macro-Enabled Document (.docm) file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/docm @@ -1992,7 +2192,7 @@ public static final FileType DOT ``` -Word Document Template (.dot) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. Learn more about this file format [here][]. +Represents a Word Document Template (.dot) file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/dot @@ -2003,7 +2203,7 @@ public static final FileType DOTX ``` -Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. Learn more about this file format [here][]. +Represents a Word Open XML Document Template (.dotx) file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/dotx @@ -2014,7 +2214,7 @@ public static final FileType DOTM ``` -Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here][]. +Represents a Word Open XML Macro-Enabled Document Template (.dotm) file. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/dotm @@ -2025,7 +2225,7 @@ public static final FileType RTF ``` -Rich Text Format File (.rtf) represents a method of encoding formatted text and graphics for use within applications. Learn more about this file format [here][]. +Represents a Rich Text Format File (.rtf). Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/rtf @@ -2036,7 +2236,7 @@ public static final FileType TXT ``` -Plain Text File (.txt) represents a text document that contains plain text in the form of lines. Learn more about this file format [here][]. +Represents a Plain Text File (.txt). Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/txt @@ -2047,7 +2247,7 @@ public static final FileType ODT ``` -OpenDocument Text Document (.odt) are type of documents created with word processing applications that are based on OpenDocument Text File format. Learn more about this file format [here][]. +Represents an OpenDocument Text Document (.odt). Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/odt @@ -2058,7 +2258,7 @@ public static final FileType OTT ``` -OpenDocument Document Template (.ott) represents template documents generated by applications in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here][]. +Represents an OpenDocument Document Template (.ott). It is a template document generated in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/word-processing/ott @@ -2069,7 +2269,7 @@ public static final FileType VCF ``` -vCard File (.vcf) is a digital file format for storing contact information. The format is widely used for data interchange among popular information exchange applications. Learn more about this file format [here][]. +Represents a vCard File (.vcf), which is a digital file format for storing contact information. It is widely used for data interchange among popular information exchange applications. Learn more about this file format [here][]. [here]: https://wiki.fileformat.com/email/vcf @@ -2080,10 +2280,10 @@ public static final FileType AI ``` -Adobe Illustrator (.ai) is a file format for Adobe Illustrator drawings. Learn more about this file format [here][]. +Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings. Learn more about this file format [here][]. -[here]: https://fileinfo.com/extension/ai#adobe_illustrator_file +[here]: https://docs.fileformat.com/image/ai ### PSM1 {#PSM1} ``` @@ -2091,9 +2291,7 @@ public static final FileType PSM1 ``` -PowerShell script module (.psm1) a file format for PowerShell module scripts. - -Learn more about this file format [here][]. +Represents a PowerShell script module file (.psm1). It is a file format for PowerShell module scripts. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/psm1 @@ -2104,9 +2302,7 @@ public static final FileType PS1 ``` -PowerShell script file (.ps1) a file format for Windows PowerShell Cmdlet files. - -Learn more about this file format [here][]. +Represents a PowerShell script file (.ps1). It is a file format for Windows PowerShell Cmdlet files. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/ps1 @@ -2117,9 +2313,7 @@ public static final FileType PSD1 ``` -PowerShell script module manifest (.psd1) a file format for PowerShell module manifest scripts. - -Learn more about this file format [here][]. +Represents a PowerShell script module manifest file (.psd1). It is a file format for PowerShell module manifest scripts. Learn more about this file format [here][]. [here]: https://fileinfo.com/extension/psd1 @@ -2155,22 +2349,26 @@ public static FileType fromExtension(String extension) ``` -Maps file extension to file type. +Maps a file extension to a file type. + +This method takes a file extension, with or without the period ".", and returns the corresponding file type if it is supported. If the file type is not supported, it returns the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| extension | java.lang.String | File extension with or without the period "." | +| extension | java.lang.String | The file extension with or without the period ".". | **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) - When file type is supported returns it, otherwise returns default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. +[FileType](../../com.groupdocs.viewer/filetype) - the corresponding file type if supported, otherwise the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. ### fromFilePath(String filePath) {#fromFilePath-java.lang.String-} ``` public static FileType fromFilePath(String filePath) ``` -Extracts file extension and maps it to file type. +Extracts the file extension from a file name or file path and maps it to a file type. + +If the file type is supported, the method returns the corresponding FileType , otherwise it returns the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. **Parameters:** | Parameter | Type | Description | @@ -2178,127 +2376,150 @@ Extracts file extension and maps it to file type. | filePath | java.lang.String | The file name or file path. | **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) - When file type is supported returns it, otherwise returns default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. +[FileType](../../com.groupdocs.viewer/filetype) - the corresponding file type if supported, otherwise the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. ### fromMediaType(String mediaType) {#fromMediaType-java.lang.String-} ``` public static FileType fromMediaType(String mediaType) ``` -Maps file media type to file type e.g. 'application/pdf' will be mapped to [FileType](../../com.groupdocs.viewer/filetype).PDF. +Maps a file media type to a file type. For example, 'application/pdf' will be mapped to [PDF](../../com.groupdocs.viewer/filetype\#PDF). + +This method takes a file media type as input and maps it to the corresponding FileType . If the media type is supported, the method returns the corresponding file type. If the media type is not supported, it returns the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| mediaType | java.lang.String | File media type e.g. application/pdf. | +| mediaType | java.lang.String | The file media type, e.g., 'application/pdf'. | **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) - Returns corresponding media type when found, otherwise returns default Unknown file type. +[FileType](../../com.groupdocs.viewer/filetype) - the corresponding file type if found, otherwise the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. ### fromStream(InputStream stream) {#fromStream-java.io.InputStream-} ``` public static FileType fromStream(InputStream stream) ``` -Detects file type by reading the file signature. +Detects the file type by reading the file signature. + +This method takes an input stream representing a file and tries to detect its file type by analyzing the file signature. The file signature is a unique sequence of bytes at the beginning of the file that indicates its file type. The method reads the file signature from the input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| stream | java.io.InputStream | The file stream. | +| stream | java.io.InputStream | The input stream representing the file. | **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) +[FileType](../../com.groupdocs.viewer/filetype) - the detected file type if successful, otherwise the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. ### fromStream(InputStream stream, String password) {#fromStream-java.io.InputStream-java.lang.String-} ``` public static FileType fromStream(InputStream stream, String password) ``` -Detects file type by reading the file signature. +Detects the file type by reading the file signature. + +This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. + +If the file is encrypted and requires a password to open, the password should be provided as a parameter to this method. The password will be used to decrypt the file and analyze its signature for determining the file type. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| stream | java.io.InputStream | The file stream. | +| stream | java.io.InputStream | The input stream representing the file. | | password | java.lang.String | The password to open the file. | **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) +[FileType](../../com.groupdocs.viewer/filetype) - the detected file type if successful, otherwise the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. ### fromStream(InputStream stream, ILogger logger) {#fromStream-java.io.InputStream-com.groupdocs.foundation.logging.ILogger-} ``` public static FileType fromStream(InputStream stream, ILogger logger) ``` -Detects file type by reading the file signature. +Detects the file type by reading the file signature. + +This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. + +A logger can be provided to log any relevant information or errors during the file type detection process. The logger should implement the ILogger interface. If no logger is provided, the detection process will not produce any log output. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| stream | java.io.InputStream | The file stream. | -| logger | com.groupdocs.foundation.logging.ILogger | The logger. | +| stream | java.io.InputStream | The input stream representing the file. | +| logger | com.groupdocs.foundation.logging.ILogger | The logger for logging information or errors. | **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) - Returns file type in case it was detected successfully otherwise returns default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. +[FileType](../../com.groupdocs.viewer/filetype) - the detected file type if successful, otherwise the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. ### fromStream(InputStream stream, String password, ILogger logger) {#fromStream-java.io.InputStream-java.lang.String-com.groupdocs.foundation.logging.ILogger-} ``` public static FileType fromStream(InputStream stream, String password, ILogger logger) ``` -Detects file type by reading the file signature. +Detects the file type by reading the file signature. + +This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. + +A password can be provided if the file is encrypted or protected. The password will be used to open the file before analyzing the file signature. If the file does not require a password, this parameter can be set to null. + +A logger can be provided to log any relevant information or errors during the file type detection process. The logger should implement the ILogger interface. If no logger is provided, the detection process will not produce any log output. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| stream | java.io.InputStream | The file stream. | +| stream | java.io.InputStream | The input stream representing the file. | | password | java.lang.String | The password to open the file. | -| logger | com.groupdocs.foundation.logging.ILogger | The logger. | +| logger | com.groupdocs.foundation.logging.ILogger | The logger for logging information or errors. | **Returns:** -[FileType](../../com.groupdocs.viewer/filetype) - Returns file type in case it was detected successfully otherwise returns default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. +[FileType](../../com.groupdocs.viewer/filetype) - the detected file type if successful, otherwise the default [UNKNOWN](../../com.groupdocs.viewer/filetype\#UNKNOWN) file type. ### getSupportedFileTypes() {#getSupportedFileTypes--} ``` public static List getSupportedFileTypes() ``` -Retrieves supported file types +Retrieves the supported file types. -**Returns:** -java.util.List - Returns sequence of supported file types **Learn more**Learn more about supported document formats: [Full list of supported file formats][]Learn more about getting supported file types in Java code: [How to get supported file types in code][] +This method returns a sequence of all the supported file types by the system. The file types represent various document formats that can be processed or recognized by the system. + + **Learn more** + + * Learn more about the supported document formats: [Full list of supported file formats][] [Full list of supported file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/ -[How to get supported file types in code]: https://docs.groupdocs.com/viewer/java/how-to-list-and-print-all-supported-file-types/ + +**Returns:** +java.util.List - a sequence of supported file types. ### getFileFormat() {#getFileFormat--} ``` public final String getFileFormat() ``` -File type name e.g. "Microsoft Word Document". +Gets the name of the file format, e.g., "Microsoft Word Document". **Returns:** -java.lang.String +java.lang.String - the name of the file format. ### getExtension() {#getExtension--} ``` public final String getExtension() ``` -Filename suffix (including the period ".") e.g. ".doc". +Gets the file extension suffix (including the period "."), e.g., ".doc". **Returns:** -java.lang.String +java.lang.String - the file extension suffix. ### toString() {#toString--} ``` public String toString() ``` -Returns a String that represents the current object. +Returns a string representation of the current object. **Returns:** -java.lang.String - A String that represents the current object. +java.lang.String - a string representation of the current object. diff --git a/english/java/com.groupdocs.viewer/license/_index.md b/english/java/com.groupdocs.viewer/license/_index.md index 30423ffc7..dfa351c25 100644 --- a/english/java/com.groupdocs.viewer/license/_index.md +++ b/english/java/com.groupdocs.viewer/license/_index.md @@ -1,7 +1,7 @@ --- title: License second_title: GroupDocs.Viewer for Java API Reference -description: Provides methods to license the component. +description: Provides methods to license the component and unlock its full functionality. type: docs weight: 10 url: /java/com.groupdocs.viewer/license/ @@ -12,10 +12,18 @@ java.lang.Object public class License ``` -Provides methods to license the component. Learn more about licensing [here][]. +Provides methods to license the component and unlock its full functionality. +The License class allows you to apply a valid license to the GroupDocs.Viewer component, enabling you to utilize all the features and remove any evaluation limitations. -[here]: https://purchase.groupdocs.com/faqs/licensing +Example usage: + +``` + + License license = new License(); + license.setLicense("path/to/license/file.lic"); + +``` ## Constructors | Constructor | Description | @@ -29,6 +37,7 @@ Provides methods to license the component. Learn more about licensing [here][]. | [setLicense(InputStream licenseStream)](#setLicense-java.io.InputStream-) | Licenses the component. | | [setLicense(Path licensePath)](#setLicense-java.nio.file.Path-) | Licenses the component. | | [setLicense(String licensePath)](#setLicense-java.lang.String-) | Licenses the component. | +| [setLicense(URL licenseUri)](#setLicense-java.net.URL-) | Licenses the component. | ### License() {#License--} ``` public License() @@ -51,11 +60,11 @@ public final void setLicense(InputStream licenseStream) Licenses the component. -***Note:** -The following example demonstrates how to set a license passing InputStream of the license file. More about licensing: [GroupDocs Licensing FAQ][] More about GroupDocs.Viewer licensing: [Evaluation Limitations and Licensing][]* +The following example demonstrates how to set a license passing InputStream of the license file. -**Example:** +For more information about licensing, please refer to the [GroupDocs Licensing FAQ][]. You can also find detailed information about GroupDocs.Viewer licensing in the [Evaluation Limitations and Licensing][] documentation. +**Example:** ``` @@ -82,6 +91,10 @@ public final void setLicense(Path licensePath) Licenses the component. +Sets the license for the component using the specified license path. + +**Note:** This method should be called before using any functionality of the component. + **Parameters:** | Parameter | Type | Description | | --- | --- | --- | @@ -95,8 +108,9 @@ public final void setLicense(String licensePath) Licenses the component. -**Example:** -The following example demonstrates how to set a license passing a path or url to the license file. +This method should be called before using any functionality. + +Example usage: ``` @@ -109,5 +123,20 @@ The following example demonstrates how to set a license passing a path or url to **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| licensePath | java.lang.String | The license file path or url. | +| licensePath | java.lang.String | The license path or url. | + +### setLicense(URL licenseUri) {#setLicense-java.net.URL-} +``` +public void setLicense(URL licenseUri) +``` + + +Licenses the component. + +This method should be called before using any functionality. + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| licenseUri | java.net.URL | The license URI. | diff --git a/english/java/com.groupdocs.viewer/metered/_index.md b/english/java/com.groupdocs.viewer/metered/_index.md index bb2d2793e..0537321ca 100644 --- a/english/java/com.groupdocs.viewer/metered/_index.md +++ b/english/java/com.groupdocs.viewer/metered/_index.md @@ -1,7 +1,7 @@ --- title: Metered second_title: GroupDocs.Viewer for Java API Reference -description: Provides methods for applying Metered license. +description: Provides methods for applying metered license to the GroupDocs.Viewer component. type: docs weight: 11 url: /java/com.groupdocs.viewer/metered/ @@ -12,12 +12,20 @@ java.lang.Object public class Metered ``` -Provides methods for applying [Metered][] license. More about licensing: [GroupDocs Licensing FAQ][] More about GroupDocs.Viewer licensing: [Evaluation Limitations and Licensing][] +Provides methods for applying metered license to the GroupDocs.Viewer component. +Metered licensing allows you to dynamically monitor and control the usage of GroupDocs.Viewer based on the number of document pages processed instead of a traditional per-server or per-developer license. This flexible licensing model is suitable for scenarios where the document processing requirements vary over time or when you want to pay only for what you use. -[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered -[GroupDocs Licensing FAQ]: https://purchase.groupdocs.com/faqs/licensing -[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/viewer/java/evaluation-limitations-and-licensing-of-groupdocs-viewer/ +Example usage: + +``` + + Metered metered = new Metered(); + metered.setMeteredKey(publicKey, privateKey); + // Perform document processing operations using GroupDocs.Viewer + // ... + +``` ## Constructors | Constructor | Description | @@ -27,9 +35,9 @@ Provides methods for applying [Metered][] license. More about licensing: [GroupD | Method | Description | | --- | --- | -| [getConsumptionQuantity()](#getConsumptionQuantity--) | Retrieves amount of MBs processed. | -| [getConsumptionCredit()](#getConsumptionCredit--) | Retrieves count of credits consumed. | -| [setMeteredKey(String publicKey, String privateKey)](#setMeteredKey-java.lang.String-java.lang.String-) | Activates product with Metered keys. | +| [getConsumptionQuantity()](#getConsumptionQuantity--) | Retrieves the amount of megabytes (MB) processed. | +| [getConsumptionCredit()](#getConsumptionCredit--) | Retrieves the count of credits consumed. | +| [setMeteredKey(String publicKey, String privateKey)](#setMeteredKey-java.lang.String-java.lang.String-) | Activates the product with Metered keys. | ### Metered() {#Metered--} ``` public Metered() @@ -42,10 +50,11 @@ public static double getConsumptionQuantity() ``` -Retrieves amount of MBs processed. +Retrieves the amount of megabytes (MB) processed. -**Example:** -Following example demonstrates how to retrieve amount of MBs processed. +This method returns the total amount of MB processed by the component. + +**Example:** ``` @@ -58,46 +67,50 @@ Following example demonstrates how to retrieve amount of MBs processed. ``` **Returns:** -double +double - the amount of MB processed. ### getConsumptionCredit() {#getConsumptionCredit--} ``` public static double getConsumptionCredit() ``` -Retrieves count of credits consumed. +Retrieves the count of credits consumed. -**Example:** -Following example demonstrates how to retrieve count of credits consumed. +This method returns the total count of credits consumed by the component. -``` +**Example:** - String publicKey = "Public Key"; - String privateKey = "Private Key"; +``` - Metered metered = new Metered(); - metered.setMeteredKey(publicKey, privateKey); - double creditsConsumed = Metered.getConsumptionCredit(); + String publicKey = "Public Key"; + String privateKey = "Private Key"; + Metered metered = new Metered(); + metered.setMeteredKey(publicKey, privateKey); + double creditsConsumed = Metered.getConsumptionCredit(); ``` **Returns:** -double +double - the count of credits consumed. ### setMeteredKey(String publicKey, String privateKey) {#setMeteredKey-java.lang.String-java.lang.String-} ``` public final void setMeteredKey(String publicKey, String privateKey) ``` -Activates product with Metered keys. +Activates the product with Metered keys. Following example demonstrates how to activate product with Metered keys. +**Example:** + ``` -String publicKey = "Public Key"; + + String publicKey = "Public Key"; String privateKey = "Private Key"; Metered metered = new Metered(); metered.setMeteredKey(publicKey, privateKey); + ``` **Parameters:** diff --git a/english/java/com.groupdocs.viewer/viewer/_index.md b/english/java/com.groupdocs.viewer/viewer/_index.md index 3e7ae7ea2..be7a33407 100644 --- a/english/java/com.groupdocs.viewer/viewer/_index.md +++ b/english/java/com.groupdocs.viewer/viewer/_index.md @@ -1,7 +1,7 @@ --- title: Viewer second_title: GroupDocs.Viewer for Java API Reference -description: Represents main class that controls document rendering process. +description: Represents the main class that controls the document rendering process. type: docs weight: 12 url: /java/com.groupdocs.viewer/viewer/ @@ -15,33 +15,45 @@ java.io.Closeable public class Viewer implements Closeable ``` -Represents main class that controls document rendering process. +Represents the main class that controls the document rendering process. + +The Viewer class is the entry point for rendering documents using the GroupDocs.Viewer component. It provides methods and options to load documents from various sources, customize the rendering process, and retrieve the rendered output in different formats. + +Example usage: + +``` + + try (Viewer viewer = new Viewer("source.pdf")) { + viewer.view(new PngViewOptions("result-page{0}.png")); + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [Viewer(InputStream fileStream)](#Viewer-java.io.InputStream-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(InputStream fileStream, boolean leaveOpen)](#Viewer-java.io.InputStream-boolean-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(InputStream fileStream, LoadOptions loadOptions)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-boolean-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(InputStream inputStream, ViewerSettings settings)](#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(InputStream inputStream, ViewerSettings settings, boolean leaveOpen)](#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-boolean-) | Initializes new instance of class. | -| [Viewer(InputStream inputStream, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(InputStream inputStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-boolean-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(URL url)](#Viewer-java.net.URL-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(URL url, LoadOptions loadOptions)](#Viewer-java.net.URL-com.groupdocs.viewer.options.LoadOptions-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(URL url, ViewerSettings settings)](#Viewer-java.net.URL-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.net.URL-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(FileReader fileReader, ViewerSettings settings)](#Viewer-com.groupdocs.viewer.interfaces.FileReader-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-com.groupdocs.viewer.interfaces.FileReader-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(String filePath)](#Viewer-java.lang.String-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(Path filePath)](#Viewer-java.nio.file.Path-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(String filePath, LoadOptions loadOptions)](#Viewer-java.lang.String-com.groupdocs.viewer.options.LoadOptions-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(Path filePath, LoadOptions loadOptions)](#Viewer-java.nio.file.Path-com.groupdocs.viewer.options.LoadOptions-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(String filePath, ViewerSettings settings)](#Viewer-java.lang.String-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(Path filePath, ViewerSettings settings)](#Viewer-java.nio.file.Path-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.lang.String-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | -| [Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.nio.file.Path-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | +| [Viewer(InputStream fileStream)](#Viewer-java.io.InputStream-) | Initializes a new instance of the Viewer class. | +| [Viewer(InputStream fileStream, boolean leaveOpen)](#Viewer-java.io.InputStream-boolean-) | Initializes a new instance of the Viewer class. | +| [Viewer(InputStream fileStream, LoadOptions loadOptions)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-) | Initializes a new instance of the Viewer class. | +| [Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-boolean-) | Initializes a new instance of the Viewer class. | +| [Viewer(InputStream fileStream, ViewerSettings settings)](#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)](#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-boolean-) | Initializes a new instance of the Viewer class. | +| [Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)](#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-boolean-) | Initializes new instance of Viewer class. | +| [Viewer(URL url)](#Viewer-java.net.URL-) | Initializes a new instance of the Viewer class. | +| [Viewer(URL url, LoadOptions loadOptions)](#Viewer-java.net.URL-com.groupdocs.viewer.options.LoadOptions-) | Initializes a new instance of the Viewer class. | +| [Viewer(URL url, ViewerSettings settings)](#Viewer-java.net.URL-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.net.URL-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(FileReader fileReader, ViewerSettings settings)](#Viewer-com.groupdocs.viewer.interfaces.FileReader-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-com.groupdocs.viewer.interfaces.FileReader-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(String filePath)](#Viewer-java.lang.String-) | Initializes a new instance of the Viewer class. | +| [Viewer(Path filePath)](#Viewer-java.nio.file.Path-) | Initializes a new instance of the Viewer class. | +| [Viewer(String filePath, LoadOptions loadOptions)](#Viewer-java.lang.String-com.groupdocs.viewer.options.LoadOptions-) | Initializes a new instance of the Viewer class. | +| [Viewer(Path filePath, LoadOptions loadOptions)](#Viewer-java.nio.file.Path-com.groupdocs.viewer.options.LoadOptions-) | Initializes a new instance of the Viewer class. | +| [Viewer(String filePath, ViewerSettings settings)](#Viewer-java.lang.String-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(Path filePath, ViewerSettings settings)](#Viewer-java.nio.file.Path-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.lang.String-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | +| [Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)](#Viewer-java.nio.file.Path-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-) | Initializes a new instance of the Viewer class. | ## Fields | Field | Description | @@ -54,22 +66,20 @@ Represents main class that controls document rendering process. | Method | Description | | --- | --- | -| [getViewInfo(ViewInfoOptions options)](#getViewInfo-com.groupdocs.viewer.options.ViewInfoOptions-) | Returns information about view and document specific information. | +| [getViewInfo(ViewInfoOptions options)](#getViewInfo-com.groupdocs.viewer.options.ViewInfoOptions-) | Returns information about the view and document specific information. | | [getAttachments()](#getAttachments--) | Returns attachments contained by the document. | -| [saveAttachment(Attachment attachment, OutputStream destination)](#saveAttachment-com.groupdocs.viewer.results.Attachment-java.io.OutputStream-) | Saves attachment file to destination stream. | -| [view(ViewOptions options)](#view-com.groupdocs.viewer.options.ViewOptions-) | Creates view of all document pages. | -| [view(ViewOptions options, int[] pageNumbers)](#view-com.groupdocs.viewer.options.ViewOptions-int...-) | Creates view of specific document pages. | -| [getFileInfo()](#getFileInfo--) | Returns information about file such as file-type and flag that indicates if file is encrypted. | -| [close()](#close--) | Releases file stream and managed internal resources. | -| [getLoadOptionsInternal()](#getLoadOptionsInternal--) | | -| [setLoadOptionsInternal(LoadOptions mLoadOptionsInternal)](#setLoadOptionsInternal-com.groupdocs.viewer.options.LoadOptions-) | | +| [saveAttachment(Attachment attachment, OutputStream destination)](#saveAttachment-com.groupdocs.viewer.results.Attachment-java.io.OutputStream-) | Saves an attachment file to the destination stream. | +| [view(ViewOptions options)](#view-com.groupdocs.viewer.options.ViewOptions-) | Creates a view of all document pages. | +| [view(ViewOptions options, int[] pageNumbers)](#view-com.groupdocs.viewer.options.ViewOptions-int...-) | Creates a view of specific document pages. | +| [getFileInfo()](#getFileInfo--) | Returns information about the file, such as file type and a flag that indicates if the file is encrypted. | +| [close()](#close--) | Releases the file stream and managed internal resources. | ### Viewer(InputStream fileStream) {#Viewer-java.io.InputStream-} ``` public Viewer(InputStream fileStream) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] @@ -79,7 +89,7 @@ More about file types supported by GroupDocs.Viewer: [Document formats supported **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileStream | java.io.InputStream | The method that returns readable stream. | +| fileStream | java.io.InputStream | The method that returns a readable stream. | ### Viewer(InputStream fileStream, boolean leaveOpen) {#Viewer-java.io.InputStream-boolean-} ``` @@ -87,9 +97,9 @@ public Viewer(InputStream fileStream, boolean leaveOpen) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -104,7 +114,7 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | Parameter | Type | Description | | --- | --- | --- | | fileStream | java.io.InputStream | The file stream. | -| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false | +| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. | ### Viewer(InputStream fileStream, LoadOptions loadOptions) {#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-} ``` @@ -112,9 +122,9 @@ public Viewer(InputStream fileStream, LoadOptions loadOptions) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -137,9 +147,9 @@ public Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -155,17 +165,17 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. | --- | --- | --- | | fileStream | java.io.InputStream | The file stream. | | loadOptions | [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) | The document load options. | -| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false | +| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. | -### Viewer(InputStream inputStream, ViewerSettings settings) {#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-} +### Viewer(InputStream fileStream, ViewerSettings settings) {#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-} ``` -public Viewer(InputStream inputStream, ViewerSettings settings) +public Viewer(InputStream fileStream, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -179,33 +189,42 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| inputStream | java.io.InputStream | The file stream | +| fileStream | java.io.InputStream | The file stream. | | settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The Viewer settings. | -### Viewer(InputStream inputStream, ViewerSettings settings, boolean leaveOpen) {#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-boolean-} +### Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen) {#Viewer-java.io.InputStream-com.groupdocs.viewer.ViewerSettings-boolean-} ``` -public Viewer(InputStream inputStream, ViewerSettings settings, boolean leaveOpen) +public Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen) ``` -Initializes new instance of class. +Initializes a new instance of the Viewer class. + + **Learn more** + + * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] + * More about GroupDocs.Viewer for Java features: [Developer Guide][] + + +[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats +[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| inputStream | java.io.InputStream | The file stream. | +| fileStream | java.io.InputStream | The file stream. | | settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The Viewer settings. | -| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false | +| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. | -### Viewer(InputStream inputStream, LoadOptions loadOptions, ViewerSettings settings) {#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-} +### Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings) {#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-} ``` -public Viewer(InputStream inputStream, LoadOptions loadOptions, ViewerSettings settings) +public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -219,19 +238,19 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| inputStream | java.io.InputStream | The file stream | +| fileStream | java.io.InputStream | The file stream. | | loadOptions | [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) | The document load options. | | settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The Viewer settings. | -### Viewer(InputStream inputStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen) {#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-boolean-} +### Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen) {#Viewer-java.io.InputStream-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-boolean-} ``` -public Viewer(InputStream inputStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen) +public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes new instance of Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -245,10 +264,10 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| inputStream | java.io.InputStream | The file stream. | +| fileStream | java.io.InputStream | The file stream. | | loadOptions | [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) | The document load options. | | settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The Viewer settings. | -| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false | +| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. | ### Viewer(URL url) {#Viewer-java.net.URL-} ``` @@ -256,7 +275,7 @@ public Viewer(URL url) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] @@ -266,7 +285,7 @@ More about file types supported by GroupDocs.Viewer: [Document formats supported **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| url | java.net.URL | A url to a file that should be loaded into Viewer. | +| url | java.net.URL | A URL to a file that should be loaded into the Viewer. | ### Viewer(URL url, LoadOptions loadOptions) {#Viewer-java.net.URL-com.groupdocs.viewer.options.LoadOptions-} ``` @@ -274,9 +293,9 @@ public Viewer(URL url, LoadOptions loadOptions) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -290,7 +309,7 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| url | java.net.URL | A url to a file that should be loaded into Viewer. | +| url | java.net.URL | A URL to a file that should be loaded into the Viewer. | | loadOptions | [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) | The document load options. | ### Viewer(URL url, ViewerSettings settings) {#Viewer-java.net.URL-com.groupdocs.viewer.ViewerSettings-} @@ -299,9 +318,9 @@ public Viewer(URL url, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -315,7 +334,7 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| url | java.net.URL | A url to a file that should be loaded into Viewer. | +| url | java.net.URL | A URL to a file that should be loaded into the Viewer. | | settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The Viewer settings. | ### Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings) {#Viewer-java.net.URL-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-} @@ -324,9 +343,9 @@ public Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -340,7 +359,7 @@ Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| url | java.net.URL | A url to a file that should be loaded into Viewer. | +| url | java.net.URL | A URL to a file that should be loaded into the Viewer. | | loadOptions | [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) | The document load options. | | settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The Viewer settings. | @@ -350,13 +369,24 @@ public Viewer(FileReader fileReader, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. + +This constructor allows you to create a Viewer object to view a document from a [FileReader](../../com.groupdocs.viewer.interfaces/filereader) with the specified [ViewerSettings](../../com.groupdocs.viewer/viewersettings). + + **Learn more** + + * To learn about the file types supported by GroupDocs.Viewer, visit: [Document formats supported by GroupDocs.Viewer][] + * To explore the features of GroupDocs.Viewer for Java, refer to: [Developer Guide][] + + +[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats +[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| fileReader | [FileReader](../../com.groupdocs.viewer.interfaces/filereader) | The file reader | -| settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The Viewer settings. | +| fileReader | [FileReader](../../com.groupdocs.viewer.interfaces/filereader) | The [FileReader](../../com.groupdocs.viewer.interfaces/filereader) containing the document to be loaded into the Viewer. | +| settings | [ViewerSettings](../../com.groupdocs.viewer/viewersettings) | The [ViewerSettings](../../com.groupdocs.viewer/viewersettings) to be applied to the Viewer. | ### Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings) {#Viewer-com.groupdocs.viewer.interfaces.FileReader-com.groupdocs.viewer.options.LoadOptions-com.groupdocs.viewer.ViewerSettings-} ``` @@ -364,7 +394,11 @@ public Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings set ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. + +Provides functionality to load and view documents using GroupDocs.Viewer. + +**Note:** Ensure that the file reader, load options, and settings are properly configured for accurate document processing. **Parameters:** | Parameter | Type | Description | @@ -379,10 +413,9 @@ public Viewer(String filePath) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more:** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -402,10 +435,9 @@ public Viewer(Path filePath) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -425,10 +457,9 @@ public Viewer(String filePath, LoadOptions loadOptions) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -451,19 +482,18 @@ public Viewer(Path filePath, LoadOptions loadOptions) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] - * More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: [How to load and view document with GroupDocs.Viewer][] + * More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: [How to load and view a document with GroupDocs.Viewer][] [Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats [Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide -[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading +[How to load and view a document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading **Parameters:** | Parameter | Type | Description | @@ -477,10 +507,9 @@ public Viewer(String filePath, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -501,10 +530,9 @@ public Viewer(Path filePath, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] @@ -525,19 +553,18 @@ public Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] - * More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: [How to load and view document with GroupDocs.Viewer][] + * More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: [How to load and view documents with GroupDocs.Viewer][] [Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats [Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide -[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading +[How to load and view documents with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading **Parameters:** | Parameter | Type | Description | @@ -552,19 +579,18 @@ public Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings) ``` -Initializes new instance of [Viewer](../../com.groupdocs.viewer/viewer) class. +Initializes a new instance of the Viewer class. -**Note:** -**Learn more** + **Learn more** * More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][] * More about GroupDocs.Viewer for Java features: [Developer Guide][] - * More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: [How to load and view document with GroupDocs.Viewer][] + * More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: [How to load and view documents with GroupDocs.Viewer][] [Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats [Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide -[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading +[How to load and view documents with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading **Parameters:** | Parameter | Type | Description | @@ -603,11 +629,11 @@ public final ViewInfo getViewInfo(ViewInfoOptions options) ``` -Returns information about view and document specific information. +Returns information about the view and document specific information. -**Learn more** + **Learn more:** - * Learn more about document - file type, pages count and other format specific properties: [How to get file information using GroupDocs.Viewer][] + * Learn more about the document - file type, page count, and other format specific properties: [How to get file information using GroupDocs.Viewer][] [How to get file information using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+file+information @@ -618,7 +644,7 @@ Returns information about view and document specific information. | options | [ViewInfoOptions](../../com.groupdocs.viewer.options/viewinfooptions) | The view info options. | **Returns:** -[ViewInfo](../../com.groupdocs.viewer.results/viewinfo) - Information about view and document specific information. +[ViewInfo](../../com.groupdocs.viewer.results/viewinfo) - Information about the view and document specific information. ### getAttachments() {#getAttachments--} ``` public final List getAttachments() @@ -627,32 +653,32 @@ public final List getAttachments() Returns attachments contained by the document. -**Learn more** + **Learn more:** - * Learn more about getting document attachments in Java: [How to get list of document attachments using GroupDocs.Viewer][] + * Learn more about getting document attachments in Java: [How to get a list of document attachments using GroupDocs.Viewer][] * Learn more about saving document attachments in Java: [How to save document attachments using GroupDocs.Viewer][] -[How to get list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments +[How to get a list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments [How to save document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Save+attachments **Returns:** -java.util.List - Attachments contained by the document. +java.util.List - attachments contained by the document. ### saveAttachment(Attachment attachment, OutputStream destination) {#saveAttachment-com.groupdocs.viewer.results.Attachment-java.io.OutputStream-} ``` public void saveAttachment(Attachment attachment, OutputStream destination) ``` -Saves attachment file to destination stream. +Saves an attachment file to the destination stream. -**Learn more** + **Learn more:** - * Learn more about getting document attachments in Java: [How to get list of document attachments using GroupDocs.Viewer][] + * Learn more about getting document attachments in Java: [How to get a list of document attachments using GroupDocs.Viewer][] * Learn more about saving document attachments in Java: [How to save document attachments using GroupDocs.Viewer][] -[How to get list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments +[How to get a list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments [How to save document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Save+attachments **Parameters:** @@ -667,11 +693,11 @@ public final void view(ViewOptions options) ``` -Creates view of all document pages. +Creates a view of all document pages. -**Learn more** + **Learn more** - * More about different viewing options following this guide: [How to customize document viewing output using GroupDocs.Viewer][] + * Learn more about different viewing options following this guide: [How to customize document viewing output using GroupDocs.Viewer][] [How to customize document viewing output using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Viewing @@ -687,11 +713,11 @@ public final void view(ViewOptions options, int[] pageNumbers) ``` -Creates view of specific document pages. +Creates a view of specific document pages. -**Learn more** + **Learn more** - * More about different viewing options following this guide: [How to customize document viewing output using GroupDocs.Viewer][] + * Learn more about different viewing options following this guide: [How to customize document viewing output using GroupDocs.Viewer][] [How to customize document viewing output using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Viewing @@ -708,41 +734,22 @@ public FileInfo getFileInfo() ``` -Returns information about file such as file-type and flag that indicates if file is encrypted. Learn more about file information: [How to check if file is encrypted][] - - -[How to check if file is encrypted]: https://docs.groupdocs.com/viewer/net/how-to-check-if-file-is-encrypted/ - -**Returns:** -[FileInfo](../../com.groupdocs.viewer.results/fileinfo) - The file information. -### close() {#close--} -``` -public final void close() -``` - - -Releases file stream and managed internal resources. +Returns information about the file, such as file type and a flag that indicates if the file is encrypted. -### getLoadOptionsInternal() {#getLoadOptionsInternal--} -``` -public LoadOptions getLoadOptionsInternal() -``` +**Learn more:** + * Learn more about how to check if a file is encrypted: [How to check if a file is encrypted][] +[How to check if a file is encrypted]: https://docs.groupdocs.com/viewer/net/how-to-check-if-file-is-encrypted/ **Returns:** -[LoadOptions](../../com.groupdocs.viewer.options/loadoptions) -### setLoadOptionsInternal(LoadOptions mLoadOptionsInternal) {#setLoadOptionsInternal-com.groupdocs.viewer.options.LoadOptions-} +[FileInfo](../../com.groupdocs.viewer.results/fileinfo) - the file information. +### close() {#close--} ``` -public void setLoadOptionsInternal(LoadOptions mLoadOptionsInternal) +public final void close() ``` - - -**Parameters:** -| Parameter | Type | Description | -| --- | --- | --- | -| mLoadOptionsInternal | [LoadOptions](../../com.groupdocs.viewer.options/loadoptions) | | +Releases the file stream and managed internal resources. diff --git a/english/java/com.groupdocs.viewer/viewersettings/_index.md b/english/java/com.groupdocs.viewer/viewersettings/_index.md index aae046f98..855e7a5ef 100644 --- a/english/java/com.groupdocs.viewer/viewersettings/_index.md +++ b/english/java/com.groupdocs.viewer/viewersettings/_index.md @@ -1,7 +1,7 @@ --- title: ViewerSettings second_title: GroupDocs.Viewer for Java API Reference -description: Defines settings for customizing behaviour. +description: Defines settings for customizing the behavior of the Viewer component. type: docs weight: 13 url: /java/com.groupdocs.viewer/viewersettings/ @@ -12,28 +12,45 @@ java.lang.Object public class ViewerSettings ``` -Defines settings for customizing [Viewer](../../com.groupdocs.viewer/viewer) behaviour. +Defines settings for customizing the behavior of the Viewer component. + +The ViewerSettings class provides options and properties to customize the behavior of the GroupDocs.Viewer component during the document rendering process. You can use this class to specify various settings, such as logger, custom cache implementation, and more. + +Example usage: + +``` + + final ViewerSettings viewerSettings = new ViewerSettings(); + viewerSettings.setLogger(new ConsoleLogger(false, true)); + + try (Viewer viewer = new Viewer("source.pdf", viewerSettings)) { + // Document processing + } + +``` ## Constructors | Constructor | Description | | --- | --- | -| [ViewerSettings(Cache cache, ILogger logger)](#ViewerSettings-com.groupdocs.viewer.caching.Cache-com.groupdocs.foundation.logging.ILogger-) | Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. | -| [ViewerSettings(ILogger logger)](#ViewerSettings-com.groupdocs.foundation.logging.ILogger-) | Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. | -| [ViewerSettings(Cache cache)](#ViewerSettings-com.groupdocs.viewer.caching.Cache-) | Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. | -| [ViewerSettings()](#ViewerSettings--) | Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. | +| [ViewerSettings(Cache cache, ILogger logger)](#ViewerSettings-com.groupdocs.viewer.caching.Cache-com.groupdocs.foundation.logging.ILogger-) | Initializes a new instance of the ViewerSettings class. | +| [ViewerSettings(ILogger logger)](#ViewerSettings-com.groupdocs.foundation.logging.ILogger-) | Initializes a new instance of the ViewerSettings class. | +| [ViewerSettings(Cache cache)](#ViewerSettings-com.groupdocs.viewer.caching.Cache-) | Initializes a new instance of the ViewerSettings class. | +| [ViewerSettings()](#ViewerSettings--) | Initializes a new instance of the ViewerSettings class. | ## Methods | Method | Description | | --- | --- | -| [getLogger()](#getLogger--) | The logger implementation used for logging (Errors, Warnings, Traces). | -| [getCache()](#getCache--) | The cache implementation used for storing rendering results. | +| [getLogger()](#getLogger--) | Gets the logger implementation used for logging (Errors, Warnings, Traces). | +| [setLogger(ILogger logger)](#setLogger-com.groupdocs.foundation.logging.ILogger-) | Sets the logger implementation used for logging (Errors, Warnings, Traces). | +| [getCache()](#getCache--) | Gets the cache implementation used for storing rendering results. | +| [setCache(Cache cache)](#setCache-com.groupdocs.viewer.caching.Cache-) | Sets the cache implementation used for storing rendering results. | ### ViewerSettings(Cache cache, ILogger logger) {#ViewerSettings-com.groupdocs.viewer.caching.Cache-com.groupdocs.foundation.logging.ILogger-} ``` public ViewerSettings(Cache cache, ILogger logger) ``` -Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. +Initializes a new instance of the ViewerSettings class. **Parameters:** | Parameter | Type | Description | @@ -47,7 +64,7 @@ public ViewerSettings(ILogger logger) ``` -Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. +Initializes a new instance of the ViewerSettings class. **Parameters:** | Parameter | Type | Description | @@ -60,7 +77,7 @@ public ViewerSettings(Cache cache) ``` -Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. +Initializes a new instance of the ViewerSettings class. **Parameters:** | Parameter | Type | Description | @@ -73,7 +90,7 @@ public ViewerSettings() ``` -Initializes new instance of [ViewerSettings](../../com.groupdocs.viewer/viewersettings) class. +Initializes a new instance of the ViewerSettings class. ### getLogger() {#getLogger--} ``` @@ -81,17 +98,43 @@ public ILogger getLogger() ``` -The logger implementation used for logging (Errors, Warnings, Traces). +Gets the logger implementation used for logging (Errors, Warnings, Traces). **Returns:** -com.groupdocs.foundation.logging.ILogger +com.groupdocs.foundation.logging.ILogger - the logger implementation. +### setLogger(ILogger logger) {#setLogger-com.groupdocs.foundation.logging.ILogger-} +``` +public void setLogger(ILogger logger) +``` + + +Sets the logger implementation used for logging (Errors, Warnings, Traces). + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| logger | com.groupdocs.foundation.logging.ILogger | The logger implementation to set. | + ### getCache() {#getCache--} ``` public final Cache getCache() ``` -The cache implementation used for storing rendering results. +Gets the cache implementation used for storing rendering results. **Returns:** -[Cache](../../com.groupdocs.viewer.caching/cache) +[Cache](../../com.groupdocs.viewer.caching/cache) - the cache implementation. +### setCache(Cache cache) {#setCache-com.groupdocs.viewer.caching.Cache-} +``` +public void setCache(Cache cache) +``` + + +Sets the cache implementation used for storing rendering results. + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| cache | [Cache](../../com.groupdocs.viewer.caching/cache) | The cache implementation. | +