public class EmbeddedFileCollection extends Object implements Iterable<FileSpecification>
Class representing embedded files collection.
Modifier and Type | Method and Description |
---|---|
void |
add(FileSpecification file)
Adds embedded file specification into collection.
|
void |
add(String key,
FileSpecification file)
Adds file to embedded files with the specified key.
|
void |
clear()
Remove all embedded files from document.
|
boolean |
contains(FileSpecification item)
Determines if collection contains specified FileSpecification.
|
void |
copyTo(FileSpecification[] array,
int index)
Copies array of FileSpecification object into colleciton.
|
void |
delete()
Remove all embedded files from document.
|
void |
delete(String name)
Delete embedded file by name.
|
void |
deleteByKey(String key)
Deletes file from the collection by its key in the collection.
|
FileSpecification |
get_Item(int index)
Gets embedded file by its index.
|
FileSpecification |
get_Item(String name)
Gets embedded file by its name.
|
Object |
getSyncRoot()
Gets an object that can be used to synchronize access to this collection.
|
boolean |
isReadOnly()
Determines if collection is read only.
|
boolean |
isSynchronized()
Gets a value indicating whether access to this collection is synchronized (thread safe).
|
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<FileSpecification> |
iterator_Rename_Namesake()
Returns colleciton enumerator.
|
com.aspose.ms.System.Collections.IEnumerator<FileSpecification> |
iterator()
Returns colleciton enumerator.
|
boolean |
remove(FileSpecification item)
Removes specified FileSpecification from collection.
|
int |
size()
Gets number of embedded files in collection.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public boolean isSynchronized()
Gets a value indicating whether access to this collection is synchronized (thread safe).
public Object getSyncRoot()
Gets an object that can be used to synchronize access to this collection.
public int size()
Gets number of embedded files in collection.
public boolean isReadOnly()
Determines if collection is read only. Always returns false.
public void copyTo(FileSpecification[] array, int index)
Copies array of FileSpecification object into colleciton.
array
- Array of objects which will be copied.index
- Starting index from which copying will be started.public com.aspose.ms.System.Collections.IEnumerator<FileSpecification> iterator()
Returns colleciton enumerator.
iterator
in interface Iterable<FileSpecification>
public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<FileSpecification> iterator_Rename_Namesake()
Returns colleciton enumerator.
public void add(FileSpecification file)
Adds embedded file specification into collection.
file
- FileSpecification which should be added into colleciton.public void add(String key, FileSpecification file)
Adds file to embedded files with the specified key.
key
- Key in the embedded files.file
- File specification.public void deleteByKey(String key)
Deletes file from the collection by its key in the collection.
key
- String objectpublic void delete(String name)
Delete embedded file by name.
name
- Name of the embedded file which should be deleted.public void delete()
Remove all embedded files from document.
public boolean remove(FileSpecification item)
Removes specified FileSpecification from collection. Not supported.
item
- FileSpecification instancepublic boolean contains(FileSpecification item)
Determines if collection contains specified FileSpecification. Not supported.
item
- FileSpecification instancepublic void clear()
Remove all embedded files from document.
public FileSpecification get_Item(int index)
Gets embedded file by its index.
index
- Index of embedded file. Numbering is started from 1.public FileSpecification get_Item(String name)
Gets embedded file by its name.
name
- Embedded file name.