EmbeddedFileCollection
Inheritance: java.lang.Object, com.aspose.pdf.EmbeddedFileCollection
All Implemented Interfaces: Iterable < FileSpecification >
public class EmbeddedFileCollection extends Object implements Iterable < FileSpecification >
Class representing embedded files collection.
Methods
| Method | Description |
|---|---|
| add | Adds embedded file specification into collection. |
| add | Adds file to embedded files with the specified key. |
| clear | Remove all embedded files from document. |
| contains | Determines if collection contains specified FileSpecification. Not supported. |
| copyTo | Copies array of FileSpecification object into colleciton. |
| delete | Remove all embedded files from document. |
| delete | Remove all embedded files from document. |
| deleteByKey | Deletes file from the collection by its key in the collection. |
| findByName | Returns embedded file by its name. |
| get_Item | Gets embedded file by its index. |
| get_Item | Gets embedded file by its name. |
| getKeys | Returns list of file attachment keys. |
| getSyncRoot | Gets an object that can be used to synchronize access to this collection. |
| isEmbeddedFilesExist | Check is Embedded Files structure exists. Return TRUE if structure exists, and FALSE if not. If document have never contained embedded files - this structure was not created and absent. |
| isReadOnly | Determines if collection is read only. Always returns false. |
| isSynchronized | Gets a value indicating whether access to this collection is synchronized (thread safe). |
| iterator_Rename_Namesake | Returns colleciton enumerator. |
| iterator | Returns colleciton enumerator. |
| remove | Removes specified FileSpecification from collection. Not supported. |
| size | Gets number of embedded files in collection. |
add
Adds embedded file specification into collection.
add
Adds file to embedded files with the specified key.
clear
public void clear()
Remove all embedded files from document.
contains
Determines if collection contains specified FileSpecification. Not supported.
copyTo
Copies array of FileSpecification object into colleciton.
delete
public void delete()
Remove all embedded files from document.
delete
Remove all embedded files from document.
deleteByKey
Deletes file from the collection by its key in the collection.
findByName
Returns embedded file by its name.
get_Item
public FileSpecification get_Item(int index)
Gets embedded file by its index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | Index of embedded file. Numbering is started from 1. |
Returns: Retreived embedded file specification
get_Item
Gets embedded file by its name.
getKeys
public final List < String > getKeys()
Returns list of file attachment keys.
Returns: List of String values
getSyncRoot
public Object getSyncRoot()
Gets an object that can be used to synchronize access to this collection.
Returns: Object for synchronization
isEmbeddedFilesExist
public boolean isEmbeddedFilesExist()
Check is Embedded Files structure exists. Return TRUE if structure exists, and FALSE if not. If document have never contained embedded files - this structure was not created and absent.
Returns: boolean value
isReadOnly
public boolean isReadOnly()
Determines if collection is read only. Always returns false.
Returns: boolean value
isSynchronized
public boolean isSynchronized()
Gets a value indicating whether access to this collection is synchronized (thread safe).
Returns: boolean value
iterator_Rename_Namesake
public com.aspose.ms.System.Collections.Generic.IGenericEnumerator< FileSpecification > iterator_Rename_Namesake()
Returns colleciton enumerator.
Returns: Enumerator of colleciton.
iterator
public com.aspose.ms.System.Collections.IEnumerator< FileSpecification > iterator()
Returns colleciton enumerator.
Returns: Enumerator of colleciton.
remove
Removes specified FileSpecification from collection. Not supported.
size
public int size()
Gets number of embedded files in collection.
Returns: int value
