Skip to content

Commit dda59aa

Browse files
evgeny-porodnovevgeny-porodnov
authored
Merge pull request #16 from kaferi/master
Add Enum descriptions
2 parents 5fe14cb + 8ecffcb commit dda59aa

File tree

172 files changed

+493
-453
lines changed

Some content is hidden

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

172 files changed

+493
-453
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Aspose.PDF Cloud
1+
# Aspose.PDF Cloud
22
- API version: 2.0
33
- Package version: 18.11.0
44

‎sdk/docs/Annotation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
# Annotation
33
Provides annotation.
44

‎sdk/docs/AnnotationFlags.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
1+
22
# AnnotationFlags
33
A set of flags specifying various characteristics of the annotation.
44

55
## Enum
6-
| Name |
7-
| ----------- |
8-
| **DEFAULT** |
9-
| **INVISIBLE** |
10-
| **HIDDEN** |
11-
| **PRINT** |
12-
| **NOZOOM** |
13-
| **NOROTATE** |
14-
| **NOVIEW** |
15-
| **READONLY** |
16-
| **LOCKED** |
17-
| **TOGGLENOVIEW** |
18-
| **LOCKEDCONTENTS** |
6+
Name | Description
7+
------------ | ------------
8+
**Default** | Default value.
9+
**Invisible** | If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any.
10+
**Hidden** | If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used in combination with appearance streams to display auxiliary pop-up information similar in function to online help systems.
11+
**Print** | If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.
12+
**NoZoom** | If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.
13+
**NoRotate** | If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.
14+
**NoView** | If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.
15+
**ReadOnly** | If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field.
16+
**Locked** | If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field.
17+
**ToggleNoView** | If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.
18+
**LockedContents** | If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.
19+
1920

2021
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
2122

‎sdk/docs/AnnotationInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
# AnnotationInfo
33
Provides annotation.
44

‎sdk/docs/AnnotationState.md‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
1+
22
# AnnotationState
33
The enumeration of states to which the original annotation can be set.
44

55
## Enum
6-
| Name |
7-
| ----------- |
8-
| **UNDEFINED** |
9-
| **MARKED** |
10-
| **UNMARKED** |
11-
| **ACCEPTED** |
12-
| **REJECTED** |
13-
| **CANCELLED** |
14-
| **COMPLETED** |
15-
| **NONE** |
6+
Name | Description
7+
------------ | ------------
8+
**Undefined** | Not defined state.
9+
**Marked** | The annotation has been marked by the user.
10+
**Unmarked** | The annotation has not been marked by the user.
11+
**Accepted** | The user agrees with the change.
12+
**Rejected** | The user disagrees with the change.
13+
**Cancelled** | The change has been cancelled.
14+
**Completed** | The change has been completed.
15+
**None** | The user has indicated nothing about the change.
16+
1617

1718
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1819

‎sdk/docs/AnnotationType.md‎

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
1-
1+
22
# AnnotationType
33

44

55
## Enum
6-
| Name |
7-
| ----------- |
8-
| **TEXT** |
9-
| **CIRCLE** |
10-
| **POLYGON** |
11-
| **POLYLINE** |
12-
| **LINE** |
13-
| **SQUARE** |
14-
| **FREETEXT** |
15-
| **HIGHLIGHT** |
16-
| **UNDERLINE** |
17-
| **SQUIGGLY** |
18-
| **STRIKEOUT** |
19-
| **CARET** |
20-
| **INK** |
21-
| **LINK** |
22-
| **POPUP** |
23-
| **FILEATTACHMENT** |
24-
| **SOUND** |
25-
| **MOVIE** |
26-
| **SCREEN** |
27-
| **WIDGET** |
28-
| **WATERMARK** |
29-
| **TRAPNET** |
30-
| **PRINTERMARK** |
31-
| **REDACTION** |
32-
| **STAMP** |
33-
| **RICHMEDIA** |
34-
| **UNKNOWN** |
35-
| **PDF3D** |
6+
Name | Description
7+
------------ | ------------
8+
**Text** | Text annotation type.
9+
**Circle** | Circle annotation type.
10+
**Polygon** | Polygon annotation type.
11+
**PolyLine** | Plyline annotation type.
12+
**Line** | Line annotation type.
13+
**Square** | Square annotatotion type.
14+
**FreeText** | Free text annotation type.
15+
**Highlight** | Highlight annotation type.
16+
**Underline** | Underline annotation type.
17+
**Squiggly** | Squiggle annotation type.
18+
**StrikeOut** | Strikeout annotation type.
19+
**Caret** | Caret annotation type.
20+
**Ink** | Ink annotation type.
21+
**Link** | Link annotation type.
22+
**Popup** | Popup annotation type.
23+
**FileAttachment** | File attachment annotation type.
24+
**Sound** | Sound annotation type.
25+
**Movie** | Movie annotation type.
26+
**Screen** | Screen annotation type.
27+
**Widget** | Widget annotation type.
28+
**Watermark** | Watermark annotation type.
29+
**TrapNet** | Trap network annotation type.
30+
**PrinterMark** | Printer mark annotation type.
31+
**Redaction** | Redaction annotation type.
32+
**Stamp** | Rubber stamp annotation type.
33+
**RichMedia** | Rich media annotation type
34+
**Unknown** | Unknown annotation.
35+
**PDF3D** |
36+
3637

3738
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
3839

‎sdk/docs/AnnotationsInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
# AnnotationsInfo
33
List of annotations.
44

‎sdk/docs/AnnotationsInfoResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
# AnnotationsInfoResponse
33

44

‎sdk/docs/AntialiasingProcessingType.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
1+
22
# AntialiasingProcessingType
33
This enum describes possible antialiasing measures during conversion
44

55
## Enum
6-
| Name |
7-
| ----------- |
8-
| **NOADDITIONALPROCESSING** |
9-
| **TRYCORRECTRESULTHTML** |
6+
Name | Description
7+
------------ | ------------
8+
**NoAdditionalProcessing** | no special antialiasing processing in use. This is an optimal option for overhelming majority of documents and it does not require additional time during conversion
9+
**TryCorrectResultHtml** |
10+
1011

1112
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1213

‎sdk/docs/AppendDocument.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
22
# AppendDocument
33
Class for appendDocument service request building.
44

0 commit comments

Comments
 (0)