VerticalPageBreakCollection

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

public class VerticalPageBreakCollection extends CollectionBase

Encapsulates a collection of VerticalPageBreak objects.

Methods

MethodDescription
add(int column)Adds a vertical page break to the collection.
add(int row, int column)Adds a vertical page break to the collection.
add(int startRow, int endRow, int column)Adds a vertical page break to the collection.
add(Object o)Adds an item to the CollectionBase instance.
add(String cellName)Adds a vertical 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 VerticalPageBreak element at the specified index.
get(String cellName)Gets the VerticalPageBreak 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 VPageBreak element at a specified name.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(int column)

public int add(int column)

Adds a vertical 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:

ParameterTypeDescription
columnintCell column index, zero based.

Returns: int - VerticalPageBreak object index.

add(int row, int column)

public int add(int row, int column)

Adds a vertical 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:

ParameterTypeDescription
rowintCell row index, zero based.
columnintCell column index, zero based.

Returns: int - VerticalPageBreak object index.

add(int startRow, int endRow, int column)

public int add(int startRow, int endRow, int column)

Adds a vertical page break to the collection.

Remarks

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

Parameters:

ParameterTypeDescription
startRowintStart row index, zero based.
endRowintEnd row index, zero based.
columnintColumn index, zero based.

Returns: int - VerticalPageBreak object index.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

ParameterTypeDescription
ojava.lang.ObjectThe 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 vertical 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:

ParameterTypeDescription
cellNamejava.lang.StringCell name.

Returns: int - VerticalPageBreak 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:

ParameterTypeDescription
ojava.lang.Objecttest object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

get(int index)

public VerticalPageBreak get(int index)

Gets the VerticalPageBreak element at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero based index of the element.

Returns: VerticalPageBreak - The element at the specified index.

get(String cellName)

public VerticalPageBreak get(String cellName)

Gets the VerticalPageBreak element with the specified cell name.

Parameters:

ParameterTypeDescription
cellNamejava.lang.StringCell name.

Returns: VerticalPageBreak - 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:

ParameterTypeDescription
ojava.lang.ObjectDetermines 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 VPageBreak element at a specified name.

Parameters:

ParameterTypeDescription
indexintElement 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:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int