Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.cells
Class VPageBreaks

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

public class VPageBreaks
extends java.lang.Object

Encapsulates a collection of VPageBreak objects.


Method Summary
 int add(int column)
          Adds a vertical page break to the VPageBreaks.
 int add(java.lang.String cellName)
          Adds a vertical page break to the VPageBreaks.
 void delete(int index)
          Removes a vertical page break by index.
 VPageBreak get(int index)
          Gets the VPageBreak object by index.
 int size()
          Gets number of the VPageBreak objects.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

add

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

Parameters:
cellName - Cell name.
Returns:
VPageBreak object index.
Throws:
java.lang.IllegalArgumentException - if cell name is invalid.
ExcelException - if VPageBreaks has been removed.

add

public int add(int column)
Adds a vertical page break to the VPageBreaks.

Parameters:
column - Cell column index, zero based.
Returns:
VPageBreak object index.
Throws:
java.lang.IllegalArgumentException - if column index is invalid.
ExcelException - if VPageBreaks has been removed.

delete

public void delete(int index)
Removes a vertical page break by index.

Parameters:
index - the VPageBreak object index.
Throws:
java.lang.IllegalArgumentException - if index is out of range.
ExcelException - if VPageBreaks has been removed.

size

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

Returns:
Number of the VPageBreak objects.

get

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

Parameters:
index - the VPageBreak object index.
Returns:
the VPageBreak object.
Throws:
java.lang.IllegalArgumentException - if index is out of range.
ExcelException - if VPageBreaks has been removed.