Show / Hide Table of Contents

# Class NumberTreeIterator

NumberTreeIterator is used to traverse key/value pairs in a NumberTree.

##### Inheritance

object
NumberTreeIterator

##### Implements

IDisposable

##### Inherited Members

object.ToString()
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()

###### Namespace: pdftron.SDF

###### Assembly: PDFNet.dll

##### Syntax

    public class NumberTreeIterator : IDisposable

### Methods

#### Dispose()

Releases all resources used by the NumberTreeIterator

##### 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)

checks if equals to the specified `DictIterator` object

##### Declaration

    public bool Equals(object rhs)

##### Parameters

Type | Name | Description
--- | --- | ---
object | rhs | specified `NumberTreeIterator`

##### Returns

Type | Description
--- | ---
bool | true if both are equal

#### ~NumberTreeIterator()

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

##### Declaration

    protected ~NumberTreeIterator()

#### HasNext()

Checks for next.

##### Declaration

    public bool HasNext()

##### Returns

Type | Description
--- | ---
bool | 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

#### Set(NumberTreeIterator)

Sets value to the specified `NumberTreeIterator`

##### Declaration

    public void Set(NumberTreeIterator p)

##### Parameters

Type | Name | Description
--- | --- | ---
NumberTreeIterator | p | another `NumberTreeIterator` object

#### Value()

Value.

##### Declaration

    public Obj Value()

##### Returns

Type | Description
--- | ---
Obj | the value of the current dictionary entry.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### op_Assign(NumberTreeIterator)

Assignment operator

##### Declaration

    public NumberTreeIterator op_Assign(NumberTreeIterator rhs)

##### Parameters

Type | Name | Description
--- | --- | ---
NumberTreeIterator | rhs | `NumberTreeIterator` at the right side of the operator

##### Returns

Type | Description
--- | ---
NumberTreeIterator | `NumberTreeIterator` that equals to the object at the right side of the operator

### Operators

#### operator ==(NumberTreeIterator, NumberTreeIterator)

Equality operator checks whether two `NumberTreeIterator` objects are the same.

##### Declaration

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

##### Parameters

Type | Name | Description
--- | --- | ---
NumberTreeIterator | lhs | `NumberTreeIterator` at the left side of the operator
NumberTreeIterator | rhs | `NumberTreeIterator` at the right side of the operator

##### Returns

Type | Description
--- | ---
bool | true if both objects are equal, false otherwise

#### operator !=(NumberTreeIterator, NumberTreeIterator)

Inequality operator checks whether two `NumberTreeIterator` objects are different.

##### Declaration

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

##### Parameters

Type | Name | Description
--- | --- | ---
NumberTreeIterator | lhs | `NumberTreeIterator` at the left side of the operator
NumberTreeIterator | rhs | `NumberTreeIterator` at the right side of the operator

##### Returns

Type | Description
--- | ---
bool | true if both objects are not equal, false otherwise

### Implements

IDisposable