AddNewPage - ABBYY Documentation

Adds a page image to a document. The added images become accessible only after they are pre-processed. Use the ProcessBatch method to start batch processing after you add the images. Alternatively, if the images were added to the documents of a task that was opened with the OpenTask method, use the CloseTask method to close the task and send it to the Import stage.

Definition

int AddNewPage(int sessionId, int batchId, int documentId, int previousItemId, Page page, File file);

Parameters

Name	Type	Description
`sessionId`	`int`	The ID of the connection to the Application Server.
`batchId`	`int`	The ID of the batch that contains the document.
`documentId`	`int`	The ID of the document into which the page is added.
`previousItemId`	`int`	The ID that explicitly sets the position of the new page in the set. `-1` adds the page at the end of the set. `0` adds it at the start. A page ID adds it after the page with that ID, which must exist.
`page`	Page	A description of the page. Add pages with a predefined ID field when possible.
`file`	File	The file that contains the page image.

Returned value

Type	Description
`int`	The ID of the added page.

Add a page with a POST request

You can also add a new page from a file that contains an image by using a POST request. First, create a page with an empty file:

file.Name = "FileName";
file.Bytes = new byte[0];

Then execute a POST request with the following parameters.

Parameter	Value
`Action`	`Save`
`objectType`	`1`
`objectId`	`documentId`, the ID of the document to which the page is added
`version`	`0`
`streamName`	`Page 1`, where `1` is the page ID returned by `AddNewPage`

​Definition

​Parameters

​Returned value

​Add a page with a POST request

Definition

Parameters

Returned value

Add a page with a POST request