XFormCollection

XFormCollection

Overview

XFormCollection is a class in Aspose.PDF FOSS for .NET. Inherits from: IEnumerable<XForm>.

Collection of XForm (Form XObject) resources on a page.

This class declares 11 methods for XFormCollection objects in .NET programs. Available methods include: Add, Clear, Contains, CopyTo, Delete, FreeMemory, GetEnumerator, GetFormName, Remove. Public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package. Properties: Count, IsReadOnly, IsSynchronized, SyncRoot.

Properties

NameTypeAccessDescription
CountintReadNumber of Form XObjects.
IsReadOnlyboolReadGets the is read only.
IsSynchronizedboolReadGets the is synchronized.
SyncRootobjectReadGets the sync root.

Methods

SignatureDescription
Delete(name: string)Remove an XForm by name from the collection and underlying XObject dict.
Delete(index: int)Remove an XForm by 1-based index.
GetEnumerator()Calls GetEnumerator on this XFormCollection instance.
Add(item: XForm)Adds a form XObject to the collection and to the owner’s /XObject resources.
Clear()Removes every form XObject from the collection and from the underlying /XObject resource dictionary.
Contains(item: XForm)Returns true when the given form XObject is in the collection.
CopyTo(array: XForm[], index: int)Copies the form XObjects into an array, starting at the given array index.
Remove(item: XForm)Removes a form XObject from the collection and its entry from the /XObject resource dictionary.
Delete()Drop all entries (equivalent to Clear).
FreeMemory()Discard cached form list so the next access re-reads from the XObject dict.
GetFormName(form: XForm)Return the PDF resource name (e.g.

See Also

 English