Render a Word document page as an image
Contents
[
Hide
]
Renders a Word document page as an image.
Render a Word document page as an image REST API
| Server | Method | Endpoint |
|---|---|---|
https://api.aspose.cloud/v4.0 |
PUT | /words/online/get/pages/{pageIndex}/render |
, where:
pageIndex(required) — the index of the page.
You can use the following parameters in a REST request:
| Parameter Name | Data Type | Required/Optional | Description |
|---|---|---|---|
format |
string | Required | The destination format. |
loadEncoding |
string | Optional | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password |
string | Optional | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword |
string | Optional | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
fontsLocation |
string | Optional | Folder in filestorage with custom fonts. |
Use $multipart/form-data request to combine one or more properties into a single body:
| Property Name | Data Type | Required/Optional | Description |
|---|---|---|---|
document |
string(binary) | Required | The document. |
Note: to access this REST API, you need to register and get personal credentials. Use the ‘Quick Start’ guide to go through the procedure in a couple of minutes.
Render a Word document page as an image usage examples
Let’s look at practical examples of using the web service. You can do this both with cURL and Postman utilities, and from your code in various programming languages: Python, Java, JavaScript, C#, PHP, C++, Go, Ruby, Swift, Dart.
How to render a Word document page as an image with cURL or Postman
One of the easiest and fastest ways to call a REST API is to use cURL or Postman:
How to render a Word document page as an image in Python, Java, C#, C++, JavaScript and other programming languages
Using SDK is the quickest way to speed up the development. Please take a look at the provided code examples to quickly call this web service from your favourite programming language:
See Also
- GitHub repository — explore Aspose.Words Cloud SDK Family. These software libraries take care of all low-level document-processing details.