A collection specifies the viewing and organizational characteristics
of portable collections.The intent of portable collections is to present,
sort, and search collections of related document,such as email archives,
photo collections, and engineering bidsets.
Namespace: Spire.Pdf.CollectionsAssembly: Spire.Pdf (in Spire.Pdf.dll) Version: 7.9.2.0 (7.9.2.1020)
Syntax
| C# | Visual Basic | Visual C++ | F# |
public class PdfCollection : [T:sprᝰ]
Public Class PdfCollection Implements [T:sprᝰ]
public ref class PdfCollection : [T:sprᝰ]
type PdfCollection = class interface [T:sprᝰ] end
Members
| All Members | Properties | Methods |
| Member | Description | |
|---|---|---|
| AddAttachment(PdfAttachment) |
Add an attachment.
| |
| AddCustomField(String, String, CustomFieldType) |
Add a custom field.
| |
| AddFile(String) |
Add a local file.
| |
| AddFile(String, Stream) |
Add a stream.
| |
| AddFileRelatedField(String, String, FileRelatedFieldType) |
Add a file related field.
| |
| AssociatedFiles |
Get the document collection associated files
| |
| Clear()()()() |
Clear all files and folders.
| |
| Equals(Object) |
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.) | |
| FieldNames |
Get the document collection associated field names
| |
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| Folders |
(Required if the collection has folders; ExtensionLevel3)
An indirect reference to the folder dictionary that is the
single common ancestor of all other folders in a portable
collection.
| |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Sort(array<String>[]()[][], array<Boolean>[]()[][]) |
Sort embedded files with field names.
| |
| SynchronizeFromPdfPrimitive()()()() |
Synchronize the instance from the pdf primitive.
| |
| SynchronizeToPdfPrimitive()()()() |
Synchronize the instance to the pdf primitive.
| |
| ToString()()()() |
Returns a String that represents the current Object.
(Inherited from Object.) |
Inheritance Hierarchy
System..::..Object
Spire.Pdf.Collections..::..PdfCollection
Spire.Pdf.Collections..::..PdfCollection