Working with WordProcessing Documents
Introduction
WordProcessing is the most used and known document family format, that includes DOC, DOT, DOCX, DOCM, DOTX, ODT, RTF and much more. All these formats are supported by the GroupDocs.Editor Cloud. There several steps that usage of GroupDocs.Editor Cloud consists of:
- Upload input document into cloud storage
- Load the document into editable representation in the cloud storage (HTML file and resources)
- Download HTML document (and resources, if needed) from storage
- Edit HTML document at client side
- Upload HTML document back into the storage
- Save the edited document into WordProcessing format in the storage
- Download saved document
Steps 1, 3, 4, 5 are storage operations, please refer to this Storage Operations) for usage details. Step 4 is a custom edit operation that can be performed with the programming language or 3rd party tools.
Below is a detailed description of steps 2 and 6.
Loading WordProcessing documents
This REST API provides an ability to load the input documents into an editable representation.
Resources
HTTP POST ~/load
Swagger UI lets you call this REST API directly from the browser. The following properties of loading WordProcessing documents may be customized:
| Name | Description | Comment |
|---|---|---|
| FileInfo.FilePath | The file path in the storage | Required property |
| FileInfo.StorageName | Storage name | Could be omitted for default storage |
| FileInfo.VersionId | File version Id | Useful for storages that support file versioning |
| FileInfo.Password | The password to open file | Should be specified only for password-protected documents |
| OutputPath | The full output path | The directory in storage, where editable files will be stored |
| EnablePagination | Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false). | |
| EnableLanguageInformation | Specifies whether language information is exported to the HTML markup in a form of ‘lang’ HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default, it is disabled (false). | |
| FontExtraction | Responsible for extracting font resources, which are used in the input WordProcessing document. By default doesn’t extract any fonts (NotExtract). Possible values are: NotExtract, ExtractAllEmbedded,ExtractEmbeddedWithoutSystem, ExtractAll |
cURL Example
* First get JSON Web Token
* Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications. Kindly place Client Id in "client_id" and Client Secret in "client_secret" argument.
curl -v "https://api.groupdocs.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=xxxx&client_secret=xxxx" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"
* cURL example to load document
curl -v "https://api.groupdocs.cloud/v1.0/editor/load" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer
<jwt token>"
-d "{
'FileInfo': { 'FilePath': 'WordProcessing/four-pages.docx' },
'OutputPath': 'Output',
'EnablePagination': true,
'FontExtraction': 'ExtractAllEmbedded'
}"
* Response will contain storage path to resultant documents
{
"resourcesPath": "output\four-pages.files",
"htmlPath": "output\four-pages.html"
}
SDKs
Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of GroupDocs.Editor Cloud SDKs along with working examples, to get you started in no time. Please check article to learn how to add an SDK to your project.