NumberTree Class Documentation

class NumberTree : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

The number tree is a common data structure in PDF files.

The number tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary.

A number tree uses keys that are integers to map to data objects, sorted in ascending numerical order.

Referenced by

Document

Constructor & Destructor Documentation

NumberTree

NumberTree(Document doc)

Parameters

doc: Document

The Document in which to create the NumberTree.

Creates a new, empty NumberTree in the specified Document.

Property Documentation

PDFDict

PDFDict PDFDict[get]

Gets the underlying PDFDict of this NumberTree.

Member Function Documentation

Dispose

void Dispose()

Returns:

void

Equals

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

Get

PDFObject Get(int key)

Parameters

key: int

The integer key of the PDFObject to get from the tree.

Returns:

PDFObject

The PDFObject value corresponding to the supplied key.

Retrieves an entry from this NumberTree.

Put

void Put(int key, PDFObject value)

Parameters

key: int

The integer of the PDFObject to put in the tree.

value: PDFObject

The PDFObject to be associated with key.

Returns:

void

Puts a new entry in this NumberTree. If an entry with this name is already in the tree, it is replaced.

Remove

void Remove(int key)

Parameters

key: int

The integer of the PDFObject to remove from the tree.

Returns:

void

Removes the specified PDFObject from this NumberTree. It does nothing if no PDFObject of that number exists in this NumberTree.