Skip to content

Commit 6d501c8

Browse files
Merge pull request #11 from kaferi/master
Add Enum descriptions
2 parents 33adafd + 0facaee commit 6d501c8

File tree

334 files changed

+609
-609
lines changed

Some content is hidden

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

334 files changed

+609
-609
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Aspose.PDF Cloud
1+
# Aspose.PDF Cloud
22
[Aspose.PDF Cloud](https://products.aspose.cloud/pdf) is a true REST API that enables you to perform a wide range of document processing operations including creation, manipulation, conversion and rendering of Pdf documents in the cloud.
33

44
Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to process documents in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights. This repository contains new generation SDKs for Aspose.PDF Cloud and examples.
@@ -293,7 +293,7 @@ Class | Description
293293
[**Attachments**](docs/Attachments.md) | List of attachment.
294294
[**AttachmentsResponse**](docs/AttachmentsResponse.md) |
295295
[**CapStyle**](docs/CapStyle.md) | Style of line ending of Ink annotation line.
296-
[**CaptionPosition**](docs/CaptionPosition.md) | Enumeration of the annotation?s caption positioning.
296+
[**CaptionPosition**](docs/CaptionPosition.md) | Enumeration of the annotations caption positioning.
297297
[**CaretAnnotation**](docs/CaretAnnotation.md) | Provides CaretAnnotation.
298298
[**CaretAnnotationResponse**](docs/CaretAnnotationResponse.md) |
299299
[**CaretAnnotations**](docs/CaretAnnotations.md) | List of annotations.
@@ -352,7 +352,7 @@ Class | Description
352352
[**InkAnnotationResponse**](docs/InkAnnotationResponse.md) |
353353
[**InkAnnotations**](docs/InkAnnotations.md) | List of annotations.
354354
[**InkAnnotationsResponse**](docs/InkAnnotationsResponse.md) |
355-
[**Justification**](docs/Justification.md) | Enumerates the forms of quadding (justification) to be used in displaying the annotation?s text.
355+
[**Justification**](docs/Justification.md) | Enumerates the forms of quadding (justification) to be used in displaying the annotations text.
356356
[**LettersPositioningMethods**](docs/LettersPositioningMethods.md) | It enumerates possible modes of positioning of letters in words in result HTML
357357
[**LineAnnotation**](docs/LineAnnotation.md) | Provides LineAnnotation.
358358
[**LineAnnotationResponse**](docs/LineAnnotationResponse.md) |
@@ -368,7 +368,7 @@ Class | Description
368368
[**LinkAnnotations**](docs/LinkAnnotations.md) | List of LinkAnnotations.
369369
[**LinkAnnotationsResponse**](docs/LinkAnnotationsResponse.md) |
370370
[**LinkElement**](docs/LinkElement.md) | Represents base DTO object.
371-
[**LinkHighlightingMode**](docs/LinkHighlightingMode.md) | Enumerates the annotation?s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.
371+
[**LinkHighlightingMode**](docs/LinkHighlightingMode.md) | Enumerates the annotations highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.
372372
[**MarginInfo**](docs/MarginInfo.md) |
373373
[**MarkupAnnotation**](docs/MarkupAnnotation.md) | Provides MarkupAnnotation.
374374
[**MergeDocuments**](docs/MergeDocuments.md) | Documents for merging.

docs/Annotation.md

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

44
*Inherited from [LinkElement](LinkElement.md)*

docs/AnnotationFlags.md

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

44
## Enum
5-
Name | Type | Value
6-
------------ | ------------- | -------------
7-
**Default** | **string** | 'Default'
8-
**Hidden** | **string** | 'Hidden'
9-
**Invisible** | **string** | 'Invisible'
10-
**Locked** | **string** | 'Locked'
11-
**LockedContents** | **string** | 'LockedContents'
12-
**NoRotate** | **string** | 'NoRotate'
13-
**NoView** | **string** | 'NoView'
14-
**NoZoom** | **string** | 'NoZoom'
15-
**Print** | **string** | 'Print'
16-
**ReadOnly** | **string** | 'ReadOnly'
17-
**ToggleNoView** | **string** | 'ToggleNoView'
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**Default** | **string** | 'Default' | Default value.
8+
**Hidden** | **string** | '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.
9+
**Invisible** | **string** | '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+
**Locked** | **string** | '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.
11+
**LockedContents** | **string** | '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.
12+
**NoRotate** | **string** | '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.
13+
**NoView** | **string** | '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.
14+
**NoZoom** | **string** | '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.
15+
**Print** | **string** | '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.
16+
**ReadOnly** | **string** | '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.
17+
**ToggleNoView** | **string** | '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.
1818

1919
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/annotationFlags.ts)
2020

docs/AnnotationInfo.md

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

44
*Inherited from [Annotation](Annotation.md)*

docs/AnnotationState.md

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

