Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class HPageBreaks

java.lang.Object
  extended by com.aspose.cells.HPageBreaks

public class HPageBreaks
extends java.lang.Object

Encapsulates a collection of HPageBreak objects.


Method Summary
 int add(int row)
          Adds a horizontal page break to the HPageBreaks.
 int add(java.lang.String cellName)
          Adds a horizontal page break to the HPageBreaks.
 void clear()
          Clear all horizonal page breaks
 void delete(int index)
          Remove a horizontal page break by index.
 HPageBreak get(int index)
          Gets the HPageBreak object by index.
 int size()
          Gets number of the HPageBreak objects.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

add

public int add(java.lang.String cellName)
Adds a horizontal page break to the HPageBreaks.

Parameters:
cellName - cell name
Returns:
HPageBreak object index.
Throws:
CellsException - if HPageBreaks has been removed.
java.lang.IllegalArgumentException - if cell name is invalid.

add

public int add(int row)
Adds a horizontal page break to the HPageBreaks.

Parameters:
row - cell row index, zero based.
Returns:
HPageBreak object index.
Throws:
CellsException - if HPageBreaks has been removed.
java.lang.IllegalArgumentException - if row index is invalid.

size

public int size()
Gets number of the HPageBreak objects.

Returns:
number of the HPageBreak objects.

get

public HPageBreak get(int index)
Gets the HPageBreak object by index.

Parameters:
index - the HPageBreak object index.
Returns:
the HPageBreak object by index.
Throws:
java.lang.IllegalArgumentException - if index is out of range.
CellsException - if HPageBreaks has been removed.

delete

public void delete(int index)
Remove a horizontal page break by index.

Parameters:
index - the HPageBreak object index.
Throws:
java.lang.IllegalArgumentException - if index is out of range.
CellsException - if HPageBreaks has been removed.

clear

public void clear()
Clear all horizonal page breaks