aspose.cells

aspose.cells

Class HorizontalPageBreakCollection

Encapsulates a collection of HorizontalPageBreak objects.

Example:

$workbook = new cells\Workbook();
//Add a pagebreak at G5
$workbook->getWorksheets()->get(0)->getHorizontalPageBreaks()->add("G5");
$workbook->getWorksheets()->get(0)->getVerticalPageBreaks()->add("G5");

Property Getters/Setters Summary
functiongetCount()
functionget(index)
Gets the HorizontalPageBreak element at the specified index.
functionget(cellName)
Gets the HorizontalPageBreak element with the specified cell name.
 
Method Summary
functionadd(row)
Adds a horizontal page break to the collection.
functionadd(row, column)
Adds a horizontal page break to the collection.
functionadd(row, startColumn, endColumn)
Adds a horizontal page break to the collection.
functionadd(value)
Reserved for internal use.
functionadd(cellName)
Adds a horizontal page break to the collection.
functionclear()
functioncontains(value)
Reserved for internal use.
functionget(index)
Reserved for internal use.
functionindexOf(value)
Reserved for internal use.
functioniterator()
functionremoveAt(index)
Removes the HPageBreak element at a specified name.
 

    • Property Getters/Setters Detail

      • getCount : Number 

        function getCount()

      • get : HorizontalPageBreak 

        function 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 

        function 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

        function 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: Number - Row index, zero based.
        startColumn: Number - Start column index, zero based.
        endColumn: Number - End column index, zero based.
        Returns:
        HorizontalPageBreak object index.

      • add

        function 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: Number - Cell row index, zero based.
        Returns:
        HorizontalPageBreak object index.

      • add

        function 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: Number - Cell row index, zero based.
        column: Number - Cell column index, zero based.
        Returns:
        HorizontalPageBreak object index.

      • add

        function 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

        function removeAt(index)
        Removes the HPageBreak element at a specified name.
        Parameters:
        index: Number - Element index, zero based.

      • clear

        function clear()

      • iterator

        function iterator()

      • get

        function get(index)
        Reserved for internal use.

      • contains

        function contains(value)
        Reserved for internal use.

      • add

        function add(value)
        Reserved for internal use.

      • indexOf

        function indexOf(value)
        Reserved for internal use.