GemBox.Pdf
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    PdfCollection Class

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

    Represents a base non-generic class for all collection types that implement various PDF components in the GemBox.Pdf assembly.

    • C#
    • VB.NET
    public abstract class PdfCollection : PdfObject, IList, ICollection, IEnumerable
    Public MustInherit Class PdfCollection
        Inherits PdfObject
        Implements IList, ICollection, IEnumerable
    Inheritance:
    System.Object
    PdfObject
    PdfCollection
    Derived
    PdfCollection<T>
    Implements
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable

    Properties

    Count

    Gets the number of elements contained in the PdfCollection.

    • C#
    • VB.NET
    public int Count { get; }
    Public ReadOnly Property Count As Integer
    Property Value
    System.Int32

    The number of elements contained in the PdfCollection.

    Methods

    Clear()

    Removes all elements from the PdfCollection.

    • C#
    • VB.NET
    public void Clear()
    Public Sub Clear
    Exceptions
    System.InvalidOperationException

    The underlying PdfArray is read-only (IsReadOnly returns true).

    RemoveAt(Int32)

    Removes the element at the specified index of the PdfCollection.

    • C#
    • VB.NET
    public void RemoveAt(int index)
    Public Sub RemoveAt(index As Integer)
    Parameters
    index
    System.Int32

    The zero-based index of the element to remove.

    Exceptions
    System.InvalidOperationException

    The underlying PdfArray is read-only (IsReadOnly returns true).

    System.ArgumentOutOfRangeException

    index is less than 0 or index is equal to or greater than Count.

    Inherited Properties

    Metadata

    (Optional; PDF 1.4) A metadata stream containing metadata for the component.

    (Inherited from PdfObject)

    Implements

    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable

    Extension Methods

    PdfObjectExtensions.GetDictionary(PdfObject)
    PdfObjectExtensions.GetOrAddDictionary(PdfObject)
    PdfObjectExtensions.GetArray(PdfObject)
    PdfObjectExtensions.GetArray(PdfCollection)
    PdfObjectExtensions.GetOrAddArray(PdfCollection)
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.