class

VerticalPageBreakCollection

Source: aspose.cells.doc.js:91303

Encapsulates a collection of VerticalPageBreak objects.

Methods

add(startRow, endRow, column)
add(column)
add(row, column)
add(cellName)
add()
clear()
contains()
get(index)
get(cellName)
get()
getCount()
indexOf()
iterator()
removeAt(index)

Methods

add(startRow, endRow, column) → Number

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

Parameters

Name Type Optional Description

startRow

Number

 

Start row index, zero based.

endRow

Number

 

End row index, zero based.

column

Number

 

Column index, zero based.
Returns

Number VerticalPageBreak object index.

add(column) → Number

Adds a vertical 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

column

Number

 

Cell column index, zero based.
Returns

Number VerticalPageBreak object index.

add(row, column) → Number

Adds a vertical 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 VerticalPageBreak object index.

add(cellName) → Number

Adds a vertical 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 VerticalPageBreak object index.

add()

Reserved for internal use.

clear()

contains()

Reserved for internal use.

get(index) → VerticalPageBreak

Gets the VerticalPageBreak element at the specified index.

Parameter

Name Type Optional Description

index

Number

 

The zero based index of the element.
Returns

VerticalPageBreak The element at the specified index.

get(cellName) → VerticalPageBreak

Gets the VerticalPageBreak element with the specified cell name.

Parameter

Name Type Optional Description

cellName

String

 

Cell name.
Returns

VerticalPageBreak The element with the specified cell name.

get()

Reserved for internal use.

getCount()

indexOf()

Reserved for internal use.

iterator()

removeAt(index)

Removes the VPageBreak element at a specified name.

Parameter

Name Type Optional Description

index

Number

 

Element index, zero based.