com.aspose.cells

com.aspose.cells

Class HorizontalPageBreakCollection

  • java.lang.Object
  • All Implemented Interfaces:
    java.lang.Iterable
    public class HorizontalPageBreakCollection 
    extends CollectionBase

Encapsulates a collection of HorizontalPageBreak objects.

Example:

//Add a pagebreak at G5
excel.getWorksheets().get(0).getHorizontalPageBreaks().add("G5");
excel.getWorksheets().get(0).getVerticalPageBreaks().add("G5");

Property Getters/Setters Summary
intgetCount()
HorizontalPageBreakget(int index)
Gets the HorizontalPageBreak element at the specified index.
HorizontalPageBreakget(java.lang.String cellName)
Gets the HorizontalPageBreak element with the specified cell name.
 
Method Summary
intadd(int row)
Adds a horizontal page break to the collection.
intadd(int row, int column)
Adds a horizontal page break to the collection.
intadd(int row, int startColumn, int endColumn)
Adds a horizontal page break to the collection.
intadd(java.lang.Object value)
Reserved for internal use.
intadd(java.lang.String cellName)
Adds a horizontal page break to the collection.
voidclear()
booleancontains(java.lang.Object value)
Reserved for internal use.
intindexOf(java.lang.Object value)
Reserved for internal use.
java.util.Iteratoriterator()
voidremoveAt(int index)
Removes the HPageBreak element at a specified name.
 

    • Property Getters/Setters Detail

      • getCount

        public int getCount()

      • get

        public HorizontalPageBreak get(int 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

        public HorizontalPageBreak get(java.lang.String 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

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

      • add

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

      • add

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

      • add

        public int add(java.lang.String 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 - Cell name.
        Returns:
        HorizontalPageBreak object index.

      • removeAt

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

      • clear

        public void clear()

      • iterator

        public java.util.Iterator iterator()

      • contains

        public boolean contains(java.lang.Object value)
        Reserved for internal use.

      • add

        public int add(java.lang.Object value)
        Reserved for internal use.

      • indexOf

        public int indexOf(java.lang.Object value)
        Reserved for internal use.