CosPdfDictionary

CosPdfDictionary

Overview

CosPdfDictionary is a class in Aspose.PDF FOSS for .NET. Inherits from: CosPdfPrimitive, IDictionary<string, ICosPdfPrimitive>.

A dictionary value, editable in place: reads resolve references through the owning document, writes go straight into the dictionary.

This class declares 19 methods for CosPdfDictionary objects in .NET programs. Available methods include: Add, Clear, Contains, ContainsKey, CopyTo, CosPdfDictionary, CreateEmptyDictionary, GetEnumerator, Remove, ToCosPdfBoolean, ToCosPdfDictionary, ToCosPdfName, and 4 additional methods. Public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package. Properties: AllKeys, Count, IsReadOnly, Keys, Values.

Properties

NameTypeAccessDescription
AllKeysICollection<string>ReadEvery key, including those whose value the editor cannot show.
KeysICollection<string>ReadThe keys whose value the editor shows.
ValuesICollection<ICosPdfPrimitive>ReadThe values the editor shows, with references resolved; entries it cannot show are left out.
CountintReadThe number of entries the editor shows (the size of Keys).
IsReadOnlyboolReadGets the is read only.

Methods

SignatureDescription
CreateEmptyDictionary(page: Page)A new, empty dictionary that can be written into the page’s dictionary.
CreateEmptyDictionary(document: Document)A new, empty dictionary that can be written into the document’s catalog.
CosPdfDictionary(resources: Resources)The resources dictionary of resources.
ToCosPdfDictionary()Calls ToCosPdfDictionary on this CosPdfDictionary instance.
ToString()Calls ToString on this CosPdfDictionary instance.
ContainsKey(key: string)Returns true when the key holds a value the editor can show.
Remove(key: string)Removes the entry with the given key; returns true when it was present.
TryGetValue(key: string, value: ICosPdfPrimitive)Calls TryGetValue(key, value) on this CosPdfDictionary instance.
Add(key: string, value: ICosPdfPrimitive)Writes a value under a key, replacing any existing entry.
Add(item: KeyValuePair<string, ICosPdfPrimitive>)Calls Add(item) on this CosPdfDictionary instance.
Clear()Removes every entry, including those the editor cannot show.
Contains(item: KeyValuePair<string, ICosPdfPrimitive>)Calls Contains(item) on this CosPdfDictionary instance.
CopyTo(array: KeyValuePair<string, ICosPdfPrimitive>[], arrayIndex: int)Calls CopyTo(array, arrayIndex) on this CosPdfDictionary instance.
Remove(item: KeyValuePair<string, ICosPdfPrimitive>)Calls Remove(item) on this CosPdfDictionary instance.
GetEnumerator()Calls GetEnumerator on this CosPdfDictionary instance.
ToCosPdfNumber()Calls ToCosPdfNumber on this CosPdfDictionary instance.
ToCosPdfName()Calls ToCosPdfName on this CosPdfDictionary instance.
ToCosPdfString()Calls ToCosPdfString on this CosPdfDictionary instance.
ToCosPdfBoolean()Calls ToCosPdfBoolean on this CosPdfDictionary instance.

See Also