Click or drag to resize

PdfTypeDictionary Class

Represents the Dictionary type of objects
Inheritance Hierarchy

Namespace:  Patagames.Pdf.Net.BasicTypes
Assemblies:   Patagames.Pdf.Xamarin.iOS (in Patagames.Pdf.Xamarin.iOS.dll) Version: 4.35.2704
  Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.35.2704
Syntax
public class PdfTypeDictionary : PdfTypeBase, 
	IDictionary<string, PdfTypeBase>, ICollection<KeyValuePair<string, PdfTypeBase>>, 
	IEnumerable<KeyValuePair<string, PdfTypeBase>>, IEnumerable

The PdfTypeDictionary type exposes the following members.

Constructors
  NameDescription
Public methodPdfTypeDictionary
Construct new instance of PdfTypeDictionary class from given Handle
Top
Properties
  NameDescription
Public propertyCount
Gets the number of keys contained in the Dictionary.
Public propertyIsReadOnly
Gets a value indicating whether the Dictionary object is read-only.
Public propertyIsSignature
Determines whether the Dictionary is a signature field.
Public propertyItem
Gets or sets the element with the specified key
Public propertyKeys
Gets an ICollection object containing the keys of the IDictionary object.
Public propertyValues
Gets an ICollection object containing the values in the IDictionary object.
Top
Methods
  NameDescription
Public methodAdd(KeyValuePairString, PdfTypeBase)
Adds an element with the provided key and value to the IDictionary object.
Public methodAdd(String, PdfTypeBase)
Adds an element with the provided key and value to the IDictionary object.
Public methodClear
Removes all elements from the IDictionary object.
Public methodContains
Determines whether the Dictionary contains an item with the specified key.
Public methodContainsKey
Determines whether the Dictionary contains an element with the specified key.
Public methodCopyTo
Copies the elements of the Dictionary to an Array, starting at a particular Array index
Public methodStatic memberCreate
Creates new Dictionary object
Public methodStatic memberCreate(IntPtr)
Creates new instance of PdfTypeDictionary class
Public methodGetBooleanBy
Gets the element with the specified key and returns it as a boolean value.
Public methodGetBy
Gets the element with the specified key.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Public methodGetIntegerBy
Gets the element with the specified key and returns it as an integer value.
Public methodGetMatrixBy
Gets the element with the specified key and returns it as a matrix.
Public methodGetRealBy
Gets the element with the specified key and returns it as a Real number.
Public methodGetRectBy
Gets the element with the specified key and returns it as a rectangle.
Public methodGetStringBy
Gets the element with the specified key and returns it as a ansi string.
Public methodGetUnicodeBy
Gets the element with the specified key and returns it as an unicode string.
Public methodRemove(KeyValuePairString, PdfTypeBase)
Removes the element with the specified key from the Dictionary.
Public methodRemove(String)
Removes the element with the specified key from the Dictionary.
Public methodSetAt
Sets the element at the specified key.
Public methodSetBooleanAt
Sets the boolean value at the specified key.
Public methodSetIndirectAt(String, PdfIndirectList, PdfTypeBase)
Creates an Indirect object and sets it at the specified key of dictionary.
Public methodSetIndirectAt(String, PdfIndirectList, Int32)
Creates an Indirect object and sets it at the specified key of dictionary.
Public methodSetIntegerAt
Sets the integer value at the specified key.
Public methodSetMatrixAt
Sets the matrix at the specified key.
Public methodSetNameAt
Creates a Name object and sets it at the specified key.
Public methodSetRealAt
Sets the Real number at the specified key.
Public methodSetRectAt
Sets the rectangle at the specified key.
Public methodSetStringAt
Sets the ansi string at the specified key.
Public methodTryGetValue
Gets the value associated with the specified key.
Top
Remarks
A dictionary object is an associative table containing pairs of objects, known as the dictionary’s entries. The first element of each entry is the key and the second element is the value. The key must be a name. The value can be any kind of object, including another dictionary. A dictionary entry whose value is null is equivalent to an absent entry. (This differs from PostScript, where null behaves like any other object as the value of a dictionary entry.) The number of entries in a dictionary is subject to an implementation limit;
Note Note
No two entries in the same dictionary should have the same key. If a key does appear more than once, its value is undefined.
Dictionary objects are the main building blocks of a PDF document. They are commonly used to collect and tie together the attributes of a complex object, such as a font or a page of the document, with each entry in the dictionary specifying the name and value of an attribute. By convention, the Type entry of such a dictionary identifies the type of object the dictionary describes. In some cases, a Subtype entry (sometimes abbreviated S) is used to further identify a specialized subcategory of the general type. The value of the Type or Subtype entry is always a name. For example, in a font dictionary, the value of the Type entry is always Font, whereas that of the Subtype entry may be Type1, TrueType, or one of several other values.

The value of the Type entry can almost always be inferred from context. The operand of the Tf operator, for example, must be a font object; therefore, the Typeentry in a font dictionary serves primarily as documentation and as information for error checking. The Type entry is not required unless so stated in its description; however, if the entry is present, it must have the correct value. In addition, the value of the Type entry in any dictionary, even in private data, must be either a name defined in this book or a registered name.

See Also