Skip to content

Commit 28bd96a

Browse files
Update file(s) "/." from "groupdocs-viewer/Groupdocs.Viewer-References"
1 parent 2a56252 commit 28bd96a

File tree

857 files changed

+23830
-2035
lines changed

Some content is hidden

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

857 files changed

+23830
-2035
lines changed

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

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1+
---
2+
title: GroupDocs.Viewer for Python via .NET
3+
second_title: GroupDocs.Viewer 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
110
---
2-
title: GroupDocs.Viewer for Python via .NET
3-
second_title: GroupDocs.Viewer for Python via .NET API Reference
4-
description:
5-
type: docs
6-
weight: 10
7-
url: /python-net/
8-
is_root: true
9-
---
10-
11-
## Namespaces
12-
| Namespace | Description |
13-
| :- | :- |
14-
|[groupdocs.viewer](/viewer/python-net/groupdocs.viewer/)|The namespace provides classes for rendering documents in HTML5, Image or PDF modes fast and with high quality.|
15-
|[groupdocs.viewer.caching](/viewer/python-net/groupdocs.viewer.caching/)|The namespace provides classes for customizing caching behaviour.|
16-
|[groupdocs.viewer.drawing](/viewer/python-net/groupdocs.viewer.drawing/)||
17-
|[groupdocs.viewer.exceptions](/viewer/python-net/groupdocs.viewer.exceptions/)|The namespace provides different exceptions classes.|
18-
|[groupdocs.viewer.fonts](/viewer/python-net/groupdocs.viewer.fonts/)|The namespace provides classes and enumerations to manage fonts used during rendering process.|
19-
|[groupdocs.viewer.interfaces](/viewer/python-net/groupdocs.viewer.interfaces/)|The namespace provides interfaces to instantiate and release output document and it's resources.|
20-
|[groupdocs.viewer.logging](/viewer/python-net/groupdocs.viewer.logging/)|The namespace provides classes to customize logging behaviour.|
21-
|[groupdocs.viewer.options](/viewer/python-net/groupdocs.viewer.options/)|The namespace provides classes to specify additional options when rendering documents.|
22-
|[groupdocs.viewer.results](/viewer/python-net/groupdocs.viewer.results/)|The namespace provides classes which represent document rendering results.|
11+
12+
### Modules
13+
| Module | Description |
14+
| :- | :- |
15+
| [`groupdocs.viewer`](/viewer/python-net/groupdocs.viewer) | The namespace provides classes for rendering documents in HTML5, Image or PDF modes fast and with high quality.<br/><br/><br/><br/><br/><br/><br/><br/>The main classes in this namespace are:<br/>\|<br/>\|<br/> \|<br/> \|<br/> \| |
16+
| [`groupdocs.viewer.caching`](/viewer/python-net/groupdocs.viewer.caching) | The namespace provides classes for customizing caching behaviour. |
17+
| [`groupdocs.viewer.drawing`](/viewer/python-net/groupdocs.viewer.drawing) | The namespace provides types that replaces platform-specific graphics types like Color. |
18+
| [`groupdocs.viewer.exceptions`](/viewer/python-net/groupdocs.viewer.exceptions) | The namespace provides different exceptions classes. |
19+
| [`groupdocs.viewer.fonts`](/viewer/python-net/groupdocs.viewer.fonts) | The namespace provides classes and enumerations to manage fonts used during rendering process. |
20+
| [`groupdocs.viewer.interfaces`](/viewer/python-net/groupdocs.viewer.interfaces) | The namespace provides interfaces to instantiate and release output document and it's resources. |
21+
| [`groupdocs.viewer.logging`](/viewer/python-net/groupdocs.viewer.logging) | The namespace provides classes to customize logging behaviour. |
22+
| [`groupdocs.viewer.options`](/viewer/python-net/groupdocs.viewer.options) | The namespace provides classes to specify additional options when rendering documents. |
23+
| [`groupdocs.viewer.results`](/viewer/python-net/groupdocs.viewer.results) | The namespace provides classes which represent document rendering results. |
24+
25+
Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
---
1+
---
22
title: groupdocs.viewer.caching
3-
second_title: GroupDocs.Viewer for Python via .NET API Reference
3+
second_title: GroupDocs.Viewer for Python via .NET API References
44
description:
55
type: docs
6-
weight: 20
76
url: /python-net/groupdocs.viewer.caching/
7+
is_root: false
8+
weight: 10
89
---
910

