Generate Document Pages Preview

Last modified by Muhammad Rizwan on 2020/01/21 09:24

Introduction

This REST API provides an ability to generate document pages of image representations.
There are several ways to specify page numbers needed for preview:

  • Provide exact page numbers via Pages collection;
  • Specify pages range start/end page numbers. There is also an ability to get only even/odd pages from the specified page range by setting RangeMode property. 

For protected documents, it is also required to provide a password.
The following properties of preview may be customized:

Name

Description

Comment

FilePath

The file path in the storage

Required property

StorageName

Storage name

Could be omitted for default storage

VersionId

File version Id

Useful for storages that support file versioning

Password

The password to open file

Should be specified only for password-protected documents

Pages

Collection of page numbers to use in a Join operation

The first page should have number 1

StartPageNumber

Start page number

Ignored if Pages collection is not empty

EndPageNumber

End page number

Ignored if Pages collection is not empty

RangeMode

Page range mode: Even, Odd, All. The default value is All

Ignored if Pages collection is not empty

Width

Image width in pixels

Optional

Height

Image height in pixels

Optional

Format

Image format - JPG, PNG, BMP

The default value is JPG

OutputPath

Path format to resultant images

Required

Resource URI

HTTP POST ~/preview

Swagger UI lets you call this REST API directly from the browser.  

cURL Example

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.Merger Cloud SDKs along with working examples, to get you started in no time. Please check the article to learn how to add an SDK to your project.

Generate Document Pages Preview

Tags:
Created by Farooq Sheikh on 2020/01/02 10:17