com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class EmbeddedFileCollection

    • Method Detail

      • isSynchronized

        public boolean isSynchronized()

        Gets a value indicating whether access to this collection is synchronized (thread safe).

        Returns:
        boolean value
      • getSyncRoot

        public Object getSyncRoot()

        Gets an object that can be used to synchronize access to this collection.

        Returns:
        Object for synchronization
      • size

        public int size()

        Gets number of embedded files in collection.

        Returns:
        int value
      • isReadOnly

        public boolean isReadOnly()

        Determines if collection is read only. Always returns false.

        Returns:
        boolean value
      • copyTo

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

        Copies array of FileSpecification object into colleciton.

        Parameters:
        array - Array of objects which will be copied.
        index - Starting index from which copying will be started.
      • iterator_Rename_Namesake

        public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<FileSpecification> iterator_Rename_Namesake()

        Returns colleciton enumerator.

        Returns:
        Enumerator of colleciton.
      • add

        public void add(FileSpecification file)

        Adds embedded file specification into collection.

        Parameters:
        file - FileSpecification which should be added into colleciton.
      • add

        public void add(String key,
                        FileSpecification file)

        Adds file to embedded files with the specified key.

        Parameters:
        key - Key in the embedded files.
        file - File specification.
      • deleteByKey

        public void deleteByKey(String key)

        Deletes file from the collection by its key in the collection.

        Parameters:
        key - String object
      • getKeys

        public final List<String> getKeys()

        Returns list of file attachment keys.

        Returns:
        List of String values
      • findByName

        public final FileSpecification findByName(String name)

        Returns embedded file by its name.

        Parameters:
        name - Name of the file.
        Returns:
        FileSpecification instance
      • delete

        public void delete(String name)

        Delete embedded file by name.

        Parameters:
        name - Name of the embedded file which should be deleted.
      • delete

        public void delete()

        Remove all embedded files from document.

      • remove

        public boolean remove(FileSpecification item)

        Removes specified FileSpecification from collection. Not supported.

        Parameters:
        item - FileSpecification instance
        Returns:
        boolean value
      • contains

        public boolean contains(FileSpecification item)

        Determines if collection contains specified FileSpecification. Not supported.

        Parameters:
        item - FileSpecification instance
        Returns:
        boolean value
      • clear

        public void clear()

        Remove all embedded files from document.

      • get_Item

        public FileSpecification get_Item(int index)

        Gets embedded file by its index.

        Parameters:
        index - Index of embedded file. Numbering is started from 1.
        Returns:
        Retreived embedded file specification
      • get_Item

        public FileSpecification get_Item(String name)

        Gets embedded file by its name.

        Parameters:
        name - Embedded file name.
        Returns:
        Retreived embedded file specification.