PdfDictionary.KeyCollection Class

Namespace:
GemBox.Pdf.Objects
Assembly:
GemBox.Pdf.dll

Represents the collection of keys in a PdfDictionary.

public sealed class KeyCollection : ICollection<PdfName>, ICollection, IReadOnlyCollection<PdfName>, IEnumerable<PdfName>, IEnumerable
Public NotInheritable Class KeyCollection
    Implements ICollection(Of PdfName), ICollection, IReadOnlyCollection(Of PdfName), IEnumerable(Of PdfName), IEnumerable
Inheritance:
System.Object
PdfDictionary.KeyCollection
Implements
System.Collections.Generic.ICollection<PdfName>
System.Collections.ICollection
System.Collections.Generic.IReadOnlyCollection<PdfName>
System.Collections.Generic.IEnumerable<PdfName>
System.Collections.IEnumerable

Properties

Count

Gets the number of PdfNames contained in the PdfDictionary.KeyCollection.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

The number of PdfNames contained in the PdfDictionary.KeyCollection

Methods

CopyTo(PdfName[], Int32)

Copies the PdfDictionary.KeyCollection elements to an existing one-dimensional System.Array, starting at the specified array index.

public void CopyTo(PdfName[] array, int arrayIndex)
Public Sub CopyTo(array As PdfName(), arrayIndex As Integer)
Parameters
array
PdfName[]

The one-dimensional System.Array that is the destination of the PdfNames copied from PdfDictionary.KeyCollection. The System.Array must have zero-based indexing.

arrayIndex
System.Int32

The zero-based index in array at which copying begins.

Exceptions
System.ArgumentNullException

array is null.

System.ArgumentOutOfRangeException

arrayIndex is less than zero.

System.ArgumentException

The number of elements in the source PdfDictionary.KeyCollection is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the PdfDictionary.KeyCollection.

public PdfDictionary.KeyCollection.Enumerator GetEnumerator()
Public Function GetEnumerator As PdfDictionary.KeyCollection.Enumerator
Returns
PdfDictionary.KeyCollection.Enumerator

Implements

System.Collections.Generic.ICollection<T>
System.Collections.ICollection
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable