asposecells.api
Class VerticalPageBreakCollection

Encapsulates a collection of VerticalPageBreak objects.

Property Getters/Setters Summary
methodgetCount()
          
methodget(index)
           Gets the VerticalPageBreak element at the specified index.
methodget(cellName)
           Gets the VerticalPageBreak element with the specified cell name.
 
Method Summary
methodadd(column)
           Adds a vertical page break to the collection.
methodadd(row, column)
           Adds a vertical page break to the collection.
methodadd(startRow, endRow, column)
           Adds a vertical page break to the collection.
methodadd(value)→ inherited from CollectionBase
          Reserved for internal use.
methodadd(cellName)
           Adds a vertical page break to the collection.
methodclear()→ inherited from CollectionBase
          
methodcontains(value)→ inherited from CollectionBase
          Reserved for internal use.
methodget(index)→ inherited from CollectionBase
          Reserved for internal use.
methodindexOf(value)→ inherited from CollectionBase
          Reserved for internal use.
methoditerator()→ inherited from CollectionBase
          
methodremoveAt(index)
           Removes the VPageBreak element at a specified name.
 

Property Getters/Setters Detail

getCount : int 

int getCount()

get : VerticalPageBreak 

VerticalPageBreak get(index)
Gets the VerticalPageBreak element at the specified index.
Parameters:
index - The zero based index of the element.
Returns:
The element at the specified index.

get : VerticalPageBreak 

VerticalPageBreak get(cellName)
Gets the VerticalPageBreak element with the specified cell name.
Parameters:
cellName - Cell name.
Returns:
The element with the specified cell name.

Method Detail

add

int add(startRow, endRow, column)
Adds a vertical page break to the collection. This method is used to add a vertical pagebreak within a print area.
Parameters:
startRow: int - Start row index, zero based.
endRow: int - End row index, zero based.
column: int - Column index, zero based.
Returns:
VerticalPageBreak object index.

add

int add(column)
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:
column: int - Cell column index, zero based.
Returns:
VerticalPageBreak object index.

add

int add(row, column)
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:
row: int - Cell row index, zero based.
column: int - Cell column index, zero based.
Returns:
VerticalPageBreak object index.

add

int add(cellName)
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:
cellName: String - Cell name.
Returns:
VerticalPageBreak object index.

removeAt

 removeAt(index)
Removes the VPageBreak element at a specified name.
Parameters:
index: int - Element index, zero based.

clear

 clear()

iterator

Iterator iterator()

get

Object get(index)
Reserved for internal use.

contains

boolean contains(value)
Reserved for internal use.

add

int add(value)
Reserved for internal use.

indexOf

int indexOf(value)
Reserved for internal use.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.