Class FDFFieldIterator

FDFFieldIterator is an iterator type used to traverse interactive form fields in a FDF document. A FDFFieldIterator points to FDF.FDFField nodes or to the null FDFField node.

Inheritance

object

FDFFieldIterator

Implements

IDisposable

Inherited Members

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: pdftron.FDF

Assembly: PDFNet.dll

Syntax

public class FDFFieldIterator : IDisposable

Examples

A sample use case:

for(FDFFieldIterator itr = fdf_doc.getFieldIterator(); itr.hasNext(); itr.next()) {
Field name: itr.current().getName();
Field partial name: itr.current().getPartialName();
}

Fields

mp_imp

Declaration

public Wrap* mp_imp

Field Value

Type	Description
Wrap*

mp_keep_alive

A reference to managed document (FDFDoc) that is used to KeepAlive() this document until it is not needed

Declaration

public object mp_keep_alive

Field Value

Type	Description
object

Methods

Current()

get the current FDFFieldIterator

Declaration

public FDFField Current()

Returns

Type	Description
FDFField	current FDFField object

Dispose()

Releases all resources used by the FDFFieldIterator

Declaration

public override sealed void Dispose()

Dispose(bool)

Declaration

[HandleProcessCorruptedStateExceptions]
protected virtual void Dispose(bool A_0)

Parameters

Type	Name	Description
bool	A_0

Equals(object)

check if equals to another FDFFieldIterator

Declaration

public bool Equals(object o)

Parameters

Type	Name	Description
object	o	another FDFFieldIterator to compare to

Returns

Type	Description
bool	true if equals to another FDFFieldIterator. false, otherwise.

~FDFFieldIterator()

Allows an FDFFieldIterator to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Declaration

protected ~FDFFieldIterator()

HasNext()

check if there are more elements for the iterator

Declaration

public bool HasNext()

Returns

Type	Description
bool	true if there are more elements for the iterator. false, otherwise

Next()

advance FDFFieldIterator to the next FDFField

Declaration

public void Next()

Operators

operator ==(FDFFieldIterator, FDFFieldIterator)

check if two FDFFieldIterator are equal

Declaration

public static bool operator ==(FDFFieldIterator l, FDFFieldIterator r)

Parameters

Type	Name	Description
FDFFieldIterator	l	a FDFFieldIterator object
FDFFieldIterator	r	another FDFFieldIterator object

Returns

Type	Description
bool	true, if both are equal. false, otherwise.

operator !=(FDFFieldIterator, FDFFieldIterator)

check if two FDFFieldIterator are not equal

Declaration

public static bool operator !=(FDFFieldIterator l, FDFFieldIterator r)

Parameters

Type	Name	Description
FDFFieldIterator	l	a FDFFieldIterator object
FDFFieldIterator	r	another FDFFieldIterator object

Returns

Type	Description
bool	false, if both are equal. true, otherwise.

Implements

IDisposable