PdfDictionary.DictionaryElements Class

PdfDictionaryDictionaryElements Class

Terminal Works - PDF Printing.Net Library

Represents the interface to the elements of a PDF dictionary.

Inheritance Hierarchy

SystemObject
PdfEdit.PdfPdfDictionaryDictionaryElements

Namespace: PdfEdit.Pdf
Assembly: PdfPrintingNet (in PdfPrintingNet.dll) Version: 5.1.1.0 (5.1.1.0)

Syntax

C++

Copy

public sealed class DictionaryElements : IDictionary<string, PdfItem>, 
	ICollection<KeyValuePair<string, PdfItem>>, IEnumerable<KeyValuePair<string, PdfItem>>, 
	IEnumerable, ICloneable

Public NotInheritable Class DictionaryElements
	Implements IDictionary(Of String, PdfItem), 
	ICollection(Of KeyValuePair(Of String, PdfItem)), IEnumerable(Of KeyValuePair(Of String, PdfItem)), 
	IEnumerable, ICloneable

public ref class DictionaryElements sealed : IDictionary<String^, PdfItem^>, 
	ICollection<KeyValuePair<String^, PdfItem^>>, IEnumerable<KeyValuePair<String^, PdfItem^>>, 
	IEnumerable, ICloneable

The PdfDictionaryDictionaryElements type exposes the following members.

Methods

	Name	Description
	Add(KeyValuePairString, PdfItem)	Adds an item to the dictionary.
	Add(String, PdfItem)	Adds the specified value to the dictionary.
	Clear	Removes all elements from the dictionary.
	Clone	Creates a shallow copy of this object. The clone is not owned by a dictionary anymore.
	Contains	Determines whether the dictionary contains a specific value.
	ContainsKey	Determines whether the dictionary contains the specified name.
	CopyTo	Copies the elements of the dictionary to an array, starting at a particular index.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetArray	Gets the PdfArray with the specified key, or null, if no such object exists. If the key refers to a reference, the referenced PdfArray is returned.
	GetBoolean(String)	Converts the specified value to boolean. If the value does not exist, the function returns false. If the value is not convertible, the function throws an InvalidCastException.
	GetBoolean(String, Boolean)	Converts the specified value to boolean. If the value does not exist, the function returns false. If the value is not convertible, the function throws an InvalidCastException.
	GetDateTime	Converts the specified value to DateTime. If the value does not exist, the function returns the specified default value. If the value is not convertible, the function throws an InvalidCastException.
	GetDictionary	Gets the PdfDictionary with the specified key, or null, if no such object exists. If the key refers to a reference, the referenced PdfDictionary is returned.
	GetEncryptedValue	Converts the specified value to String. If the value does not exist, the function returns the empty string.
	GetEnumerator	Returns an IDictionaryEnumerator object for the IDictionary object.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInteger(String)	Converts the specified value to integer. If the value does not exist, the function returns 0. If the value is not convertible, the function throws an InvalidCastException.
	GetInteger(String, Boolean)	Converts the specified value to integer. If the value does not exist, the function returns 0. If the value is not convertible, the function throws an InvalidCastException.
	GetMatrix(String)
	GetMatrix(String, Boolean)
	GetName	Converts the specified value to a name. If the value does not exist, the function returns the empty string.
	GetObject	Gets the PdfObject with the specified key, or null, if no such object exists. If the key refers to a reference, the referenced PdfObject is returned.
	GetReal(String)	Converts the specified value to double. If the value does not exist, the function returns 0. If the value is not convertible, the function throws an InvalidCastException.
	GetReal(String, Boolean)	Converts the specified value to double. If the value does not exist, the function returns 0. If the value is not convertible, the function throws an InvalidCastException.
	GetRectangle(String)	Converts the specified value to PdfRectangle. If the value does not exist, the function returns an empty rectangle. If the value is not convertible, the function throws an InvalidCastException.
	GetRectangle(String, Boolean)	Converts the specified value to PdfRectangle. If the value does not exist, the function returns an empty rectangle. If the value is not convertible, the function throws an InvalidCastException.
	GetReference	Gets the PdfReference with the specified key, or null, if no such object exists.
	GetString(String)	Converts the specified value to String. If the value does not exist, the function returns the empty string.
	GetString(String, Boolean)	Converts the specified value to String. If the value does not exist, the function returns the empty string.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(String)	Short cut for GetValue(key, VCF.None).
	GetValue(String, VCF)	Gets the value for the specified key. If the value does not exist, it is optionally created.
	Remove(KeyValuePairString, PdfItem)	Removes the value with the specified key.
	Remove(String)	Removes the value with the specified key.
	SetBoolean	Sets the entry to a direct boolean value.
	SetDateTime	Sets the entry to a direct datetime value.
	SetInteger	Sets the entry to a direct integer value.
	SetMatrix	Sets the entry to a direct matrix value, represented by an array with six values.
	SetName	Sets the specified name value. If the value doesn't start with a slash, it is added automatically.
	SetObject	Sets the entry to the specified object. The object must not be an indirect object, otherwise an exception is raised.
	SetReal	Sets the entry to a direct double value.
	SetRectangle	Sets the entry to a direct rectangle value, represented by an array with four values.
	SetReference(String, PdfReference)	Sets the entry as a reference to the specified iref.
	SetReference(String, PdfObject)	Sets the entry as a reference to the specified object. The object must be an indirect object, otherwise an exception is raised.
	SetString	Sets the entry to a direct string value.
	SetValue	Sets the entry with the specified value. DON'T USE THIS FUNCTION - IT MAY BE REMOVED.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	TryGetString	Tries to get the string. TODO: more TryGet...
	TryGetValue	Gets the value associated with the specified key.

Top

Properties

	Name	Description
	Count	Gets the number of elements contained in the dictionary.
	IsFixedSize	Return false.
	IsReadOnly	Gets a value indicating whether the IDictionary object is read-only.
	IsSynchronized	Return false.
	ItemString	Gets or sets an entry in the dictionary. The specified key must be a valid PDF name starting with a slash '/'. This property provides full access to the elements of the PDF dictionary. Wrong use can lead to errors or corrupt PDF files.
	ItemPdfName	Gets or sets an entry in the dictionary identified by a PdfName object.
	KeyNames	Gets all keys currently in use in this dictionary as an array of PdfName objects.
	Keys	Get all keys currently in use in this dictionary as an array of string objects.
	SyncRoot	The current implementation returns null.
	Values	Gets all values currently in use in this dictionary as an array of PdfItem objects.

Top

Reference

PdfEdit.Pdf Namespace