XFormCollection

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Iterable

public final class XFormCollection implements Iterable<XForm>

Class represents collection of XFormCollection.

Methods

MethodDescription
size()Gets count of XForms in collection.
isSynchronized()Returns true if object is synchronized.
getSyncRoot()Synchronization object.
isReadOnly()Gets a value indicating whether the collection is read-only.
add(XForm xform)Adds new XForm into collection.
delete(int index)Delete XForm from collectin
delete()Deletes all XForms from collection.
copyTo(XForm[] array, int index)Copies XFormCollection into collection.
iterator()Returns collection enumerator.
delete(String name)Deletes XForm from collection by form name.
get_Item(int index)Returns XForm by index.
get_Item(String name)Returns XForm by its name.
getFormName(XForm form)Returns name of the form in this form collection
hasForm(String formName)
clear()Clears all items from the collection.
contains(XForm item)Determines whether the collection contains a specific value.
remove(XForm item)Deletes specified item from collection.

size()

public int size()

Gets count of XForms in collection.

Returns: int - int value

isSynchronized()

public boolean isSynchronized()

Returns true if object is synchronized.

Returns: boolean - boolean

getSyncRoot()

public Object getSyncRoot()

Synchronization object.

Returns: java.lang.Object - Object

isReadOnly()

public boolean isReadOnly()

Gets a value indicating whether the collection is read-only.

Returns: boolean - boolean value

add(XForm xform)

public void add(XForm xform)

Adds new XForm into collection.

Parameters:

ParameterTypeDescription
xformXFormXForm to add into collection

delete(int index)

public void delete(int index)

Delete XForm from collectin

Parameters:

ParameterTypeDescription
indexintIndex of XForm which must be deleted

delete()

public void delete()

Deletes all XForms from collection.

copyTo(XForm[] array, int index)

public void copyTo(XForm[] array, int index)

Copies XFormCollection into collection.

Parameters:

ParameterTypeDescription
arrayXForm[]Array of XForm to be copied
indexintIndex where XFormCollection will be copied

iterator()

public Iterator<XForm> iterator()

Returns collection enumerator.

Returns: java.util.Iterator<com.aspose.pdf.XForm> - Enumerator for collection

delete(String name)

public void delete(String name)

Deletes XForm from collection by form name.

Parameters:

ParameterTypeDescription
namejava.lang.StringName of XForm to be deleted.

get_Item(int index)

public XForm get_Item(int index)

Returns XForm by index.

Parameters:

ParameterTypeDescription
indexintIndex of XFormCollection. XForms numbering is started from 1

Returns: XForm - Retrieved XForm

get_Item(String name)

public XForm get_Item(String name)

Returns XForm by its name. Exception is thrown if XForm with specified name is not found.

Parameters:

ParameterTypeDescription
namejava.lang.StringName of XForm

Returns: XForm - Retrieved XForm object

getFormName(XForm form)

public String getFormName(XForm form)

Returns name of the form in this form collection

Parameters:

ParameterTypeDescription
formXFormForm which name is searched

Returns: java.lang.String - Form name in the collection; Null if form is not contained in the collection

hasForm(String formName)

public boolean hasForm(String formName)

Parameters:

ParameterTypeDescription
formNamejava.lang.String

Returns: boolean

clear()

public void clear()

Clears all items from the collection.

contains(XForm item)

public boolean contains(XForm item)

Determines whether the collection contains a specific value.

Parameters:

ParameterTypeDescription
itemXFormThe object to locate in the collection

Returns: boolean - true if item is found in the collection; otherwise, false.

remove(XForm item)

public boolean remove(XForm item)

Deletes specified item from collection.

Parameters:

ParameterTypeDescription
itemXFormThe object to delete

Returns: boolean - true if item was deleted from collection; otherwise, false.