XFormCollection
Inheritance: java.lang.Object, com.aspose.pdf.XFormCollection
All Implemented Interfaces: Iterable < XForm >
public final class XFormCollection extends Object implements Iterable < XForm >
Class represents collection of XFormCollection.
Methods
| Method | Description |
|---|---|
| add | Adds new XForm into collection. |
| clear | Clears all items from the collection. |
| contains | Determines whether the collection contains a specific value. |
| copyTo | Copies XFormCollection into collection. |
| delete | Deletes all XForms from collection. |
| delete | Delete XForm from collectin |
| delete | Deletes all XForms from collection. |
| freeMemory | Clears cached data, frees memory etc. |
| get_Item | Returns XForm by index. |
| get_Item | Returns XForm by its name. Exception is thrown if XForm with specified name is not found. |
| getFormName | Returns name of the form in this form collection |
| getSyncRoot | Synchronization object. |
| hasForm | |
| isReadOnly | Gets a value indicating whether the collection is read-only. |
| isSynchronized | Returns true if object is synchronized. |
| iterator | Returns collection enumerator. |
| remove | Deletes specified item from collection. |
| size | Gets count of XForms in collection. |
add
Adds new XForm into collection.
clear
public void clear()
Clears all items from the collection.
contains
Determines whether the collection contains a specific value.
copyTo
Copies XFormCollection into collection.
delete
public void delete()
Deletes all XForms from collection.
delete
public void delete(int index)
Delete XForm from collectin
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | Index of XForm which must be deleted |
delete
Deletes all XForms from collection.
freeMemory
public final void freeMemory()
Clears cached data, frees memory etc.
get_Item
public XForm get_Item(int index)
Returns XForm by index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | Index of XFormCollection. XForms numbering is started from 1 |
Returns: Retrieved XForm
get_Item
Returns XForm by its name. Exception is thrown if XForm with specified name is not found.
getFormName
Returns name of the form in this form collection
getSyncRoot
public Object getSyncRoot()
Synchronization object.
Returns: Object
hasForm
isReadOnly
public boolean isReadOnly()
Gets a value indicating whether the collection is read-only.
Returns: boolean value
isSynchronized
public boolean isSynchronized()
Returns true if object is synchronized.
Returns: boolean
iterator
public Iterator < XForm > iterator()
Returns collection enumerator.
Returns: Enumerator for collection
remove
Deletes specified item from collection.
size
public int size()
Gets count of XForms in collection.
Returns: int value
