Skip to content

Commit 08955fb

Browse files
Merge pull request #29 from kaferi/master
Update to v19.11
2 parents 156d8ac + aa009dc commit 08955fb

16 files changed

+863
-3
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ Class | Method | HTTP request | Description
8686
*PdfApi* | [**getCaretAnnotation**](docs/PdfApi.md#getCaretAnnotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
8787
*PdfApi* | [**getCheckBoxField**](docs/PdfApi.md#getCheckBoxField) | **GET** /pdf/\{name}/fields/checkbox/\{fieldName} | Read document checkbox field by name.
8888
*PdfApi* | [**getCircleAnnotation**](docs/PdfApi.md#getCircleAnnotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
89+
*PdfApi* | [**getComboBoxField**](docs/PdfApi.md#getComboBoxField) | **GET** /pdf/\{name}/fields/combobox/\{fieldName} | Read document combobox field by name.
8990
*PdfApi* | [**getDiscUsage**](docs/PdfApi.md#getDiscUsage) | **GET** /pdf/storage/disc | Get disc usage
9091
*PdfApi* | [**getDocument**](docs/PdfApi.md#getDocument) | **GET** /pdf/\{name} | Read common document info.
9192
*PdfApi* | [**getDocumentAnnotations**](docs/PdfApi.md#getDocumentAnnotations) | **GET** /pdf/\{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
@@ -95,6 +96,7 @@ Class | Method | HTTP request | Description
9596
*PdfApi* | [**getDocumentCaretAnnotations**](docs/PdfApi.md#getDocumentCaretAnnotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations.
9697
*PdfApi* | [**getDocumentCheckBoxFields**](docs/PdfApi.md#getDocumentCheckBoxFields) | **GET** /pdf/\{name}/fields/checkbox | Read document checkbox fields.
9798
*PdfApi* | [**getDocumentCircleAnnotations**](docs/PdfApi.md#getDocumentCircleAnnotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations.
99+
*PdfApi* | [**getDocumentComboBoxFields**](docs/PdfApi.md#getDocumentComboBoxFields) | **GET** /pdf/\{name}/fields/combobox | Read document combobox fields.
98100
*PdfApi* | [**getDocumentFileAttachmentAnnotations**](docs/PdfApi.md#getDocumentFileAttachmentAnnotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment annotations.
99101
*PdfApi* | [**getDocumentFreeTextAnnotations**](docs/PdfApi.md#getDocumentFreeTextAnnotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
100102
*PdfApi* | [**getDocumentHighlightAnnotations**](docs/PdfApi.md#getDocumentHighlightAnnotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations.
@@ -156,6 +158,7 @@ Class | Method | HTTP request | Description
156158
*PdfApi* | [**getPageCaretAnnotations**](docs/PdfApi.md#getPageCaretAnnotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Read document page caret annotations.
157159
*PdfApi* | [**getPageCheckBoxFields**](docs/PdfApi.md#getPageCheckBoxFields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/checkbox | Read document page checkbox fields.
158160
*PdfApi* | [**getPageCircleAnnotations**](docs/PdfApi.md#getPageCircleAnnotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Read document page circle annotations.
161+
*PdfApi* | [**getPageComboBoxFields**](docs/PdfApi.md#getPageComboBoxFields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/combobox | Read document page combobox fields.
159162
*PdfApi* | [**getPageConvertToBmp**](docs/PdfApi.md#getPageConvertToBmp) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/bmp | Convert document page to Bmp image and return resulting file in response.
160163
*PdfApi* | [**getPageConvertToEmf**](docs/PdfApi.md#getPageConvertToEmf) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/emf | Convert document page to Emf image and return resulting file in response.
161164
*PdfApi* | [**getPageConvertToGif**](docs/PdfApi.md#getPageConvertToGif) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/gif | Convert document page to Gif image and return resulting file in response.
@@ -239,6 +242,7 @@ Class | Method | HTTP request | Description
239242
*PdfApi* | [**postBookmark**](docs/PdfApi.md#postBookmark) | **POST** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Add document bookmarks.
240243
*PdfApi* | [**postChangePasswordDocumentInStorage**](docs/PdfApi.md#postChangePasswordDocumentInStorage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
241244
*PdfApi* | [**postCheckBoxFields**](docs/PdfApi.md#postCheckBoxFields) | **POST** /pdf/\{name}/fields/checkbox | Add document checkbox fields.
245+
*PdfApi* | [**postComboBoxFields**](docs/PdfApi.md#postComboBoxFields) | **POST** /pdf/\{name}/fields/combobox | Add document combobox fields.
242246
*PdfApi* | [**postCreateField**](docs/PdfApi.md#postCreateField) | **POST** /pdf/\{name}/fields | Create field.
243247
*PdfApi* | [**postDecryptDocumentInStorage**](docs/PdfApi.md#postDecryptDocumentInStorage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
244248
*PdfApi* | [**postDocumentImageFooter**](docs/PdfApi.md#postDocumentImageFooter) | **POST** /pdf/\{name}/footer/image | Add document image footer.
@@ -295,6 +299,7 @@ Class | Method | HTTP request | Description
295299
*PdfApi* | [**putChangePasswordDocument**](docs/PdfApi.md#putChangePasswordDocument) | **PUT** /pdf/changepassword | Change document password from content.
296300
*PdfApi* | [**putCheckBoxField**](docs/PdfApi.md#putCheckBoxField) | **PUT** /pdf/\{name}/fields/checkbox/\{fieldName} | Replace document checkbox field
297301
*PdfApi* | [**putCircleAnnotation**](docs/PdfApi.md#putCircleAnnotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
302+
*PdfApi* | [**putComboBoxField**](docs/PdfApi.md#putComboBoxField) | **PUT** /pdf/\{name}/fields/combobox/\{fieldName} | Replace document combobox field
298303
*PdfApi* | [**putCreateDocument**](docs/PdfApi.md#putCreateDocument) | **PUT** /pdf/\{name} | Create empty document.
299304
*PdfApi* | [**putDecryptDocument**](docs/PdfApi.md#putDecryptDocument) | **PUT** /pdf/decrypt | Decrypt document from content.
300305
*PdfApi* | [**putEncryptDocument**](docs/PdfApi.md#putEncryptDocument) | **PUT** /pdf/encrypt | Encrypt document from content.
@@ -442,6 +447,10 @@ Class | Description
442447
[**Color**](docs/Color.md) | Represents color DTO.
443448
[**ColorDepth**](docs/ColorDepth.md) | Used to specify the parameter value passed to a Tiff image device.
444449
[**ColumnAdjustment**](docs/ColumnAdjustment.md) | Enumerates column adjustment types.
450+
[**ComboBoxField**](docs/ComboBoxField.md) | Provides ComboBoxField.
451+
[**ComboBoxFieldResponse**](docs/ComboBoxFieldResponse.md) | Represents response containing single combobox field object
452+
[**ComboBoxFields**](docs/ComboBoxFields.md) | Object representing a list of combobox fields.
453+
[**ComboBoxFieldsResponse**](docs/ComboBoxFieldsResponse.md) | Represents response containing multiple combobox field objects
445454
[**CommonFigureAnnotation**](docs/CommonFigureAnnotation.md) | Provides CommonFigureAnnotation.
446455
[**CompressionType**](docs/CompressionType.md) | Used to specify the parameter value passed to a Tiff image device.
447456
[**CryptoAlgorithm**](docs/CryptoAlgorithm.md) | Represent type of cryptographic algorithm that used in encryption/decryption routines.

docs/ComboBoxField.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# ComboBoxField
2+
Provides ComboBoxField.
3+
4+
*Inherited from [ChoiceField](ChoiceField.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**options** | [**Array<Option>**](Option.md) | Gets collection of options of the combobox. | [optional]
9+
**activeState** | **string** | Gets or sets current annotation appearance state. | [optional]
10+
**editable** | **boolean** | Gets or sets editable status of the field. | [optional]
11+
**spellCheck** | **boolean** | Gets or sets spellchaeck activiity status. | [optional]
12+
**selected** | **number** | Gets or sets index of selected item. Numbering of items is started from 1. |
13+
**multiSelect** | **boolean** | Gets or sets multiselection flag.<br />*Inherited from [ChoiceField](ChoiceField.md)* | [optional]
14+
**partialName** | **string** | Field name.<br />*Inherited from [FormField](FormField.md)* | [optional]
15+
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle.<br />*Inherited from [FormField](FormField.md)* | [optional]
16+
**value** | **string** | Field value.<br />*Inherited from [FormField](FormField.md)* | [optional]
17+
**pageIndex** | **number** | Page index.<br />*Inherited from [FormField](FormField.md)* |
18+
**height** | **number** | Gets or sets height of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
19+
**width** | **number** | Gets or sets width of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
20+
**zIndex** | **number** | Z index.<br />*Inherited from [FormField](FormField.md)* | [optional]
21+
**isGroup** | **boolean** | Is group.<br />*Inherited from [FormField](FormField.md)* |
22+
**parent** | [**FormField**](FormField.md) | Gets field parent.<br />*Inherited from [FormField](FormField.md)* | [optional]
23+
**isSharedField** | **boolean** | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.<br />*Inherited from [FormField](FormField.md)* | [optional]
24+
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
25+
**color** | [**Color**](Color.md) | Color of the annotation.<br />*Inherited from [FormField](FormField.md)* | [optional]
26+
**contents** | **string** | Get the field content.<br />*Inherited from [FormField](FormField.md)* | [optional]
27+
**margin** | [**MarginInfo**](MarginInfo.md) | Gets or sets a outer margin for paragraph (for pdf generation)<br />*Inherited from [FormField](FormField.md)* | [optional]
28+
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | Field highlighting mode.<br />*Inherited from [FormField](FormField.md)* | [optional]
29+
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
30+
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
31+
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
32+
33+
[[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/comboBoxField.ts)
34+

docs/ComboBoxFieldResponse.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ComboBoxFieldResponse
2+
Represents response containing single combobox field object
3+
4+
*Inherited from [AsposeResponse](AsposeResponse.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**field** | [**ComboBoxField**](ComboBoxField.md) | Combobox field object | [optional]
9+
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
10+
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]
11+
12+
[[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/comboBoxFieldResponse.ts)
13+

docs/ComboBoxFields.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ComboBoxFields
2+
Object representing a list of combobox fields.
3+
4+
*Inherited from [LinkElement](LinkElement.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**list** | [**Array&lt;ComboBoxField&gt;**](ComboBoxField.md) | List of combobox fields. | [optional]
9+
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
10+
11+
[[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/comboBoxFields.ts)
12+

docs/ComboBoxFieldsResponse.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ComboBoxFieldsResponse
2+
Represents response containing multiple combobox field objects
3+
4+
*Inherited from [AsposeResponse](AsposeResponse.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**fields** | [**ComboBoxFields**](ComboBoxFields.md) | Combobox fields object | [optional]
9+
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
10+
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]
11+
12+
[[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/comboBoxFieldsResponse.ts)
13+

0 commit comments

Comments
 (0)