com.aspose.cells

Class VerticalPageBreakCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.VerticalPageBreakCollection

All Implemented Interfaces:

java.lang.Iterable

public class VerticalPageBreakCollection
extends CollectionBase

Encapsulates a collection of VerticalPageBreak objects.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int column) Adds a vertical page break to the collection.
int	add(int row, int column) Adds a vertical page break to the collection.
int	add(int startRow, int endRow, int column) Adds a vertical page break to the collection.
int	add(java.lang.String cellName) Adds a vertical page break to the collection.
VerticalPageBreak	get(int index) Gets the VerticalPageBreak element at the specified index.
VerticalPageBreak	get(java.lang.String cellName) Gets the VerticalPageBreak element with the specified cell name.
void	removeAt(int index) Removes the VPageBreak element at a specified name.

Methods inherited from class com.aspose.cells.CollectionBase

add, clear, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public VerticalPageBreak get(int index)

Gets the VerticalPageBreak element at the specified index.

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

get

public VerticalPageBreak get(java.lang.String cellName)

Gets the VerticalPageBreak element with the specified cell name.

Parameters:

cellName - Cell name.

Returns:

The element with the specified cell name.

add

public int add(int startRow,
      int endRow,
      int column)

Adds a vertical page break to the collection.

Remarks

This method is used to add a vertical pagebreak within a print area.

Parameters:

startRow - Start row index, zero based.

endRow - End row index, zero based.

column - Column index, zero based.

Returns:

VerticalPageBreak object index.

add

public int add(int column)

Adds a vertical page break to the collection.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Parameters:

column - Cell column index, zero based.

Returns:

VerticalPageBreak object index.

add

public int add(int row,
      int column)

Adds a vertical page break to the collection.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Parameters:

row - Cell row index, zero based.

column - Cell column index, zero based.

Returns:

VerticalPageBreak object index.

add

public int add(java.lang.String cellName)

Adds a vertical page break to the collection.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Parameters:

cellName - Cell name.

Returns:

VerticalPageBreak object index.

removeAt

public void removeAt(int index)

Removes the VPageBreak element at a specified name.

Overrides:

removeAt in class CollectionBase

Parameters:

index - Element index, zero based.