Click or drag to resize

PdfTreeTKey, TValue Class

Represents a base class for name trees and number trees.
Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.PdfPdfCollection
      SautinSoft.PdfPdfCollectionKeyValuePairTKey, TValue
        SautinSoft.PdfPdfTreeTKey, TValue
          SautinSoft.PdfPdfEmbeddedFileSpecificationTree

Namespace: SautinSoft.Pdf
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8
Syntax
Copy
public abstract class PdfTree<TKey, TValue> : PdfCollection<KeyValuePair<TKey, TValue>>, 
	IList, ICollection, IEnumerable, IList<KeyValuePair<TKey, TValue>>, 
	ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>

Type Parameters

TKey
The type of the keys in the tree. PdfString for name trees and PdfInteger for number trees.
TValue
The type of the values in the tree.

The PdfTreeTKey, TValue type exposes the following members.

Properties
 NameDescription
Public propertyCount Gets the number of elements contained in the PdfCollection.
(Inherited from PdfCollection)
Public propertyItemInt32 Gets or sets the element at the specified index.
(Inherited from PdfCollectionT)
Public propertyItemTKey Gets or sets the value associated with the specified key.
Public propertyMetadata(Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject)
Top
Methods
 NameDescription
Public methodAdd(T) Adds an element to the end of the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodAdd(TKey, TValue) Adds the specified key and value to the tree.
Public methodClear Removes all elements from the PdfCollection.
(Inherited from PdfCollection)
Public methodContains Determines whether an element is in the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodContainsKey Determines whether the tree contains the specified key.
Public methodCopyTo Copies the entire PdfCollectionT to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from PdfCollectionT)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetEnumerator Returns an enumerator that iterates through the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndexOf Searches for the specified element and returns the zero-based index of the first occurrence within the entire PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodInsert Inserts an element into the PdfCollectionT at the specified index.
(Inherited from PdfCollectionT)
Public methodRemove(T) Removes the first occurrence of a specific element from the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodRemove(TKey) Removes the value with the specified key from the tree.
Public methodRemoveAt Removes the element at the specified index of the PdfCollection.
(Inherited from PdfCollection)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryGetValue Gets the value associated with the specified key.
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfCollection.
(Defined by PdfObjectExtensions)
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddArray Gets the PdfArray that serves as a backing storage of the specified PdfCollection.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
Remarks

PdfString and PdfInteger are used as keys instead of String and Int32 to avoid, possibly costly, conversions.

SautinSoft.Pdf, currently, doesn't maintain the tree's structure when modifying the tree. Instead the entire tree structure is flattened into a single root node.

See Also