Skip to content

Commit f721e25

Browse files
yevgen-nykytenkoyevgen-nykytenko
committed
Update file(s) "/." from "groupdocs-parser/Groupdocs.Parser-References"
1 parent 4f27140 commit f721e25

File tree

8 files changed

+347
-9
lines changed

8 files changed

+347
-9
lines changed

‎content/sites/groupdocs/parser/english/java/com.groupdocs.parser.exceptions/unsupporteddocumentformatexception/_index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Thrown during document load, when the document format is not recognized or not s
1818
| Constructor | Description |
1919
| --- | --- |
2020
| [UnsupportedDocumentFormatException()](#UnsupportedDocumentFormatException--) | Initializes a new instance of the [UnsupportedDocumentFormatException](../../com.groupdocs.parser.exceptions/unsupporteddocumentformatexception) class. |
21+
| [UnsupportedDocumentFormatException(String message)](#UnsupportedDocumentFormatException-java.lang.String-) | Initializes a new instance of the [UnsupportedDocumentFormatException](../../com.groupdocs.parser.exceptions/unsupporteddocumentformatexception) class with the message. |
2122
### UnsupportedDocumentFormatException() {#UnsupportedDocumentFormatException--}
2223
```
2324
public UnsupportedDocumentFormatException()
@@ -26,3 +27,16 @@ public UnsupportedDocumentFormatException()
2627

2728
Initializes a new instance of the [UnsupportedDocumentFormatException](../../com.groupdocs.parser.exceptions/unsupporteddocumentformatexception) class.
2829

30+
### UnsupportedDocumentFormatException(String message) {#UnsupportedDocumentFormatException-java.lang.String-}
31+
```
32+
public UnsupportedDocumentFormatException(String message)
33+
```
34+
35+
36+
Initializes a new instance of the [UnsupportedDocumentFormatException](../../com.groupdocs.parser.exceptions/unsupporteddocumentformatexception) class with the message.
37+
38+
**Parameters:**
39+
| Parameter | Type | Description |
40+
| --- | --- | --- |
41+
| message | java.lang.String | Error message. |
42+

‎content/sites/groupdocs/parser/english/java/com.groupdocs.parser.options/features/_index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@ An instance of this class is used as [Parser.getFeatures()](../../com.groupdocs.
5050
| [isParseByTemplate()](#isParseByTemplate--) | Gets the value that indicates whether parsing by template is supported. |
5151
| [isParseForm()](#isParseForm--) | Gets the value that indicates whether form parsing is supported. |
5252
| [isPreview()](#isPreview--) | Gets the value that indicates whether preview generation is supported. |
53+
| [isPagePreview()](#isPagePreview--) | Gets the value that indicates whether the page preview generation is supported. |
5354
| [isOcr()](#isOcr--) | Gets the value that indicates whether OCR functionality is supported. |
55+
| [isWorksheet()](#isWorksheet--) | Gets the value that indicates whether the worksheet extraction is supported. |
5456
### Features() {#Features--}
5557
```
5658
public Features()
@@ -252,6 +254,16 @@ Gets the value that indicates whether preview generation is supported.
252254

253255
**Returns:**
254256
boolean - true if preview generation is supported; otherwise, false .
257+
### isPagePreview() {#isPagePreview--}
258+
```
259+
public boolean isPagePreview()
260+
```
261+
262+
263+
Gets the value that indicates whether the page preview generation is supported.
264+
265+
**Returns:**
266+
boolean - true if the page preview generation is supported; otherwise, false .
255267
### isOcr() {#isOcr--}
256268
```
257269
public boolean isOcr()
@@ -262,3 +274,13 @@ Gets the value that indicates whether OCR functionality is supported.
262274

263275
**Returns:**
264276
boolean - true if OCR functionality is supported; otherwise, false .
277+
### isWorksheet() {#isWorksheet--}
278+
```
279+
public boolean isWorksheet()
280+
```
281+
282+
283+
Gets the value that indicates whether the worksheet extraction is supported.
284+
285+
**Returns:**
286+
boolean - true if the worksheet extraction is supported; otherwise, false .

‎content/sites/groupdocs/parser/english/java/com.groupdocs.parser.options/filetype/_index.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,11 @@ Represents the file type. Provides methods to obtain list of all file types supp
8585
| [OST](#OST) | OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration with Exchange Server using Microsoft Outlook. |
8686
| [ONE](#ONE) | File represented by .ONE extension are created by Microsoft OneNote application. |
8787
| [ZIP](#ZIP) | ZIP file extension represents archives that can hold one or more files or directories. |
88+
| [SEVENZ](#SEVENZ) | 7z is an archiving format for compressing files and folders with a high compression ratio. |
89+
| [RAR](#RAR) | Files with .rar extension represent archive files that are created for storing information in compressed or normal form. |
90+
| [TAR](#TAR) | Files with .tar extension are archives created with Unix-based utility for collecting one or more files. |
91+
| [GZ](#GZ) | Files with .gz extension are compressed files created with gzip compression application. |
92+
| [BZ2](#BZ2) | Compressed file using Bzip2 algorithm. |
8893
| [TIF](#TIF) | TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
8994
| [TIFF](#TIFF) | TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
9095
| [JPG](#JPG) | A JPG is a type of image format that is saved using the method of lossy compression. |
@@ -737,6 +742,58 @@ ZIP file extension represents archives that can hold one or more files or direct
737742

738743
[here]: https://wiki.fileformat.com/compression/zip/
739744

745+
### SEVENZ {#SEVENZ}
746+
```
747+
public static final FileType SEVENZ
748+
```
749+
750+
751+
7z is an archiving format for compressing files and folders with a high compression ratio. Learn more about this file format [here][].
752+
753+
754+
[here]: https://wiki.fileformat.com/compression/7z/
755+
756+
### RAR {#RAR}
757+
```
758+
public static final FileType RAR
759+
```
760+
761+
762+
Files with .rar extension represent archive files that are created for storing information in compressed or normal form. Learn more about this file format [here][].
763+
764+
765+
[here]: https://wiki.fileformat.com/compression/rar/
766+
767+
### TAR {#TAR}
768+
```
769+
public static final FileType TAR
770+
```
771+
772+
773+
Files with .tar extension are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here][].
774+
775+
776+
[here]: https://wiki.fileformat.com/compression/tar/
777+
778+
### GZ {#GZ}
779+
```
780+
public static final FileType GZ
781+
```
782+
783+
784+
Files with .gz extension are compressed files created with gzip compression application. Learn more about this file format [here][].
785+
786+
787+
[here]: https://wiki.fileformat.com/compression/gz/
788+
789+
### BZ2 {#BZ2}
790+
```
791+
public static final FileType BZ2
792+
```
793+
794+
795+
Compressed file using Bzip2 algorithm.
796+
740797
### TIF {#TIF}
741798
```
742799
public static final FileType TIF

‎content/sites/groupdocs/parser/english/java/com.groupdocs.parser.options/loadoptions/_index.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,16 @@ See the usage examples there.
4040
| [LoadOptions(FileFormat fileFormat, String password)](#LoadOptions-com.groupdocs.parser.options.FileFormat-java.lang.String-) | Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with default encodings. |
4141
| [LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset)](#LoadOptions-com.groupdocs.parser.options.FileFormat-java.lang.String-java.nio.charset.Charset-java.nio.charset.Charset-) | Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with custom encodings. |
4242
| [LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout)](#LoadOptions-com.groupdocs.parser.options.FileFormat-java.lang.String-java.nio.charset.Charset-java.nio.charset.Charset-java.time.Duration-) | Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) fully customized class. |
43+
| [LoadOptions(FileType fileType)](#LoadOptions-com.groupdocs.parser.options.FileType-) | Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with empty Password and default encodings. |
44+
| [LoadOptions(FileType fileType, String password)](#LoadOptions-com.groupdocs.parser.options.FileType-java.lang.String-) | Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with password and default encodings. |
45+
| [LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset)](#LoadOptions-com.groupdocs.parser.options.FileType-java.lang.String-java.nio.charset.Charset-java.nio.charset.Charset-) | Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with custom encodings. |
46+
| [LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout)](#LoadOptions-com.groupdocs.parser.options.FileType-java.lang.String-java.nio.charset.Charset-java.nio.charset.Charset-java.time.Duration-) | Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) fully customized class. |
4347
## Methods
4448

4549
| Method | Description |
4650
| --- | --- |
4751
| [getFileFormat()](#getFileFormat--) | Gets the file format. |
52+
| [getFileType()](#getFileType--) | Gets the file type. |
4853
| [getPassword()](#getPassword--) | Gets the password. |
4954
| [getCharset()](#getCharset--) | Gets the encoding of the document. |
5055
| [getDefaultAnsiCharset()](#getDefaultAnsiCharset--) | Gets the default ANSI encoding which is used for encoding detection. |
@@ -143,6 +148,66 @@ Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.optio
143148
| defaultAnsiCharset | java.nio.charset.Charset | The default ANSI encoding which is used for encoding detection. |
144149
| timeout | java.time.Duration | The Duration that represents the number of milliseconds to wait. |
145150

151+
### LoadOptions(FileType fileType) {#LoadOptions-com.groupdocs.parser.options.FileType-}
152+
```
153+
public LoadOptions(FileType fileType)
154+
```
155+
156+
157+
Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with empty Password and default encodings.
158+
159+
**Parameters:**
160+
| Parameter | Type | Description |
161+
| --- | --- | --- |
162+
| fileType | [FileType](../../com.groupdocs.parser.options/filetype) | The type of the file. |
163+
164+
### LoadOptions(FileType fileType, String password) {#LoadOptions-com.groupdocs.parser.options.FileType-java.lang.String-}
165+
```
166+
public LoadOptions(FileType fileType, String password)
167+
```
168+
169+
170+
Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with password and default encodings.
171+
172+
**Parameters:**
173+
| Parameter | Type | Description |
174+
| --- | --- | --- |
175+
| fileType | [FileType](../../com.groupdocs.parser.options/filetype) | The type of the file. |
176+
| password | java.lang.String | The password to open the password-protected file. |
177+
178+
### LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset) {#LoadOptions-com.groupdocs.parser.options.FileType-java.lang.String-java.nio.charset.Charset-java.nio.charset.Charset-}
179+
```
180+
public LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset)
181+
```
182+
183+
184+
Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) class with custom encodings.
185+
186+
**Parameters:**
187+
| Parameter | Type | Description |
188+
| --- | --- | --- |
189+
| fileType | [FileType](../../com.groupdocs.parser.options/filetype) | The type of the file. |
190+
| password | java.lang.String | The password to open the password-protected file. |
191+
| charset | java.nio.charset.Charset | The encoding of the document. |
192+
| defaultAnsiCharset | java.nio.charset.Charset | The default ANSI encoding which is used for encoding detection. |
193+
194+
### LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout) {#LoadOptions-com.groupdocs.parser.options.FileType-java.lang.String-java.nio.charset.Charset-java.nio.charset.Charset-java.time.Duration-}
195+
```
196+
public LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout)
197+
```
198+
199+
200+
Initializes a new instance of the [LoadOptions](../../com.groupdocs.parser.options/loadoptions) fully customized class.
201+
202+
**Parameters:**
203+
| Parameter | Type | Description |
204+
| --- | --- | --- |
205+
| fileType | [FileType](../../com.groupdocs.parser.options/filetype) | The type of the file. |
206+
| password | java.lang.String | The password to open the password-protected file. |
207+
| charset | java.nio.charset.Charset | The encoding of the document. |
208+
| defaultAnsiCharset | java.nio.charset.Charset | The default ANSI encoding which is used for encoding detection. |
209+
| timeout | java.time.Duration | The Duration that represents the number of milliseconds to wait. |
210+
146211
### getFileFormat() {#getFileFormat--}
147212
```
148213
public FileFormat getFileFormat()
@@ -153,6 +218,16 @@ Gets the file format.
153218

154219
**Returns:**
155220
[FileFormat](../../com.groupdocs.parser.options/fileformat) - [FileFormat](../../com.groupdocs.parser.options/fileformat) enumeration that contains a file format.
221+
### getFileType() {#getFileType--}
222+
```
223+
public FileType getFileType()
224+
```
225+
226+
227+
Gets the file type.
228+
229+
**Returns:**
230+
[FileType](../../com.groupdocs.parser.options/filetype) - [FileFormat](../../com.groupdocs.parser.options/fileformat) enumeration that contains a file type.
156231
### getPassword() {#getPassword--}
157232
```
158233
public String getPassword()

‎content/sites/groupdocs/parser/english/java/com.groupdocs.parser.options/ocrconnectorbase/_index.md‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ Provides the OCR functionality.
2222

2323
| Method | Description |
2424
| --- | --- |
25-
| [recognizeText(InputStream imageStream, int pageIndex, OcrOptions options)](#recognizeText-java.io.InputStream-int-com.groupdocs.parser.options.OcrOptions-) | Recognize a text from imageStream stream. |
26-
| [recognizeTextAreas(InputStream imageStream, int pageIndex, Size pageSize, OcrOptions options)](#recognizeTextAreas-java.io.InputStream-int-com.groupdocs.parser.data.Size-com.groupdocs.parser.options.OcrOptions-) | Recognize text areas from imageStream stream. |
25+
| [isTextSupported()](#isTextSupported--) | Gets the value that indicates whether the text extraction is supported. |
26+
| [isTextAreasSupported()](#isTextAreasSupported--) | Gets the value that indicates whether the text areas extraction is supported. |
27+
| [recognizeText(InputStream imageStream, OcrOptions options)](#recognizeText-java.io.InputStream-com.groupdocs.parser.options.OcrOptions-) | Recognize a text from imageStream stream. |
28+
| [recognizeTextAreas(InputStream imageStream, Size pageSize, OcrOptions options)](#recognizeTextAreas-java.io.InputStream-com.groupdocs.parser.data.Size-com.groupdocs.parser.options.OcrOptions-) | Recognize text areas from imageStream stream. |
2729
### OcrConnectorBase() {#OcrConnectorBase--}
2830
```
2931
public OcrConnectorBase()
@@ -32,9 +34,29 @@ public OcrConnectorBase()
3234

3335
Initializes a new instance of the [OcrConnectorBase](../../com.groupdocs.parser.options/ocrconnectorbase) class.
3436

35-
### recognizeText(InputStream imageStream, int pageIndex, OcrOptions options) {#recognizeText-java.io.InputStream-int-com.groupdocs.parser.options.OcrOptions-}
37+
### isTextSupported() {#isTextSupported--}
3638
```
37-
public String recognizeText(InputStream imageStream, int pageIndex, OcrOptions options)
39+
public boolean isTextSupported()
40+
```
41+
42+
43+
Gets the value that indicates whether the text extraction is supported.
44+
45+
**Returns:**
46+
boolean - true if the text extraction is supported; otherwise, false .
47+
### isTextAreasSupported() {#isTextAreasSupported--}
48+
```
49+
public boolean isTextAreasSupported()
50+
```
51+
52+
53+
Gets the value that indicates whether the text areas extraction is supported.
54+
55+
**Returns:**
56+
boolean - true if the text extraction areas is supported; otherwise, false .
57+
### recognizeText(InputStream imageStream, OcrOptions options) {#recognizeText-java.io.InputStream-com.groupdocs.parser.options.OcrOptions-}
58+
```
59+
public String recognizeText(InputStream imageStream, OcrOptions options)
3860
```
3961

4062

@@ -44,14 +66,13 @@ Recognize a text from imageStream stream.
4466
| Parameter | Type | Description |
4567
| --- | --- | --- |
4668
| imageStream | java.io.InputStream | The image representation of the document page. |
47-
| pageIndex | int | The page index of the document. |
4869
| options | [OcrOptions](../../com.groupdocs.parser.options/ocroptions) | The OCR options. |
4970

5071
**Returns:**
5172
java.lang.String - A string that represents a recognized text; null if text recognizing isn't supported.
52-
### recognizeTextAreas(InputStream imageStream, int pageIndex, Size pageSize, OcrOptions options) {#recognizeTextAreas-java.io.InputStream-int-com.groupdocs.parser.data.Size-com.groupdocs.parser.options.OcrOptions-}
73+
### recognizeTextAreas(InputStream imageStream, Size pageSize, OcrOptions options) {#recognizeTextAreas-java.io.InputStream-com.groupdocs.parser.data.Size-com.groupdocs.parser.options.OcrOptions-}
5374
```
54-
public Iterable<PageTextArea> recognizeTextAreas(InputStream imageStream, int pageIndex, Size pageSize, OcrOptions options)
75+
public Iterable<PageTextArea> recognizeTextAreas(InputStream imageStream, Size pageSize, OcrOptions options)
5576
```
5677

5778

@@ -61,7 +82,6 @@ Recognize text areas from imageStream stream.
6182
| Parameter | Type | Description |
6283
| --- | --- | --- |
6384
| imageStream | java.io.InputStream | The image representation of the document page. |
64-
| pageIndex | int | The page index of the document. |
6585
| pageSize | [Size](../../com.groupdocs.parser.data/size) | The size of the document page. |
6686
| options | [OcrOptions](../../com.groupdocs.parser.options/ocroptions) | The OCR options. |
6787

0 commit comments

Comments
 (0)