com.aspose.cells

Class HorizontalPageBreakCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.HorizontalPageBreakCollection

All Implemented Interfaces:

java.lang.Iterable

public class HorizontalPageBreakCollection
extends CollectionBase

Encapsulates a collection of HorizontalPageBreak objects.

Example

 
         Workbook excel = new Workbook();
 
         //Add a pagebreak at G5
         excel.getWorksheets().get(0).getHorizontalPageBreaks().add("G5");
         excel.getWorksheets().get(0).getVerticalPageBreaks().add("G5");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int row) Adds a horizontal page break to the collection.
int	add(int row, int column) Adds a horizontal page break to the collection.
int	add(int row, int startColumn, int endColumn) Adds a horizontal page break to the collection.
int	add(java.lang.String cellName) Adds a horizontal page break to the collection.
HorizontalPageBreak	get(int index) Gets the HorizontalPageBreak element at the specified index.
HorizontalPageBreak	get(java.lang.String cellName) Gets the HorizontalPageBreak element with the specified cell name.
void	removeAt(int index) Removes the HPageBreak 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 HorizontalPageBreak get(int index)

Gets the HorizontalPageBreak 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 HorizontalPageBreak get(java.lang.String cellName)

Gets the HorizontalPageBreak element with the specified cell name.

Parameters:

cellName - Cell name.

Returns:

The element with the specified cell name.

add

public int add(int row,
      int startColumn,
      int endColumn)

Adds a horizontal page break to the collection.

Remarks

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

Parameters:

row - Row index, zero based.

startColumn - Start column index, zero based.

endColumn - End column index, zero based.

Returns:

HorizontalPageBreak object index.

add

public int add(int row)

Adds a horizontal 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.

Returns:

HorizontalPageBreak object index.

add

public int add(int row,
      int column)

Adds a horizontal 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:

HorizontalPageBreak object index.

add

public int add(java.lang.String cellName)

Adds a horizontal 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:

HorizontalPageBreak object index.

removeAt

public void removeAt(int index)

Removes the HPageBreak element at a specified name.

Overrides:

removeAt in class CollectionBase

Parameters:

index - Element index, zero based.