HorizontalPageBreakCollection
HorizontalPageBreakCollection class
Encapsulates a collection of HorizontalPageBreak objects.
Methods
| Name | Description |
|---|---|
| add(row, startColumn, endColumn) | Adds a horizontal page break to the collection. This method is used to add a horizontal pagebreak within a print area. |
| add(row) | Adds a horizontal page break to the collection. Page break is added in the top left of the cell. Please set a horizontal |
| add(row, column) | Adds a horizontal page break to the collection. Page break is added in the top left of the cell. Please set a horizontal |
| add(cellName) | Adds a horizontal page break to the collection. Page break is added in the top left of the cell. Please set a horizontal |
| add() | Reserved for internal use. |
| clear() | |
| contains() | Reserved for internal use. |
| get(index) | Gets the HorizontalPageBreak element at the specified index. |
| get(cellName) | Gets the HorizontalPageBreak element with the specified cell name. |
| get() | Reserved for internal use. |
| getCount() | |
| indexOf() | Reserved for internal use. |
| iterator() | |
| removeAt(index) | Removes the HPageBreak element at a specified name. |
add(row, startColumn, endColumn)
Adds a horizontal page break to the collection. This method is used to add a horizontal pagebreak within a print area.
| Parameter | Type | Description |
|---|---|---|
| row | Number | Row index, zero based. |
| startColumn | Number | Start column index, zero based. |
| endColumn | Number | End column index, zero based. |
Returns: Number — Number HorizontalPageBreak object index.
add(row)
Adds a horizontal page break to the collection. Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.
| Parameter | Type | Description |
|---|---|---|
| row | Number | Cell row index, zero based. |
Returns: Number — Number HorizontalPageBreak object index.
add(row, column)
Adds a horizontal page break to the collection. Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.
| Parameter | Type | Description |
|---|---|---|
| row | Number | Cell row index, zero based. |
| column | Number | Cell column index, zero based. |
Returns: Number — Number HorizontalPageBreak object index.
add(cellName)
Adds a horizontal page break to the collection. Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | Cell name. |
Returns: Number — Number HorizontalPageBreak object index.
add()
Reserved for internal use.
clear()
contains()
Reserved for internal use.
get(index)
Gets the HorizontalPageBreak element at the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | Number | The zero based index of the element. |
Returns: HorizontalPageBreak — HorizontalPageBreak The element at the specified index.
get(cellName)
Gets the HorizontalPageBreak element with the specified cell name.
| Parameter | Type | Description |
|---|---|---|
| cellName | String | Cell name. |
Returns: HorizontalPageBreak — HorizontalPageBreak The element with the specified cell name.
get()
Reserved for internal use.
getCount()
indexOf()
Reserved for internal use.
iterator()
removeAt(index)
Removes the HPageBreak element at a specified name.
| Parameter | Type | Description |
|---|---|---|
| index | Number | Element index, zero based. |