aspose.cells

aspose.cells

Class VerticalPageBreakCollection

Encapsulates a collection of VerticalPageBreak objects.

Property Getters/Setters Summary
functiongetCount()
functionget(index)
Gets the VerticalPageBreak element at the specified index.
functionget(cellName)
Gets the VerticalPageBreak element with the specified cell name.
 
Method Summary
functionadd(column)
Adds a vertical page break to the collection.
functionadd(row, column)
Adds a vertical page break to the collection.
functionadd(startRow, endRow, column)
Adds a vertical page break to the collection.
functionadd(value)
Reserved for internal use.
functionadd(cellName)
Adds a vertical 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 VPageBreak element at a specified name.
 

    • Property Getters/Setters Detail

      • getCount : Number 

        function getCount()

      • get : VerticalPageBreak 

        function 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 

        function 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

        function 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: Number - Start row index, zero based.
        endRow: Number - End row index, zero based.
        column: Number - Column index, zero based.
        Returns:
        VerticalPageBreak object index.

      • add

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

      • add

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

      • add

        function 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

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