FormFieldDataCollection Class

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents a collection of FormFieldData instances associated with form fields from a particular part of document content.

public sealed class FormFieldDataCollection : IEnumerable<FormFieldData>, IEnumerable
Public NotInheritable Class FormFieldDataCollection
    Implements IEnumerable(Of FormFieldData), IEnumerable
Inheritance:
System.Object
FormFieldDataCollection
Implements
System.Collections.Generic.IEnumerable<FormFieldData>
System.Collections.IEnumerable

Properties

Item[String]

Gets the FormFieldData associated with the form field with the specified name or null if no form field with the specified name exists in the current range.

public FormFieldData this[string name] { get; }
Public ReadOnly Property Item(name As String) As FormFieldData
Parameters
name
System.String

The name of the form field.

Property Value
FormFieldData

The FormFieldData associated with the form field with the specified name or null if no form field with the specified name exists in the current range.

Shading

Gets or sets a value indicating whether a visual cue should be displayed around form fields contained in a document. Default value is true.

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

true if a visual cue should be displayed around form fields contained in a document; otherwise, false.

Methods

Get(String)

Gets all FormFieldData instances associated with form fields with the specified name.

public IEnumerable<FormFieldData> Get(string name)
Public Function Get(name As String) As IEnumerable(Of FormFieldData)
Parameters
name
System.String

The name of the form field.

Returns
System.Collections.Generic.IEnumerable<FormFieldData>

A sequence of all FormFieldData instances associated with form fields with the specified name.

GetEnumerator()

Returns an enumerator that iterates through the FormFieldDataCollection.

public IEnumerator<FormFieldData> GetEnumerator()
Public Function GetEnumerator As IEnumerator(Of FormFieldData)
Returns
System.Collections.Generic.IEnumerator<FormFieldData>

An enumerator for the FormFieldDataCollection.

Reset()

Resets all form fields contained in this collection.

public void Reset()
Public Sub Reset

Implements

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

Examples