class

HorizontalPageBreakCollection

Source: aspose.cells.doc.js:39789

Encapsulates a collection of HorizontalPageBreak objects.

Methods

add(row, startColumn, endColumn)
add(row)
add(row, column)
add(cellName)
add()
clear()
contains()
get(index)
get(cellName)
get()
getCount()
indexOf()
iterator()
removeAt(index)

Methods

add(row, startColumn, endColumn) → Number

Adds a horizontal page break to the collection. This method is used to add a horizontal pagebreak within a print area.

Parameters

Name Type Optional Description

row

Number

 

Row index, zero based.

startColumn

Number

 

Start column index, zero based.

endColumn

Number

 

End column index, zero based.
Returns

Number HorizontalPageBreak object index.

add(row) → Number

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

Name Type Optional Description

row

Number

 

Cell row index, zero based.
Returns

Number HorizontalPageBreak object index.

add(row, column) → Number

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.

Parameters

Name Type Optional Description

row

Number

 

Cell row index, zero based.

column

Number

 

Cell column index, zero based.
Returns

Number HorizontalPageBreak object index.

add(cellName) → Number

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

Name Type Optional Description

cellName

String

 

Cell name.
Returns

Number HorizontalPageBreak object index.

add()

Reserved for internal use.

clear()

contains()

Reserved for internal use.

get(index) → HorizontalPageBreak

Gets the HorizontalPageBreak element at the specified index.

Parameter

Name Type Optional Description

index

Number

 

The zero based index of the element.
Returns

HorizontalPageBreak The element at the specified index.

get(cellName) → HorizontalPageBreak

Gets the HorizontalPageBreak element with the specified cell name.

Parameter

Name Type Optional Description

cellName

String

 

Cell name.
Returns

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

Name Type Optional Description

index

Number

 

Element index, zero based.