10-
1111
The namespace provides classes for customizing caching behaviour.
1212

13-
## Classes
13+
### Classes
1414
| Class | Description |
1515
| :- | :- |
16-
|[CacheKeys](/viewer/python-net/groupdocs.viewer.caching/cachekeys/)|Provides methods to retrieve unique identifier for the cache entry.|
17-
|[FileCache](/viewer/python-net/groupdocs.viewer.caching/filecache/)|Represents a local on-disk cache.|
18-
|[ICache](/viewer/python-net/groupdocs.viewer.caching/icache/)|Defines methods required for storing rendered document and document resources сache.|
16+
| [`CacheKeys`](/viewer/python-net/groupdocs.viewer.caching/cachekeys) | Provides methods to retrieve unique identifier for the cache entry. |
17+
| [`FileCache`](/viewer/python-net/groupdocs.viewer.caching/filecache) | Represents a local on-disk cache. |
18+
19+
Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,37 @@
1-
---
2-
title: CacheKeys
3-
second_title: GroupDocs.Viewer for Python via .NET API Reference
1+
---
2+
title: CacheKeys class
3+
second_title: GroupDocs.Viewer for Python via .NET API References
44
description:
55
type: docs
6-
weight: 10
76
url: /python-net/groupdocs.viewer.caching/cachekeys/
7+
is_root: false
8+
weight: 10
89
---
910

1011
## CacheKeys class
1112

1213
Provides methods to retrieve unique identifier for the cache entry.
1314

