PdfFormActionSelectedFieldCollection Class

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

Represents a collection of PdfField names used in PdfSubmitFormAction and PdfResetFormAction.

public sealed class PdfFormActionSelectedFieldCollection : PdfCollection<String>, IList, ICollection, IList<String>, ICollection<String>, IReadOnlyList<String>, IReadOnlyCollection<String>, IEnumerable<String>, IEnumerable
Public NotInheritable Class PdfFormActionSelectedFieldCollection
    Inherits PdfCollection(Of String)
    Implements IList, ICollection, IList(Of String), ICollection(Of String), IReadOnlyList(Of String), IReadOnlyCollection(Of String), IEnumerable(Of String), IEnumerable
Inheritance:
System.Object
PdfCollection<System.String>
PdfFormActionSelectedFieldCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<System.String>
System.Collections.Generic.ICollection<System.String>
System.Collections.Generic.IReadOnlyList<System.String>
System.Collections.Generic.IReadOnlyCollection<System.String>
System.Collections.Generic.IEnumerable<System.String>
System.Collections.IEnumerable

Properties

All

Gets or sets a value indicating whether to submit / reset all form fields.

If false, then only fields with names specified in SelectedFields are submitted / reset (if Excluded is false) or excluded from the submission / resetting (if Excluded is true).

Default value: true.

public bool All { get; set; }
Public Property All As Boolean
Property Value
System.Boolean

true to submit / reset all form fields; otherwise, false to submit / reset (if Excluded is false) or exclude from the submission / resetting (if Excluded is true) only fields with names specified in SelectedFields.

Excluded

Gets or sets a value indicating whether fields with names specified in SelectedFields are excluded from the submission / resetting.

Default value: false.

public bool Excluded { get; set; }
Public Property Excluded As Boolean
Property Value
System.Boolean

true to exclude fields with names specified in SelectedFields from the submission / resetting; otherwise, false to submit / reset fields with names specified in SelectedFields.

Methods

Add(PdfField)

Adds a PdfField to the end of the PdfFormActionSelectedFieldCollection.

public void Add(PdfField field)
Public Sub Add(field As PdfField)
Parameters
field
PdfField

The PdfField to be added to the end of the PdfFormActionSelectedFieldCollection.

Exceptions
System.ArgumentNullException

field is null.

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

Examples

See Also