PdfPortfolioFileCollection Class

Represents a collection of a PdfFileSpecifications contained in the Portfolio (root files) or some Portfolio folder.

Inheritance Hierarchy

SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.PdfPdfCollection
      SautinSoft.PdfPdfCollectionPdfFileSpecification
        SautinSoft.Pdf.PortfoliosPdfPortfolioFileCollection

Namespace: SautinSoft.Pdf.Portfolios
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8

Syntax

Copy

public sealed class PdfPortfolioFileCollection : PdfCollection<PdfFileSpecification>, 
	IList, ICollection, IEnumerable, IList<PdfFileSpecification>, 
	ICollection<PdfFileSpecification>, IEnumerable<PdfFileSpecification>

Public NotInheritable Class PdfPortfolioFileCollection
	Inherits PdfCollection(Of PdfFileSpecification)
	Implements IList, ICollection, IEnumerable, IList(Of PdfFileSpecification), 
	ICollection(Of PdfFileSpecification), IEnumerable(Of PdfFileSpecification)

The PdfPortfolioFileCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of elements contained in the PdfCollection. (Inherited from PdfCollection)
	Item	Gets or sets the element at the specified index. (Inherited from PdfCollectionT)
	Metadata	(Optional; PDF 1.4) A metadata stream containing metadata for the component. (Inherited from PdfObject)

Top

Methods

	Name	Description
	Add(T)	Adds an element to the end of the PdfCollectionT. (Inherited from PdfCollectionT)
	Add(String)	Adds a new PdfFileSpecification with the EmbeddedFile copied from the resource specified by the filePath to EmbeddedFiles under the PdfPortfolio (root file) or parent PdfPortfolioFolder.
	AddEmpty	Add a new PdfFileSpecification with the specified name and an empty EmbeddedFile to EmbeddedFiles under the PdfPortfolio (root file) or parent PdfPortfolioFolder. Use the OpenWrite(Boolean) method of the EmbeddedFile of a returned PdfFileSpecification to fill the empty EmbeddedFile.
	Clear	Removes all elements from the PdfCollection. (Inherited from PdfCollection)
	Contains	Determines whether an element is in the PdfCollectionT. (Inherited from PdfCollectionT)
	CopyTo	Copies the entire PdfCollectionT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from PdfCollectionT)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetEnumerator	Returns an enumerator that iterates through the PdfCollectionT. (Inherited from PdfCollectionT)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IndexOf	Searches for the specified element and returns the zero-based index of the first occurrence within the entire PdfCollectionT. (Inherited from PdfCollectionT)
	Insert	Inserts an element into the PdfCollectionT at the specified index. (Inherited from PdfCollectionT)
	Remove	Removes the first occurrence of a specific element from the PdfCollectionT. (Inherited from PdfCollectionT)
	RemoveAt	Removes the element at the specified index of the PdfCollection. (Inherited from PdfCollection)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetArray	Gets the PdfArray that serves as a backing storage of the specified PdfCollection. (Defined by PdfObjectExtensions)
	GetArray	Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetOrAddArray	Gets the PdfArray that serves as a backing storage of the specified PdfCollection. (Defined by PdfObjectExtensions)
	GetOrAddDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)

Top

Remarks

This collection is a filtered view of the EmbeddedFiles that contains only PdfFileSpecifications located in the current PdfPortfolioFolder (the associated key of a PdfFileSpecification in the EmbeddedFiles has a prefix folder ID that is equal to the internal ID of the current PdfPortfolioFolder.

Reference

SautinSoft.Pdf.Portfolios Namespace

Other Resources

Portfolios example