com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Skip navigation links
com.aspose.pdf

Class XFormCollection

  • All Implemented Interfaces:
    Iterable<XForm>

    public final class XFormCollection
extends Object
implements Iterable<XForm>

    Class represents collection of XFormCollection.

    • Method Detail

      • size

        public int size()

        Gets count of XForms in collection.

        Returns:
        int value

      • isSynchronized

        public boolean isSynchronized()

        Returns true if object is synchronized.

        Returns:
        boolean

      • getSyncRoot

        public Object getSyncRoot()

        Synchronization object.

        Returns:
        Object

      • isReadOnly

        public boolean isReadOnly()

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

        Returns:
        boolean value

      • add

        public void add(XForm xform)

        Adds new XForm into collection.

        Parameters:
        xform - XForm to add into collection

      • delete

        public void delete(int index)

        Delete XForm from collectin

        Parameters:
        index - Index of XForm which must be deleted

      • delete

        public void delete()

        Deletes all XForms from collection.

      • copyTo

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

        Copies XFormCollection into collection.

        Parameters:
        array - Array of XForm to be copied
        index - Index where XFormCollection will be copied

      • delete

        public void delete(String name)

        Deletes XForm from collection by form name.

        Parameters:
        name - Name of XForm to be deleted.

      • get_Item

        public XForm get_Item(int index)

        Returns XForm by index.

        Parameters:
        index - Index of XFormCollection. XForms numbering is started from 1
        Returns:
        Retreived XForm

      • get_Item

        public XForm get_Item(String name)

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

        Parameters:
        name - Name of XForm
        Returns:
        XForm object

      • getFormName

        public String getFormName(XForm form)

        Returns name of the form in this form collection

        Parameters:
        form - Form which name is searhced
        Returns:
        Form name in the collection; Null if form is not contained in the colleciton

      • hasForm

        public boolean hasForm(String formName)

      • clear

        public void clear()

        Clears all items from the collection.

      • contains

        public boolean contains(XForm item)

        Determines whether the collection contains a specific value.

        Parameters:
        item - The object to locate in the collection
        Returns:
        true if item is found in the collection; otherwise, false.

      • remove

        public boolean remove(XForm item)

        Deletes specified item from collection.

        Parameters:
        item - The object to delete
        Returns:
        true if item was deleted from collection; otherwise, false.