HorizontalPageBreakCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

public class HorizontalPageBreakCollection extends CollectionBase

Encapsulates a collection of HorizontalPageBreak objects.

Example

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

Methods

Method	Description
add(int row)	Adds a horizontal page break to the collection.
add(int row, int column)	Adds a horizontal page break to the collection.
add(int row, int startColumn, int endColumn)	Adds a horizontal page break to the collection.
add(Object o)	Adds an item to the CollectionBase instance.
add(String cellName)	Adds a horizontal page break to the collection.
clear()	Removes all objects from the CollectionBase instance.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
get(int index)	Gets the HorizontalPageBreak element at the specified index.
get(String cellName)	Gets the HorizontalPageBreak element with the specified cell name.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
removeAt(int index)	Removes the HPageBreak element at a specified name.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(int row)

public int add(int row)

Adds a horizontal page break to the collection.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Parameters:

Parameter	Type	Description
row	int	Cell row index, zero based.

Returns: int - HorizontalPageBreak object index.

add(int row, int column)

public int add(int row, int column)

Adds a horizontal page break to the collection.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Parameters:

Parameter	Type	Description
row	int	Cell row index, zero based.
column	int	Cell column index, zero based.

Returns: int - HorizontalPageBreak object index.

add(int row, int startColumn, int endColumn)

public int add(int row, int startColumn, int endColumn)

Adds a horizontal page break to the collection.

Remarks

This method is used to add a horizontal pagebreak within a print area.

Parameters:

Parameter	Type	Description
row	int	Row index, zero based.
startColumn	int	Start column index, zero based.
endColumn	int	End column index, zero based.

Returns: int - HorizontalPageBreak object index.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

add(String cellName)

public int add(String cellName)

Adds a horizontal page break to the collection.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Parameters:

Parameter	Type	Description
cellName	java.lang.String	Cell name.

Returns: int - HorizontalPageBreak object index.

clear()

public void clear()

Removes all objects from the CollectionBase instance.

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

get(int index)

public HorizontalPageBreak get(int index)

Gets the HorizontalPageBreak element at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero based index of the element.

Returns: HorizontalPageBreak - The element at the specified index.

get(String cellName)

public HorizontalPageBreak get(String cellName)

Gets the HorizontalPageBreak element with the specified cell name.

Parameters:

Parameter	Type	Description
cellName	java.lang.String	Cell name.

Returns: HorizontalPageBreak - The element with the specified cell name.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeAt(int index)

public void removeAt(int index)

Removes the HPageBreak element at a specified name.

Parameters:

Parameter	Type	Description
index	int	Element index, zero based.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int