Class NameTreeIterator

NameTreeIterator is used to traverse key/value pairs in a NameTree.

Inheritance

System.Object

NameTreeIterator

Implements

System.IDisposable

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: pdftron.SDF

Assembly: PDFNet.dll

Syntax

public class NameTreeIterator : IDisposable

Methods

Dispose()

Releases all resources used by the NameTreeIterator

Declaration

public override sealed void Dispose()

Dispose(Boolean)

Declaration

[HandleProcessCorruptedStateExceptions]
protected virtual void Dispose(bool A_0)

Parameters

Type	Name	Description
System.Boolean	A_0

Equals(Object)

checks if equals to the specified NameTreeIterator object

Declaration

public bool Equals(object rhs)

Parameters

Type	Name	Description
System.Object	rhs	specified DictIterator

Returns

Type	Description
System.Boolean	true if both are equal

Finalize()

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

Declaration

protected void Finalize()

HasNext()

Checks for next.

Declaration

public bool HasNext()

Returns

Type	Description
System.Boolean	true if the iterator can be successfully advanced to the next element; false if the end collection is reached.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

Key()

Key

Declaration

public Obj Key()

Returns

Type	Description
Obj	the key of the current dictionary entry.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

Next()

Advances the iterator to the next element of the collection.

Declaration

public void Next()

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

op_Assign(NameTreeIterator)

Assignment operator

Declaration

public NameTreeIterator op_Assign(NameTreeIterator rhs)

Parameters

Type	Name	Description
NameTreeIterator	rhs	NameTreeIterator at the right side of the operator

Returns

Type	Description
NameTreeIterator	NameTreeIterator that equals to the object at the right side of the operator

Set(NameTreeIterator)

Sets value to the specified DictIterator

Declaration

public void Set(NameTreeIterator p)

Parameters

Type	Name	Description
NameTreeIterator	p	another NameTreeIterator object

Value()

Value

Declaration

public Obj Value()

Returns

Type	Description
Obj	value of the current dictionary entry.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

Operators

Equality(NameTreeIterator, NameTreeIterator)

Equality operator checks whether two NameTreeIterator objects are the same.

Declaration

public static bool operator ==(NameTreeIterator lhs, NameTreeIterator rhs)

Parameters

Type	Name	Description
NameTreeIterator	lhs	NameTreeIterator at the left side of the operator
NameTreeIterator	rhs	NameTreeIterator at the right side of the operator

Returns

Type	Description
System.Boolean	true if both objects are equal, false otherwise

Inequality(NameTreeIterator, NameTreeIterator)

Inequality operator checks whether two NameTreeIterator objects are different.

Declaration

public static bool operator !=(NameTreeIterator lhs, NameTreeIterator rhs)

Parameters

Type	Name	Description
NameTreeIterator	lhs	NameTreeIterator at the left side of the operator
NameTreeIterator	rhs	NameTreeIterator at the right side of the operator

Returns

Type	Description
System.Boolean	true if both objects are not equal, false otherwise

Implements

System.IDisposable