15+
16+
1417
The CacheKeys type exposes the following members:
15-
## Methods
16-
| Name | Description |
18+
19+
### Methods
20+
| Method | Description |
1721
| :- | :- |
18-
|get_attachments_key()|Returns unique identifier for the cache entry that represents collection of [Attachment](/viewer/python-net/groupdocs.viewer.results/attachment/) objects.|
19-
|get_attachment_key(attachment_id)|Returns unique identifier for the cache entry that represents attachment file.|
20-
|get_view_info_key()|Returns unique identifier for the cache entry that represents [ViewInfo](/viewer/python-net/groupdocs.viewer.results/viewinfo/) object.|
21-
|get_file_info_key()|Returns unique identifier for the cache entry that represents [ViewInfo](/viewer/python-net/groupdocs.viewer.results/viewinfo/) object.|
22-
|get_file_key(extension)|Returns unique identifier for the cache entry that represents file.|
23-
|get_page_key(page_number, extension)|Returns unique identifier for the cache entry that represents page file.|
24-
|get_resource_key(page_number, resource)|Returns unique identifier for the cache entry that represents [Resource](/viewer/python-net/groupdocs.viewer.results/resource/) object.|
25-
|get_resource_filter(page_number)|Returns filter string to search for cache entries that represents [Resource](/viewer/python-net/groupdocs.viewer.results/resource/) objects.|
22+
| [get_attachments_key](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_attachments_key/#) | Returns unique identifier for the cache entry that represents collection of [`Attachment`](/viewer/python-net/groupdocs.viewer.results/attachment) objects. |
23+
| [get_attachment_key](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_attachment_key/#System.String) | Returns unique identifier for the cache entry that represents attachment file. |
24+
| [get_view_info_key](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_view_info_key/#) | Returns unique identifier for the cache entry that represents [`ViewInfo`](/viewer/python-net/groupdocs.viewer.results/viewinfo) object. |
25+
| [get_file_info_key](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_file_info_key/#) | Returns unique identifier for the cache entry that represents [`ViewInfo`](/viewer/python-net/groupdocs.viewer.results/viewinfo) object. |
26+
| [get_file_key](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_file_key/#System.String) | Returns unique identifier for the cache entry that represents file. |
27+
| [get_page_key](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_page_key/#int-System.String) | Returns unique identifier for the cache entry that represents page file. |
28+
| [get_resource_key](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_resource_key/#int-groupdocs.viewer.results.Resource) | Returns unique identifier for the cache entry that represents [`Resource`](/viewer/python-net/groupdocs.viewer.results/resource) object. |
29+
| [get_resource_filter](/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_resource_filter/#int) | Returns filter string to search for cache entries that represents [`Resource`](/viewer/python-net/groupdocs.viewer.results/resource) objects. |
2630

27-
### See Also
2831

29-
* namespace [groupdocs.viewer.caching](/viewer/python-net/groupdocs.viewer.caching/)
30-
* assembly [GroupDocs.Viewer](/viewer/python-net/)
3132

33+
### See Also
34+
* module [`groupdocs.viewer.caching`](..)
35+
* class [`Attachment`](/viewer/python-net/groupdocs.viewer.results/attachment)
36+
* class [`Resource`](/viewer/python-net/groupdocs.viewer.results/resource)
37+
* class [`ViewInfo`](/viewer/python-net/groupdocs.viewer.results/viewinfo)
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: get_attachment_key method
3+
second_title: GroupDocs.Viewer for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.viewer.caching/cachekeys/get_attachment_key/
7+
is_root: false
8+
weight: 20
9+
---
10+
11+
## get_attachment_key {#System.String}
12+
13+
Returns unique identifier for the cache entry that represents attachment file.
14+
15+
16+
### Returns
17+
18+
19+
Unique identifier for the cache entry that represents attachment file.
20+
21+
22+
```python
23+
def get_attachment_key(self, attachment_id):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| attachment_id | System.String | Unique (in context of single file) identifier of the attachment. |
31+
### Exceptions
32+
| Exception | Description |
33+
| :- | :- |
34+
| ArgumentException | Thrown when `attachment_id` is null or empty. |
35+
36+
37+
38+
39+
40+
### See Also
41+
* module [`groupdocs.viewer.caching`](../../)
42+
* class [`CacheKeys`](/viewer/python-net/groupdocs.viewer.caching/cachekeys)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: get_attachments_key method
3+
second_title: GroupDocs.Viewer for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.viewer.caching/cachekeys/get_attachments_key/
7+
is_root: false
8+
weight: 30
9+
---
10+
11+
## get_attachments_key {#}
12+
13+
Returns unique identifier for the cache entry that represents collection of [`Attachment`](/viewer/python-net/groupdocs.viewer.results/attachment) objects.
14+
15+
16+
### Returns
17+
18+
19+
Unique identifier for the cache entry that represents collection of [`Attachment`](/viewer/python-net/groupdocs.viewer.results/attachment) objects.
20+
21+
22+
```python
23+
def get_attachments_key(self):
24+
...
25+
```
26+
27+
28+
29+
30+
31+
### See Also
32+
* module [`groupdocs.viewer.caching`](../../)
33+
* class [`Attachment`](/viewer/python-net/groupdocs.viewer.results/attachment)
34+
* class [`CacheKeys`](/viewer/python-net/groupdocs.viewer.caching/cachekeys)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: get_file_info_key method
3+
second_title: GroupDocs.Viewer for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.viewer.caching/cachekeys/get_file_info_key/
7+
is_root: false
8+
weight: 40
9+
---
10+
11+
## get_file_info_key {#}
12+
13+
Returns unique identifier for the cache entry that represents [`ViewInfo`](/viewer/python-net/groupdocs.viewer.results/viewinfo) object.
14+
15+
16+
### Returns
17+
18+
19+
Unique identifier for the cache entry that represents [`ViewInfo`](/viewer/python-net/groupdocs.viewer.results/viewinfo) object.
20+
21+
22+
```python
23+
def get_file_info_key(self):
24+
...
25+
```
26+
27+
28+
29+
30+
31+
### See Also
32+
* module [`groupdocs.viewer.caching`](../../)
33+
* class [`CacheKeys`](/viewer/python-net/groupdocs.viewer.caching/cachekeys)
34+
* class [`ViewInfo`](/viewer/python-net/groupdocs.viewer.results/viewinfo)
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: get_file_key method
3+
second_title: GroupDocs.Viewer for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.viewer.caching/cachekeys/get_file_key/
7+
is_root: false
8+
weight: 50
9+
---
10+
11+
## get_file_key {#System.String}
12+
13+
Returns unique identifier for the cache entry that represents file.
14+
15+
16+
### Returns
17+
18+
19+
Unique identifier for the cache entry that represents file.
20+
21+
22+
```python
23+
def get_file_key(self, extension):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| extension | System.String | The filename suffix (including the period ".") e.g. ".doc". |
31+
### Exceptions
32+
| Exception | Description |
33+
| :- | :- |
34+
| ArgumentException | Thrown when `extension` is null or empty. |
35+
36+
37+
38+
39+
40+
### See Also
41+
* module [`groupdocs.viewer.caching`](../../)
42+
* class [`CacheKeys`](/viewer/python-net/groupdocs.viewer.caching/cachekeys)
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: get_page_key method
3+
second_title: GroupDocs.Viewer for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.viewer.caching/cachekeys/get_page_key/
7+
is_root: false
8+
weight: 60
9+
---
10+
11+
## get_page_key {#int-System.String}
12+
13+
Returns unique identifier for the cache entry that represents page file.
14+
15+
16+
### Returns
17+
18+
19+
Unique identifier for the cache entry that represents page file.
20+
21+
22+
```python
23+
def get_page_key(self, page_number, extension):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| page_number | int | The number of the page. |
31+
| extension | System.String | The filename suffix (including the period ".") e.g. ".doc". |
32+
### Exceptions
33+
| Exception | Description |
34+
| :- | :- |
35+
| ArgumentException | Thrown when `page_number` is less or equal to zero. |
36+
| ArgumentException | Thrown when `extension` is null or empty. |
37+
38+
39+
40+
41+
42+
### See Also
43+
* module [`groupdocs.viewer.caching`](../../)
44+
* class [`CacheKeys`](/viewer/python-net/groupdocs.viewer.caching/cachekeys)
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: get_resource_filter method
3+
second_title: GroupDocs.Viewer for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /python-net/groupdocs.viewer.caching/cachekeys/get_resource_filter/
7+
is_root: false
8+
weight: 70
9+
---
10+
11+
## get_resource_filter {#int}
12+
13+
Returns filter string to search for cache entries that represents [`Resource`](/viewer/python-net/groupdocs.viewer.results/resource) objects.
14+
15+
16+
### Returns
17+
18+
19+
Filter string to search for cache entries that represents [`Resource`](/viewer/python-net/groupdocs.viewer.results/resource) objects.
20+
21+
22+
```python
23+
def get_resource_filter(self, page_number):
24+
...
25+
```
26+
27+
28+
| Parameter | Type | Description |
29+
| :- | :- | :- |
30+
| page_number | int | The number of page. |
31+
### Exceptions
32+
| Exception | Description |
33+
| :- | :- |
34+
| ArgumentException | Thrown when `page_number` is less or equal to zero. |
35+
36+
37+
38+
39+
40+
### See Also
41+
* module [`groupdocs.viewer.caching`](../../)
42+
* class [`CacheKeys`](/viewer/python-net/groupdocs.viewer.caching/cachekeys)
43+
* class [`Resource`](/viewer/python-net/groupdocs.viewer.results/resource)

0 commit comments

Comments
 (0)