44
## Enum
5-
Name | Type | Value
6-
------------ | ------------- | -------------
7-
**Accepted** | **string** | 'Accepted'
8-
**Cancelled** | **string** | 'Cancelled'
9-
**Completed** | **string** | 'Completed'
10-
**Marked** | **string** | 'Marked'
11-
**None** | **string** | 'None'
12-
**Rejected** | **string** | 'Rejected'
13-
**Undefined** | **string** | 'Undefined'
14-
**Unmarked** | **string** | 'Unmarked'
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**Accepted** | **string** | 'Accepted' | The user agrees with the change.
8+
**Cancelled** | **string** | 'Cancelled' | The change has been cancelled.
9+
**Completed** | **string** | 'Completed' | The change has been completed.
10+
**Marked** | **string** | 'Marked' | The annotation has been marked by the user.
11+
**None** | **string** | 'None' | The user has indicated nothing about the change.
12+
**Rejected** | **string** | 'Rejected' | The user disagrees with the change.
13+
**Undefined** | **string** | 'Undefined' | Not defined state.
14+
**Unmarked** | **string** | 'Unmarked' | The annotation has not been marked by the user.
1515

1616
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/annotationState.ts)
1717

docs/AnnotationType.md

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

33

44
## Enum
5-
Name | Type | Value
6-
------------ | ------------- | -------------
7-
**Caret** | **string** | 'Caret'
8-
**Circle** | **string** | 'Circle'
9-
**FileAttachment** | **string** | 'FileAttachment'
10-
**FreeText** | **string** | 'FreeText'
11-
**Highlight** | **string** | 'Highlight'
12-
**Ink** | **string** | 'Ink'
13-
**Line** | **string** | 'Line'
14-
**Link** | **string** | 'Link'
15-
**Movie** | **string** | 'Movie'
16-
**PDF3D** | **string** | 'PDF3D'
17-
**Polygon** | **string** | 'Polygon'
18-
**PolyLine** | **string** | 'PolyLine'
19-
**Popup** | **string** | 'Popup'
20-
**PrinterMark** | **string** | 'PrinterMark'
21-
**Redaction** | **string** | 'Redaction'
22-
**RichMedia** | **string** | 'RichMedia'
23-
**Screen** | **string** | 'Screen'
24-
**Sound** | **string** | 'Sound'
25-
**Square** | **string** | 'Square'
26-
**Squiggly** | **string** | 'Squiggly'
27-
**Stamp** | **string** | 'Stamp'
28-
**StrikeOut** | **string** | 'StrikeOut'
29-
**Text** | **string** | 'Text'
30-
**TrapNet** | **string** | 'TrapNet'
31-
**Underline** | **string** | 'Underline'
32-
**Unknown** | **string** | 'Unknown'
33-
**Watermark** | **string** | 'Watermark'
34-
**Widget** | **string** | 'Widget'
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**Caret** | **string** | 'Caret' | Caret annotation type.
8+
**Circle** | **string** | 'Circle' | Circle annotation type.
9+
**FileAttachment** | **string** | 'FileAttachment' | File attachment annotation type.
10+
**FreeText** | **string** | 'FreeText' | Free text annotation type.
11+
**Highlight** | **string** | 'Highlight' | Highlight annotation type.
12+
**Ink** | **string** | 'Ink' | Ink annotation type.
13+
**Line** | **string** | 'Line' | Line annotation type.
14+
**Link** | **string** | 'Link' | Link annotation type.
15+
**Movie** | **string** | 'Movie' | Movie annotation type.
16+
**PDF3D** | **string** | 'PDF3D' |
17+
**Polygon** | **string** | 'Polygon' | Polygon annotation type.
18+
**PolyLine** | **string** | 'PolyLine' | Plyline annotation type.
19+
**Popup** | **string** | 'Popup' | Popup annotation type.
20+
**PrinterMark** | **string** | 'PrinterMark' | Printer mark annotation type.
21+
**Redaction** | **string** | 'Redaction' | Redaction annotation type.
22+
**RichMedia** | **string** | 'RichMedia' | Rich media annotation type
23+
**Screen** | **string** | 'Screen' | Screen annotation type.
24+
**Sound** | **string** | 'Sound' | Sound annotation type.
25+
**Square** | **string** | 'Square' | Square annotatotion type.
26+
**Squiggly** | **string** | 'Squiggly' | Squiggle annotation type.
27+
**Stamp** | **string** | 'Stamp' | Rubber stamp annotation type.
28+
**StrikeOut** | **string** | 'StrikeOut' | Strikeout annotation type.
29+
**Text** | **string** | 'Text' | Text annotation type.
30+
**TrapNet** | **string** | 'TrapNet' | Trap network annotation type.
31+
**Underline** | **string** | 'Underline' | Underline annotation type.
32+
**Unknown** | **string** | 'Unknown' | Unknown annotation.
33+
**Watermark** | **string** | 'Watermark' | Watermark annotation type.
34+
**Widget** | **string** | 'Widget' | Widget annotation type.
3535

3636
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/annotationType.ts)
3737

docs/AnnotationsInfo.md

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

44
*Inherited from [LinkElement](LinkElement.md)*

docs/AnnotationsInfoResponse.md

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

33

44
*Inherited from [AsposeResponse](AsposeResponse.md)*

docs/AntialiasingProcessingType.md

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

44
## Enum
5-
Name | Type | Value
6-
------------ | ------------- | -------------
7-
**NoAdditionalProcessing** | **string** | 'NoAdditionalProcessing'
8-
**TryCorrectResultHtml** | **string** | 'TryCorrectResultHtml'
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**NoAdditionalProcessing** | **string** | '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
8+
**TryCorrectResultHtml** | **string** | 'TryCorrectResultHtml' |
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/antialiasingProcessingType.ts)
1111

docs/AppendDocument.md

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

44
## Properties

0 commit comments

Comments
 (0)