HorizontalPageBreakCollection
HorizontalPageBreakCollection class
Encapsulates a collection of HorizontalPageBreak objects.
class HorizontalPageBreakCollection;
Example
const { Workbook } = require("aspose.cells.node");
var excel = new Workbook();
//Add a pagebreak at G5
excel.getWorksheets().get(0).getHorizontalPageBreaks().add("G5");
excel.getWorksheets().get(0).getVerticalPageBreaks().add("G5");
Methods
| Method | Description |
|---|---|
| get(number) | Gets the HorizontalPageBreak element at the specified index. |
| get(string) | Gets the HorizontalPageBreak element with the specified cell name. |
| add(number, number, number) | Adds a horizontal page break to the collection. |
| add(number) | Adds a horizontal page break to the collection. |
| add(number, number) | Adds a horizontal page break to the collection. |
| add(string) | Adds a horizontal page break to the collection. |
| removeAt(number) | Removes the HPageBreak element at a specified name. |
| getCount() | Gets the number of elements contained in. |
| isNull() | Checks whether the implementation object is null. |
get(number)
Gets the HorizontalPageBreak element at the specified index.
get(index: number) : HorizontalPageBreak;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index of the element. |
Returns
The element at the specified index.
get(string)
Gets the HorizontalPageBreak element with the specified cell name.
get(cellName: string) : HorizontalPageBreak;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cellName | string | Cell name. |
Returns
The element with the specified cell name.
add(number, number, number)
Adds a horizontal page break to the collection.
add(row: number, startColumn: number, endColumn: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | number | Row index, zero based. |
| startColumn | number | Start column index, zero based. |
| endColumn | number | End column index, zero based. |
Returns
HorizontalPageBreak object index.
Remarks
This method is used to add a horizontal pagebreak within a print area.
add(number)
Adds a horizontal page break to the collection.
add(row: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | number | Cell row index, zero based. |
Returns
HorizontalPageBreak object index.
Remarks
Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.
add(number, number)
Adds a horizontal page break to the collection.
add(row: number, column: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | number | Cell row index, zero based. |
| column | number | Cell column index, zero based. |
Returns
HorizontalPageBreak object index.
Remarks
Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.
add(string)
Adds a horizontal page break to the collection.
add(cellName: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cellName | string | Cell name. |
Returns
HorizontalPageBreak object index.
Remarks
Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.
removeAt(number)
Removes the HPageBreak element at a specified name.
removeAt(index: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | Element index, zero based. |
getCount()
Gets the number of elements contained in.
getCount() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;