Add a Vertical Page Break
Contents
[
Hide
]
This REST API inserts a vertical page break into a worksheet.
REST API
PUT https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/verticalpagebreaks
Request Parameters
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| name | string | path | The name of the Excel workbook. |
| sheetName | string | path | The name of the worksheet where the page break will be added. |
| cellname | string | query | The cell reference (e.g., A1) that defines the page‑break location. |
| column | integer | query | The zero-based index of the column where the page break starts. |
| row | integer | query | The zero-based index of the row where the page break starts. |
| startRow | integer | query | The first row of the page‑break range. |
| endRow | integer | query | The last row of the page‑break range. |
| folder | string | query | The folder path in the storage where the workbook is located. |
| storageName | string | query | The name of the storage service. |
Required parameters – Either cellname or column must be supplied. When column is used you may also provide row, startRow, and endRow to define a range. All other fields are optional.
The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.
cURL Example
curl -v "https://api.aspose.cloud/v3.0/cells/SampleBreaks.xlsx/worksheets/Sheet1/verticalpagebreaks?column=9" \
-X PUT \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"
Response
{
"Code": 200,
"Status": "OK"
}
Error Codes
| HTTP Status | Description | Sample Error JSON |
|---|---|---|
| 400 | Bad request – missing or invalid parameters. | { "Code": 400, "Message": "Invalid parameter: column" } |
| 401 | Unauthorized – invalid or missing JWT token. | { "Code": 401, "Message": "Authentication failed." } |
| 404 | Not found – workbook or worksheet does not exist. | { "Code": 404, "Message": "File not found." } |
| 500 | Internal server error – unexpected condition. | { "Code": 500, "Message": "An unexpected error occurred." } |
Cloud SDK Family
Using an SDK is the best way to speed up development. An SDK handles low‑level details and lets you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.
The following code examples demonstrate how to make calls to Aspose.Cells web services using various SDKs: