Skip to content

Commit 30aa86f

Browse files
Update file(s) "/." from "groupdocs-parser/Groupdocs.Parser-References"
1 parent e2e1f3b commit 30aa86f

File tree

618 files changed

+22133
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

618 files changed

+22133
-0
lines changed

content/sites/groupdocs/parser/english/python-net/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: GroupDocs.Parser for Python via .NET
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/
7+
is_root: true
8+
version: 25.12
9+
weight: 40
10+
---
11+
12+
### Modules
13+
| Module | Description |
14+
| :- | :- |
15+
| [`groupdocs.parser`](/parser/python-net/groupdocs.parser) | The namespace provides classes for parsing data from documents. <br/>With the main class [`Parser`](/parser/python-net/groupdocs.parser/parser) you may use all document data parsing and extraction features. |
16+
| [`groupdocs.parser.data`](/parser/python-net/groupdocs.parser.data) | The namespace provides classes which represent parsing results. |
17+
| [`groupdocs.parser.exceptions`](/parser/python-net/groupdocs.parser.exceptions) | The namespace provides different exceptions classes. |
18+
| [`groupdocs.parser.export`](/parser/python-net/groupdocs.parser.export) | The namespace provides classes that allow users to export data to different formats. |
19+
| [`groupdocs.parser.options`](/parser/python-net/groupdocs.parser.options) | The namespace provides classes to specify additional options when parsing data from documents. |
20+
| [`groupdocs.parser.templates`](/parser/python-net/groupdocs.parser.templates) | The namespace provides classes for creating templates for parsing document data. |
21+
22+

content/sites/groupdocs/parser/english/python-net/groupdocs.parser.data/_index.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: groupdocs.parser.data
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
The namespace provides classes which represent parsing results.
12+
13+
### Classes
14+
| Class | Description |
15+
| :- | :- |
16+
| [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem) | Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on. |
17+
| [`DocumentData`](/parser/python-net/groupdocs.parser.data/documentdata) | Represents data of the document. It consists of [`FieldData`](/parser/python-net/groupdocs.parser.data/fielddata) objects<br/>which contain field data from document. |
18+
| [`DocumentPageData`](/parser/python-net/groupdocs.parser.data/documentpagedata) | Represents data of the document page. It consists of [`FieldData`](/parser/python-net/groupdocs.parser.data/fielddata) objects<br/>which contain field data from the document page. |
19+
| [`FieldData`](/parser/python-net/groupdocs.parser.data/fielddata) | Represents field data such as a name, a page index, a field value and so on.<br/>Depending on the field the value can be a text, an image, a table and so on. |
20+
| [`HighlightItem`](/parser/python-net/groupdocs.parser.data/highlightitem) | Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality. |
21+
| [`MetadataItem`](/parser/python-net/groupdocs.parser.data/metadataitem) | Represents a metadata item which is used in container items and metadata extraction functionality. |
22+
| [`Page`](/parser/python-net/groupdocs.parser.data/page) | Represents the document page information such as page index and page size. <br/>It's used to represent the page that contains inheritors of [`PageArea`](/parser/python-net/groupdocs.parser.data/pagearea) class<br/>in the parsing by template functionality. |
23+
| [`PageArea`](/parser/python-net/groupdocs.parser.data/pagearea) | Represents an abstract base class for page areas<br/>which are used to represent blocks on the document page in the parsing by template functionality. |
24+
| [`PageBarcodeArea`](/parser/python-net/groupdocs.parser.data/pagebarcodearea) | Represents a page barcode area which is used to represent a barcode value in the parsing by template functionality. |
25+
| [`PageGroupArea`](/parser/python-net/groupdocs.parser.data/pagegrouparea) | Represents a group of page areas<br/>which is used to group different types of blocks of the document page in the parsing by template functionality. |
26+
| [`PageHyperlinkArea`](/parser/python-net/groupdocs.parser.data/pagehyperlinkarea) | Represents a page area which is used to represent a hyperlink on the page. |
27+
| [`PageImageArea`](/parser/python-net/groupdocs.parser.data/pageimagearea) | Represents a page image area which is used to represent an image on the page in the parsing by template functionality<br/>or an image attachment if images are extracted from emails or Zip archives. |
28+
| [`PageTableArea`](/parser/python-net/groupdocs.parser.data/pagetablearea) | Represents a table page area which is used to represent a table in the parsing by template functionality. |
29+
| [`PageTableAreaCell`](/parser/python-net/groupdocs.parser.data/pagetableareacell) | Represents a table cell which is used in [`PageTableArea`](/parser/python-net/groupdocs.parser.data/pagetablearea) class. |
30+
| [`PageTextArea`](/parser/python-net/groupdocs.parser.data/pagetextarea) | Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality. |
31+
| [`Point`](/parser/python-net/groupdocs.parser.data/point) | Represents a point. |
32+
| [`Rectangle`](/parser/python-net/groupdocs.parser.data/rectangle) | Represents a rectangular area. |
33+
| [`SearchResult`](/parser/python-net/groupdocs.parser.data/searchresult) | Represents the search result in the search functionality. |
34+
| [`Size`](/parser/python-net/groupdocs.parser.data/size) | Represents a size. |
35+
| [`TextStyle`](/parser/python-net/groupdocs.parser.data/textstyle) | Represents the style of the text such as a font name, a font size and so on. |
36+
| [`TocItem`](/parser/python-net/groupdocs.parser.data/tocitem) | Represents the item which is used in the table of contents extraction functionality. |
37+
| [`WorksheetCell`](/parser/python-net/groupdocs.parser.data/worksheetcell) | Represents a worksheet cell. |
38+
| [`WorksheetInfo`](/parser/python-net/groupdocs.parser.data/worksheetinfo) | Represents a sheet info. |
39+
| [`WorksheetRange`](/parser/python-net/groupdocs.parser.data/worksheetrange) | Provides the range which are used for the worksheet extraction. |
40+
41+

