VerticalPageBreakCollection
VerticalPageBreakCollection class
Encapsulates a collection of VerticalPageBreak objects.
class VerticalPageBreakCollection;
Methods
| Method | Description |
|---|---|
| get(number) | Gets the VerticalPageBreak element at the specified index. |
| add(number, number, number) | Adds a vertical page break to the collection. |
| add(number) | Adds a vertical page break to the collection. |
| add(number, number) | Adds a vertical page break to the collection. |
| add(string) | Adds a vertical page break to the collection. |
| removeAt(number) | Removes the VPageBreak element at a specified name. |
| getCount() | Gets the number of elements contained in. |
get(number)
Gets the VerticalPageBreak element at the specified index.
get(index: number) : VerticalPageBreak;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index of the element. |
Returns
The element at the specified index.
add(number, number, number)
Adds a vertical page break to the collection.
add(startRow: number, endRow: number, column: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startRow | number | Start row index, zero based. |
| endRow | number | End row index, zero based. |
| column | number | Column index, zero based. |
Returns
VerticalPageBreak object index.
Remarks
This method is used to add a vertical pagebreak within a print area.
add(number)
Adds a vertical page break to the collection.
add(column: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| column | number | Cell column index, zero based. |
Returns
VerticalPageBreak 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 vertical 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
VerticalPageBreak 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 vertical page break to the collection.
add(cellName: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cellName | string | Cell name. |
Returns
VerticalPageBreak 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 VPageBreak 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;