PdfAnnotationCollection Class

Represents a collection of annotation.

Inheritance Hierarchy

SystemObject
Patagames.Pdf.Net.AnnotationsPdfAnnotationCollection

Namespace: Patagames.Pdf.Net.Annotations
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.111.2704

Syntax

C++

JavaScript

Copy

public class PdfAnnotationCollection : IList<PdfAnnotation>, 
	ICollection<PdfAnnotation>, IEnumerable<PdfAnnotation>, IEnumerable, 
	IDisposable

Public Class PdfAnnotationCollection
	Implements IList(Of PdfAnnotation), ICollection(Of PdfAnnotation), 
	IEnumerable(Of PdfAnnotation), IEnumerable, IDisposable

public ref class PdfAnnotationCollection : IList<PdfAnnotation^>, 
	ICollection<PdfAnnotation^>, IEnumerable<PdfAnnotation^>, IEnumerable, 
	IDisposable

type PdfAnnotationCollection = 
    class
        interface IList<PdfAnnotation>
        interface ICollection<PdfAnnotation>
        interface IEnumerable<PdfAnnotation>
        interface IEnumerable
        interface IDisposable
    end

public class PdfAnnotationCollection implements IList<PdfAnnotation>, 
	ICollection<PdfAnnotation>, IEnumerable<PdfAnnotation>, IEnumerable, 
	IDisposable

Patagames.Pdf.Net.Annotations.PdfAnnotationCollection = function();

Type.createClass(
	'Patagames.Pdf.Net.Annotations.PdfAnnotationCollection',
	null,
	IList`1,
	ICollection`1,
	IEnumerable`1,
	IEnumerable,
	IDisposable);

The PdfAnnotationCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of annotations contained in the collection.
	IsDisposed	Gets a value indicating whether the underlying array has been disposed of.
	IsReadOnly	Gets a value indicating whether the collection is read-only.
	Item	Gets or sets the annotation at the specified index
	Page	Gets page with which this collection is assosiated.Gets page with which this collection is associated. All annotations added to the collection should be associated with this page only.

Top

Methods

	Name	Description
	Add	Adds an annotation to the collection
	Clear	Removes all annotations from the collection
	Contains	Determines whether the collection contains a specific annotation.
	CopyTo	Copies the elements of the collections to an System.Array, starting at a particular System.Array index.
	Dispose	Releases all resources used by the PdfAnnotationCollection.
	Dispose(Boolean)	Releases all resources used by the PdfAnnotationCollection.
	GetByDictionary	Determines whether the collection contains a specific annotation.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	IndexOf	Determines the index of a specific annotation in the collection.
	Insert	Inserts an annotation to the collection at the specified index.
	Remove	Removes the first occurrence of a specific annotation from the collection.
	RemoveAt	Removes the annotation at the specified index.

Top

Remarks

Each annotation contained in the collection may be referenced from the collection associated with only one page. Attempting to share an annotation among multiple pages produces unpredictable behavior. This requirement applies only to the annotation itself, not to subsidiary objects, which can be shared among multiple annotations without causing any difficulty.

Reference

Patagames.Pdf.Net.Annotations Namespace