com.aspose.words

Class FieldCollection

java.lang.Object

com.aspose.words.FieldCollection

All Implemented Interfaces:

java.lang.Iterable

public class FieldCollection
extends java.lang.Object
implements java.lang.Iterable

A collection of Field objects that represents the fields in the specified range.

An instance of this collection iterates fields which start fall within the specified range.

The FieldCollection collection does not own the fields it contains, rather, is just a selection of fields.

The FieldCollection collection is "live", i.e. changes to the children of the node object that it was created from are immediately reflected in the fields returned by the FieldCollection properties and methods.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all fields of this collection from the document and from this collection itself.
Field	get(int index) Returns a field at the specified index.
int	getCount() Returns the number of the fields in the collection.
java.util.Iterator	iterator() Returns an enumerator object.
void	remove(Field field) Removes the specified field from this collection and from the document.
void	removeAt(int index) Removes a field at the specified index from this collection and from the document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public int getCount()

Returns the number of the fields in the collection.

Returns:

The number of the fields in the collection.

get

public Field get(int index)

Returns a field at the specified index.

The index is zero-based.

Negative indexes are allowed and indicate access from the back of the collection. For example -1 means the last item, -2 means the second before last and so on.

If index is greater than or equal to the number of items in the list, this returns a null reference.

If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.

Parameters:

index - An index into the collection.

Returns:

A field at the specified index.

remove

public void remove(Field field)
            throws java.lang.Exception

Removes the specified field from this collection and from the document.

Parameters:

field - A field to remove.

Throws:

java.lang.Exception

removeAt

public void removeAt(int index)
              throws java.lang.Exception

Removes a field at the specified index from this collection and from the document.

Parameters:

index - An index into the collection.

Throws:

java.lang.Exception

clear

public void clear()
           throws java.lang.Exception

Removes all fields of this collection from the document and from this collection itself.

Throws:

java.lang.Exception

iterator

public java.util.Iterator iterator()

Returns an enumerator object.

Specified by:

iterator in interface java.lang.Iterable