| PdfTypeDictionary Class |
Represents the Dictionary type of objects
Inheritance Hierarchy Namespace: Patagames.Pdf.Net.BasicTypesAssembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.94.2704
Syntax public class PdfTypeDictionary : PdfTypeBase,
IDictionary<string, PdfTypeBase>, ICollection<KeyValuePair<string, PdfTypeBase>>,
IEnumerable<KeyValuePair<string, PdfTypeBase>>, IEnumerable
Public Class PdfTypeDictionary
Inherits PdfTypeBase
Implements IDictionary(Of String, PdfTypeBase),
ICollection(Of KeyValuePair(Of String, PdfTypeBase)), IEnumerable(Of KeyValuePair(Of String, PdfTypeBase)),
IEnumerable
public ref class PdfTypeDictionary : public PdfTypeBase,
IDictionary<String^, PdfTypeBase^>, ICollection<KeyValuePair<String^, PdfTypeBase^>>,
IEnumerable<KeyValuePair<String^, PdfTypeBase^>>, IEnumerable
type PdfTypeDictionary =
class
inherit PdfTypeBase
interface IDictionary<string, PdfTypeBase>
interface ICollection<KeyValuePair<string, PdfTypeBase>>
interface IEnumerable<KeyValuePair<string, PdfTypeBase>>
interface IEnumerable
end
public class PdfTypeDictionary extends PdfTypeBase implements IDictionary<String, PdfTypeBase>,
ICollection<KeyValuePair<String, PdfTypeBase>>, IEnumerable<KeyValuePair<String, PdfTypeBase>>,
IEnumerable
Patagames.Pdf.Net.BasicTypes.PdfTypeDictionary = function();
Type.createClass(
'Patagames.Pdf.Net.BasicTypes.PdfTypeDictionary',
Patagames.Pdf.Net.BasicTypes.PdfTypeBase,
IDictionary`2,
ICollection`1,
IEnumerable`1,
IEnumerable);
The PdfTypeDictionary type exposes the following members.
Constructors | Name | Description |
---|
| PdfTypeDictionary |
Construct new instance of PdfTypeDictionary class from given Handle
|
TopProperties | Name | Description |
---|
| Count |
Gets the number of keys contained in the Dictionary.
|
| IsReadOnly |
Gets a value indicating whether the Dictionary object is read-only.
|
| IsSignature |
Determines whether the Dictionary is a signature field.
|
| Item |
Gets or sets the element with the specified key
|
| Keys |
Gets an ICollection object containing the keys of the IDictionary object.
|
| Values |
Gets an ICollection object containing the values in the IDictionary object.
|
TopMethods | Name | Description |
---|
| Add(KeyValuePairString, PdfTypeBase) |
Adds an element with the provided key and value to the IDictionary object.
|
| Add(String, PdfTypeBase) |
Adds an element with the provided key and value to the IDictionary object.
|
| Clear |
Removes all elements from the IDictionary object.
|
| Contains |
Determines whether the Dictionary contains an item with the specified key.
|
| ContainsKey |
Determines whether the Dictionary contains an element with the specified key.
|
| CopyTo |
Copies the elements of the Dictionary to an Array, starting at a particular Array index
|
| Create |
Creates new Dictionary object
|
| Create(IntPtr) |
Creates new instance of PdfTypeDictionary class
|
| GetBooleanBy |
Gets the element with the specified key and returns it as a boolean value.
|
| GetBy |
Gets the element with the specified key.
|
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| GetIntegerBy |
Gets the element with the specified key and returns it as an integer value.
|
| GetMatrixBy |
Gets the element with the specified key and returns it as a matrix.
|
| GetRealBy |
Gets the element with the specified key and returns it as a Real number.
|
| GetRectBy |
Gets the element with the specified key and returns it as a rectangle.
|
| GetStringBy |
Gets the element with the specified key and returns it as an ANSI string.
|
| GetUnicodeBy |
Gets the element with the specified key and returns it as an unicode string.
|
| Remove(KeyValuePairString, PdfTypeBase) |
Removes the element with the specified key from the Dictionary.
|
| Remove(String) |
Removes the element with the specified key from the Dictionary.
|
| SetAt |
Sets the element at the specified key.
|
| SetBooleanAt |
Sets the boolean value at the specified key.
|
| SetIndirectAt(String, PdfIndirectList, PdfTypeBase) |
Creates an Indirect object and sets it at the specified key of dictionary.
|
| SetIndirectAt(String, PdfIndirectList, Int32) |
Creates an Indirect object and sets it at the specified key of dictionary.
|
| SetIntegerAt |
Sets the integer value at the specified key.
|
| SetMatrixAt |
Sets the matrix at the specified key.
|
| SetNameAt |
Creates a Name object and sets it at the specified key.
|
| SetRealAt |
Sets the Real number at the specified key.
|
| SetRectAt |
Sets the rectangle at the specified key.
|
| SetStringAt |
Sets the ANSI string at the specified key.
|
| TryGetValue |
Gets the value associated with the specified key.
|
TopRemarks
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 |
---|
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