com.aspose.slides

Class PortionCollection

java.lang.Object

com.aspose.slides.DomObject<Paragraph>

com.aspose.slides.PortionCollection

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IPortion>, com.aspose.ms.System.Collections.IEnumerable<IPortion>, IPortionCollection, java.lang.Iterable<IPortion>

public final class PortionCollection
extends DomObject<Paragraph>
implements IPortionCollection

Represents a collection of portions.

Method Summary

Modifier and Type	Method and Description
void	add(IPortion value) Adds a Portion to the end of collection.
void	clear() Removes all elements from the collection.
boolean	contains(IPortion item) Determines whether the IGenericCollection contains a specific value.
void	copyTo(IPortion[] array, int arrayIndex) Copies the elements of the IGenericCollection to an Array, starting at a particular Array index.
IPortion	get_Item(int index) Gets the element at the specified index.
int	getCount() Gets the number of elements actually contained in the collection.
int	indexOf(IPortion item) Determines the index of a specific item in the List.
void	insert(int index, IPortion value) Inserts a Portion into the collection at the specified index.
boolean	isReadOnly() Gets a value indicating whether the IGenericCollection is read-only.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IPortion>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IPortion>	iteratorJava() Returns a java iterator for the entire collection.
boolean	remove(IPortion item) Removes the first occurrence of a specific object from the IGenericCollection.
void	removeAt(int index) Removes the element at the specified index of the collection.
void	set_Item(int index, IPortion value) Gets the element at the specified index.

Methods inherited from class com.aspose.slides.DomObject

getParent_Immediate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public final int getCount()

Gets the number of elements actually contained in the collection. Read-only int.

Specified by:

getCount in interface IPortionCollection

isReadOnly

public final boolean isReadOnly()

Gets a value indicating whether the IGenericCollection is read-only. Read-only boolean.

Returns:

true if the IGenericCollection is read-only; otherwise, false.

get_Item

public final IPortion get_Item(int index)

Gets the element at the specified index.

Specified by:

get_Item in interface IPortionCollection

set_Item

public final void set_Item(int index,
                           IPortion value)

Gets the element at the specified index.

add

public final void add(IPortion value)

Adds a Portion to the end of collection.

Specified by:

add in interface IPortionCollection

Parameters:

value - The Portion to be added to the end of the collection.

indexOf

public final int indexOf(IPortion item)

Determines the index of a specific item in the List.

Specified by:

indexOf in interface IPortionCollection

Parameters:

item - The object to locate in the List.

Returns:

The index of item if found in the list; otherwise, -1.

insert

public final void insert(int index,
                         IPortion value)

Inserts a Portion into the collection at the specified index.

Specified by:

insert in interface IPortionCollection

Parameters:

index - The zero-based index at which Portion should be inserted.

value - The Portion to insert.

clear

public final void clear()

Removes all elements from the collection.

Specified by:

clear in interface IPortionCollection

contains

public final boolean contains(IPortion item)

Determines whether the IGenericCollection contains a specific value.

Specified by:

contains in interface IPortionCollection

Parameters:

item - The object to locate in the IGenericCollection.

Returns:

true if item is found in the IGenericCollection; otherwise, false.

copyTo

public final void copyTo(IPortion[] array,
                         int arrayIndex)

Copies the elements of the IGenericCollection to an Array, starting at a particular Array index.

Parameters:

array - The one-dimensional Array that is the destination of the elements copied from IGenericCollection. The Array must have zero-based indexing.

arrayIndex - The zero-based index in array at which copying begins.

Throws:

com.aspose.ms.System.ArgumentNullException - array is null.

com.aspose.ms.System.ArgumentOutOfRangeException - arrayIndex is less than 0.

com.aspose.ms.System.ArgumentException - The number of elements in the source IGenericCollection is greater than the available space from arrayIndex to the end of the destination array.

remove

public final boolean remove(IPortion item)

Removes the first occurrence of a specific object from the IGenericCollection.

Specified by:

remove in interface IPortionCollection

Parameters:

item - The object to remove from the IGenericCollection.

Returns:

true if item was successfully removed from the IGenericCollection; otherwise, false. This method also returns false if item is not found in the original IGenericCollection.

Throws:

com.aspose.ms.System.NotSupportedException - The IGenericCollection is read-only.

removeAt

public final void removeAt(int index)

Removes the element at the specified index of the collection.

Specified by:

removeAt in interface IPortionCollection

Parameters:

index - The zero-based index of the element to remove.

iterator

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IPortion> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IPortion>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<IPortion>

Specified by:

iterator in interface java.lang.Iterable<IPortion>

Returns:

A IGenericEnumerator that can be used to iterate through the collection.

iteratorJava

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IPortion> iteratorJava()

Returns a java iterator for the entire collection.

Returns:

An Iterator for the entire collection.