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

    Show / Hide Table of Contents

    PdfChoiceFieldItemCollection Class

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

    Represents a collection of PdfChoiceFieldItems.

    • C#
    • VB.NET
    public sealed class PdfChoiceFieldItemCollection : PdfOptionalCollection<PdfChoiceFieldItem>, IList, ICollection, IList<PdfChoiceFieldItem>, ICollection<PdfChoiceFieldItem>, IReadOnlyList<PdfChoiceFieldItem>, IReadOnlyCollection<PdfChoiceFieldItem>, IEnumerable<PdfChoiceFieldItem>, IEnumerable
    Public NotInheritable Class PdfChoiceFieldItemCollection
        Inherits PdfOptionalCollection(Of PdfChoiceFieldItem)
        Implements IList, ICollection, IList(Of PdfChoiceFieldItem), ICollection(Of PdfChoiceFieldItem), IReadOnlyList(Of PdfChoiceFieldItem), IReadOnlyCollection(Of PdfChoiceFieldItem), IEnumerable(Of PdfChoiceFieldItem), IEnumerable
    Inheritance:
    System.Object
    PdfObject
    PdfCollection
    PdfCollection<PdfChoiceFieldItem>
    PdfOptionalCollection<PdfChoiceFieldItem>
    PdfChoiceFieldItemCollection
    Implements
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.Generic.IList<PdfChoiceFieldItem>
    System.Collections.Generic.ICollection<PdfChoiceFieldItem>
    System.Collections.Generic.IReadOnlyList<PdfChoiceFieldItem>
    System.Collections.Generic.IReadOnlyCollection<PdfChoiceFieldItem>
    System.Collections.Generic.IEnumerable<PdfChoiceFieldItem>
    System.Collections.IEnumerable

    Methods

    Add(String)

    Adds a new PdfChoiceFieldItem with the specified value to the PdfChoiceFieldItemCollection.

    • C#
    • VB.NET
    public PdfChoiceFieldItem Add(string value)
    Public Function Add(value As String) As PdfChoiceFieldItem
    Parameters
    value
    System.String

    The item value.

    Returns
    PdfChoiceFieldItem

    A new PdfChoiceFieldItem with the specified value added to the PdfChoiceFieldItemCollection.

    Exceptions
    System.ArgumentException

    value is null or System.String.Empty.

    Add(String, String)

    Adds a new PdfChoiceFieldItem with the specified value and export value to the PdfChoiceFieldItemCollection.

    • C#
    • VB.NET
    public PdfChoiceFieldItem Add(string value, string exportValue)
    Public Function Add(value As String, exportValue As String) As PdfChoiceFieldItem
    Parameters
    value
    System.String

    The item value.

    exportValue
    System.String

    The item export value.

    Returns
    PdfChoiceFieldItem

    A new PdfChoiceFieldItem with the specified value and export value added to the PdfChoiceFieldItemCollection.

    Exceptions
    System.ArgumentException

    value or exportValue is null or System.String.Empty.

    Inherited Properties

    Count

    Gets the number of elements contained in the PdfCollection.

    (Inherited from PdfCollection)

    Metadata

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

    (Inherited from PdfObject)

    Inherited Methods

    Clear()

    Removes all elements from the PdfCollection.

    (Inherited from PdfCollection)

    RemoveAt(System.Int32)

    Removes the element at the specified index of the PdfCollection.

    (Inherited from PdfCollection)

    Implements

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

    Extension Methods

    PdfObjectExtensions.GetDictionary(PdfObject)
    PdfObjectExtensions.GetOrAddDictionary(PdfObject)
    PdfObjectExtensions.GetArray(PdfObject)
    PdfObjectExtensions.GetArray(PdfCollection)
    PdfObjectExtensions.GetOrAddArray(PdfCollection)

    See Also

    PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.