content/sites/groupdocs/parser/english/python-net/groupdocs.parser.data/containeritem/_index.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: ContainerItem class
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/containeritem/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
## ContainerItem class
12+
13+
Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on.
14+
15+
16+
17+
The ContainerItem type exposes the following members:
18+
19+
### Properties
20+
| Property | Description |
21+
| :- | :- |
22+
| [name](/parser/python-net/groupdocs.parser.data/containeritem/name) | Gets the name of the item. |
23+
| [directory](/parser/python-net/groupdocs.parser.data/containeritem/directory) | Gets the directory of the item. |
24+
| [file_path](/parser/python-net/groupdocs.parser.data/containeritem/file_path) | Gets the full path of the item. |
25+
| [size](/parser/python-net/groupdocs.parser.data/containeritem/size) | Gets the size of the item. |
26+
| [metadata](/parser/python-net/groupdocs.parser.data/containeritem/metadata) | Gets the collection of metadata items. |
27+
28+
29+
### Methods
30+
| Method | Description |
31+
| :- | :- |
32+
| [open_parser](/parser/python-net/groupdocs.parser.data/containeritem/open_parser/#) | Creates the [`Parser`](/parser/python-net/groupdocs.parser/parser) object for the item content. |
33+
| [open_parser](/parser/python-net/groupdocs.parser.data/containeritem/open_parser/#groupdocs.parser.options.LoadOptions) | Creates the [`Parser`](/parser/python-net/groupdocs.parser/parser) object for the item content with [`LoadOptions`](/parser/python-net/groupdocs.parser.options/loadoptions). |
34+
| [open_parser](/parser/python-net/groupdocs.parser.data/containeritem/open_parser/#groupdocs.parser.options.LoadOptions-groupdocs.parser.options.ParserSettings) | Creates the [`Parser`](/parser/python-net/groupdocs.parser/parser) object for the item content with [`LoadOptions`](/parser/python-net/groupdocs.parser.options/loadoptions)<br/>and [`ParserSettings`](/parser/python-net/groupdocs.parser.options/parsersettings). |
35+
| [get_metadata_value](/parser/python-net/groupdocs.parser.data/containeritem/get_metadata_value/#System.String) | Gets the metadata value. |
36+
| [open_stream](/parser/python-net/groupdocs.parser.data/containeritem/open_stream/#) | Opens the stream of the item content. |
37+
| [detect_file_type](/parser/python-net/groupdocs.parser.data/containeritem/detect_file_type/#groupdocs.parser.options.FileTypeDetectionMode) | Detects a file type of the container item. |
38+
39+
40+
41+
### Remarks
42+
43+
44+
An instance of [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem) class is used as return value
45+
of [`Parser.get_container`](/parser/python-net/groupdocs.parser/parser/get_container) method. See the usage examples there.
46+
47+
### See Also
48+
* module [`groupdocs.parser.data`](..)
49+
* class [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem)
50+
* class [`LoadOptions`](/parser/python-net/groupdocs.parser.options/loadoptions)
51+
* class [`Parser`](/parser/python-net/groupdocs.parser/parser)
52+
* class [`ParserSettings`](/parser/python-net/groupdocs.parser.options/parsersettings)
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: detect_file_type method
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/containeritem/detect_file_type/
7+
is_root: false
8+
weight: 20
9+
---
10+
11+
## detect_file_type {#groupdocs.parser.options.FileTypeDetectionMode}
12+
13+
Detects a file type of the container item.
14+
15+
16+
### Returns
17+
18+
19+
An instance of [`FileType`](/parser/python-net/groupdocs.parser.options/filetype) class; [`FileType.Unknown`](/parser/python-net/groupdocs.parser.options/filetype) if a file type isn't detected.
20+
21+
22+
```python
23+
def detect_file_type(self, detection_mode):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| detection_mode | groupdocs.parser.options.FileTypeDetectionMode | Defines a mode of the file type detection. |
31+
32+
### Example
33+
34+
35+
The following example shows how to detect file type of container item:
36+
37+
38+
39+
### See Also
40+
* module [`groupdocs.parser.data`](../../)
41+
* class [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem)
42+
* class [`FileType`](/parser/python-net/groupdocs.parser.options/filetype)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: directory property
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/containeritem/directory/
7+
is_root: false
8+
weight: 70
9+
---
10+
11+
## directory property
12+
13+
14+
Gets the directory of the item.
15+
### Definition:
16+
```python
17+
@property
18+
def directory(self):
19+
...
20+
```
21+
22+
### See Also
23+
* module [`groupdocs.parser.data`](../../)
24+
* class [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: file_path property
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/containeritem/file_path/
7+
is_root: false
8+
weight: 80
9+
---
10+
11+
## file_path property
12+
13+
14+
Gets the full path of the item.
15+
### Definition:
16+
```python
17+
@property
18+
def file_path(self):
19+
...
20+
```
21+
22+
### See Also
23+
* module [`groupdocs.parser.data`](../../)
24+
* class [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem)
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: get_metadata_value method
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/containeritem/get_metadata_value/
7+
is_root: false
8+
weight: 30
9+
---
10+
11+
## get_metadata_value {#System.String}
12+
13+
Gets the metadata value.
14+
15+
16+
### Returns
17+
18+
19+
A string value that represents the value of the metadata item; `null` if the metadata with this name isn't found.
20+
21+
22+
```python
23+
def get_metadata_value(self, name):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| name | System.String | The name of the metadata. |
31+
32+
33+
34+
### See Also
35+
* module [`groupdocs.parser.data`](../../)
36+
* class [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem)
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: metadata property
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/containeritem/metadata/
7+
is_root: false
8+
weight: 90
9+
---
10+
11+
## metadata property
12+
13+
14+
Gets the collection of metadata items.
15+
16+
### Remarks
17+
18+
19+
These metadata refer to a container element itself, not a document. Depending on the container type
20+
metadata can contain the following items:
21+
22+
23+
24+
**Email Attachments**
25+
26+
| Description |
27+
| :- |
28+
| The MIME type of the attachment content. |
29+
30+
31+
**ZIP Archives**
32+
33+
| Description |
34+
| :- |
35+
| The time and date at which the file indicated by the Zip Entry was last modified. |
36+
| To detect if image attachment is inline 'disposition' metadata is used. If it's present, it can take 'inline' or 'attachment' values. |
37+
38+
39+
**Outlook Storage**
40+
41+
| Description |
42+
| :- |
43+
| The time and date at which the Outlook Storage item was last modified. |
44+
| The value of "sender" field. |
45+
| The value of "to" field. |
46+
| The value of "subject" field. |
47+
### Definition:
48+
```python
49+
@property
50+
def metadata(self):
51+
...
52+
```
53+
54+
### See Also
55+
* module [`groupdocs.parser.data`](../../)
56+
* class [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: name property
3+
second_title: GroupDocs.Parser for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.parser.data/containeritem/name/
7+
is_root: false
8+
weight: 100
9+
---
10+
11+
## name property
12+
13+
14+
Gets the name of the item.
15+
### Definition:
16+
```python
17+
@property
18+
def name(self):
19+
...
20+
```
21+
22+
### See Also
23+
* module [`groupdocs.parser.data`](../../)
24+
* class [`ContainerItem`](/parser/python-net/groupdocs.parser.data/containeritem)

0 commit comments

Comments
 (0)