Skip to content

Commit e7bd9d4

Browse files
Update file(s) "/." from "groupdocs-redaction/Groupdocs.Redaction-References"
1 parent 5ca673e commit e7bd9d4

File tree

333 files changed

+10949
-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.

333 files changed

+10949
-0
lines changed

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: GroupDocs.Redaction for Python via .NET
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/
7+
is_root: true
8+
version: 25.5
9+
weight: 40
10+
---
11+
12+
### Modules
13+
| Module | Description |
14+
| :- | :- |
15+
| [`groupdocs.redaction`](/redaction/python-net/groupdocs.redaction) | The GroupDocs namespace provides classes for redacting sensitive information from documents in PDF, raster image and office document formats.<br/>The main classes in this namespace are:<br/>\|<br/>\|<br/> \|<br/> \|<br/> \|<br/> \| |
16+
| [`groupdocs.redaction.configuration`](/redaction/python-net/groupdocs.redaction.configuration) | The GroupDocs.Redaction namespace provides document format configuration classes. |
17+
| [`groupdocs.redaction.exceptions`](/redaction/python-net/groupdocs.redaction.exceptions) | The GroupDocs.Redaction namespace provides different exceptions classes. |
18+
| [`groupdocs.redaction.integration`](/redaction/python-net/groupdocs.redaction.integration) | The GroupDocs.Redaction namespace provides interfaces and classes, used to integrate documents of different formats with GroupDocs.Redaction. |
19+
| [`groupdocs.redaction.integration.ocr`](/redaction/python-net/groupdocs.redaction.integration.ocr) | The GroupDocs.Redaction.Integration namespace provides interfaces and classes, required for Optical Character Recognition (OCR) support. |
20+
| [`groupdocs.redaction.options`](/redaction/python-net/groupdocs.redaction.options) | The GroupDocs.Redaction namespace provides load and save options classes. |
21+
| [`groupdocs.redaction.redactions`](/redaction/python-net/groupdocs.redaction.redactions) | The GroupDocs.Redaction namespace provides classes for different types of redactions. |
22+
23+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: groupdocs.redaction.configuration
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
The GroupDocs.Redaction namespace provides document format configuration classes.
12+
13+
### Classes
14+
| Class | Description |
15+
| :- | :- |
16+
| [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration) | Represents a type reference for [`DocumentFormatInstance`](/redaction/python-net/groupdocs.redaction.integration/documentformatinstance)-derived class and supported file extensions list for faster format detection. |
17+
| [`RedactorConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration) | Provides access to a list of supported formats, built-in and custom user formats. |
18+
19+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: DocumentFormatConfiguration constructor
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/documentformatconfiguration/__init__/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
## __init__ {#}
12+
13+
Initializes a new instance of DocumentFormatConfiguration class.
14+
15+
16+
17+
```python
18+
def __init__(self):
19+
...
20+
```
21+
22+
23+
24+
25+
26+
### See Also
27+
* module [`groupdocs.redaction.configuration`](../../)
28+
* class [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration)
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: DocumentFormatConfiguration class
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/documentformatconfiguration/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
## DocumentFormatConfiguration class
12+
13+
Represents a type reference for [`DocumentFormatInstance`](/redaction/python-net/groupdocs.redaction.integration/documentformatinstance)-derived class and supported file extensions list for faster format detection.
14+
15+
16+
17+
The DocumentFormatConfiguration type exposes the following members:
18+
19+
### Constructors
20+
| Constructor | Description |
21+
| :- | :- |
22+
| [__init__](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/__init__/#) | Initializes a new instance of DocumentFormatConfiguration class. |
23+
24+
25+
### Properties
26+
| Property | Description |
27+
| :- | :- |
28+
| [extension_filter](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/extension_filter) | Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive. |
29+
| [document_type](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/document_type) | Gets or sets the type of a class, inheriting from [`DocumentFormatInstance`](/redaction/python-net/groupdocs.redaction.integration/documentformatinstance). |
30+
31+
32+
### Methods
33+
| Method | Description |
34+
| :- | :- |
35+
| [supports_extension](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/supports_extension/#str) | Checks if a given file extension can be handled as DocumentType. |
36+
37+
38+
39+
### Remarks
40+
41+
42+
**Learn more** |
43+
|
44+
|
45+
|
46+
47+
### Example
48+
49+
50+
The following example demonstrates how to set properties for a custom format configuration.
51+
52+
### See Also
53+
* module [`groupdocs.redaction.configuration`](..)
54+
* class [`DocumentFormatInstance`](/redaction/python-net/groupdocs.redaction.integration/documentformatinstance)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: document_type property
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/documentformatconfiguration/document_type/
7+
is_root: false
8+
weight: 40
9+
---
10+
11+
## document_type property
12+
13+
14+
Gets or sets the type of a class, inheriting from [`DocumentFormatInstance`](/redaction/python-net/groupdocs.redaction.integration/documentformatinstance).
15+
### Definition:
16+
```python
17+
@property
18+
def document_type(self):
19+
...
20+
@document_type.setter
21+
def document_type(self, value):
22+
...
23+
```
24+
25+
### See Also
26+
* module [`groupdocs.redaction.configuration`](../../)
27+
* class [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration)
28+
* class [`DocumentFormatInstance`](/redaction/python-net/groupdocs.redaction.integration/documentformatinstance)
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: extension_filter property
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/documentformatconfiguration/extension_filter/
7+
is_root: false
8+
weight: 50
9+
---
10+
11+
## extension_filter property
12+
13+
14+
Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.
15+
### Definition:
16+
```python
17+
@property
18+
def extension_filter(self):
19+
...
20+
@extension_filter.setter
21+
def extension_filter(self, value):
22+
...
23+
```
24+
25+
### See Also
26+
* module [`groupdocs.redaction.configuration`](../../)
27+
* class [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration)
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: supports_extension method
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/documentformatconfiguration/supports_extension/
7+
is_root: false
8+
weight: 20
9+
---
10+
11+
## supports_extension {#str}
12+
13+
Checks if a given file extension can be handled as DocumentType.
14+
15+
16+
### Returns
17+
18+
19+
True if the extension is listed in ExtensionFilter
20+
21+
22+
```python
23+
def supports_extension(self, file_extension):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| file_extension | str | File extension, format is ".ext" |
31+
32+
33+
34+
### See Also
35+
* module [`groupdocs.redaction.configuration`](../../)
36+
* class [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration)
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: RedactorConfiguration class
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/redactorconfiguration/
7+
is_root: false
8+
weight: 20
9+
---
10+
11+
## RedactorConfiguration class
12+
13+
Provides access to a list of supported formats, built-in and custom user formats.
14+
15+
16+
17+
The RedactorConfiguration type exposes the following members:
18+
19+
### Properties
20+
| Property | Description |
21+
| :- | :- |
22+
| [available_formats](/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/available_formats) | Gets a list of recognized formats, see [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration). |
23+
24+
25+
### Methods
26+
| Method | Description |
27+
| :- | :- |
28+
| [find_format](/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/find_format/#str) | Finds format configurations for a given file extension. |
29+
| [get_instance](/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/get_instance/#) | Provides a singleton instance with default configuration of built-in formats. |
30+
31+
32+
33+
### Remarks
34+
35+
36+
**Learn more** |
37+
|
38+
|
39+
|
40+
41+
### Example
42+
43+
44+
The following example demonstrates how to add a custom user format handler.
45+
46+
### See Also
47+
* module [`groupdocs.redaction.configuration`](..)
48+
* class [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration)
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: available_formats property
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/redactorconfiguration/available_formats/
7+
is_root: false
8+
weight: 50
9+
---
10+
11+
## available_formats property
12+
13+
14+
Gets a list of recognized formats, see [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration).
15+
### Definition:
16+
```python
17+
@property
18+
def available_formats(self):
19+
...
20+
```
21+
22+
### See Also
23+
* module [`groupdocs.redaction.configuration`](../../)
24+
* class [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration)
25+
* class [`RedactorConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration)
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: find_format method
3+
second_title: GroupDocs.Redaction for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.redaction.configuration/redactorconfiguration/find_format/
7+
is_root: false
8+
weight: 20
9+
---
10+
11+
## find_format {#str}
12+
13+
Finds format configurations for a given file extension.
14+
15+
16+
### Returns
17+
18+
19+
If found, instance of [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration), null otherwise
20+
21+
22+
```python
23+
def find_format(self, file_extension):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| file_extension | str | File extension, format is ".ext" |
31+
32+
### Example
33+
34+
35+
The following example demonstrates how to get built-in or custom user format handlers.
36+
37+
38+
39+
### See Also
40+
* module [`groupdocs.redaction.configuration`](../../)
41+
* class [`DocumentFormatConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration)
42+
* class [`RedactorConfiguration`](/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration)

0 commit comments

Comments
 (0)