asposecells.api
Class HorizontalPageBreakCollection

Encapsulates a collection of HorizontalPageBreak objects.

Example:

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

Property Getters/Setters Summary
methodgetCount()
          
methodget(index)
           Gets the HorizontalPageBreak element at the specified index.
methodget(cellName)
           Gets the HorizontalPageBreak element with the specified cell name.
 
Method Summary
methodadd(row)
           Adds a horizontal page break to the collection.
methodadd(row, column)
           Adds a horizontal page break to the collection.
methodadd(row, startColumn, endColumn)
           Adds a horizontal page break to the collection.
methodadd(value)→ inherited from CollectionBase
          Reserved for internal use.
methodadd(cellName)
           Adds a horizontal 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 HPageBreak element at a specified name.
 

Property Getters/Setters Detail

getCount : int 

int getCount()

get : HorizontalPageBreak 

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

get : HorizontalPageBreak 

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

Method Detail

add

int add(row, startColumn, endColumn)
Adds a horizontal page break to the collection. This method is used to add a horizontal pagebreak within a print area.
Parameters:
row: int - Row index, zero based.
startColumn: int - Start column index, zero based.
endColumn: int - End column index, zero based.
Returns:
HorizontalPageBreak object index.

add

int add(row)
Adds a horizontal 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.
Returns:
HorizontalPageBreak object index.

add

int add(row, column)
Adds a horizontal 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:
HorizontalPageBreak object index.

add

int add(cellName)
Adds a horizontal 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:
HorizontalPageBreak object index.

removeAt

 removeAt(index)
Removes the HPageBreak 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.