DictAtom Item Property. Get or set the entry with the specified name. ABCpdf .NET PDF Library.

ABCpdf .net

previous page next page
 
Item Property    

 

Type Default Read Only Description
[C#] Atom this[string name]
int this[string name, int def]
double this[string name, double def]
string this[string name, string def]

[Visual Basic]
Default Property Item(name As String) As Atom
Default Property Item(name As String, def As Integer) As Integer
Default Property Item(name As String, def As Double) As Double
Default Property Item(name As String, def As String) As String		  n/a  Yes Get or set the entry with the specified name.

Throws Exceptions may throw ArgumentNullException()

 

    

Notes		  

Get or set the Atom with the specified name. In C# this property is the indexer for the class.

You can access an Atom directly or you can use one of the overloaded operators to specify numbers or strings. Using the overloads to access numbers or strings is more efficient than accessing an Atom and extracting the value from it.

You specify one of the overloads using the def parameter. If you are setting a value then this parameter is ignored. If you are getting a value then this parameter becomes the default value to be used if the underlying Atom was not the correct type. For example the default would be returned if you attempted to get an integer but the underlying Atom was actually a StringAtom.

Atoms can exist in only one place at a time. If the Atom supplied is already contained by another object then a Clone of the Atom is added.

Adding a null value will result in a NullAtom being added to the array.

If the name is null this property throws an ArgumentNullException.

 

    

Example		  

None.

 

    

 

previous page start next page