PdfPortfolioFieldValueDictionary Class

Namespace:
GemBox.Pdf.Portfolios
Assembly:
GemBox.Pdf.dll

Contains the data described by the Fields for a particular PortfolioFieldValues or a PortfolioFieldValues in a PdfPortfolio.

public sealed class PdfPortfolioFieldValueDictionary : PdfCollection<KeyValuePair<PdfName, PdfPortfolioFieldValue>>, IList, ICollection, IList<KeyValuePair<PdfName, PdfPortfolioFieldValue>>, ICollection<KeyValuePair<PdfName, PdfPortfolioFieldValue>>, IReadOnlyList<KeyValuePair<PdfName, PdfPortfolioFieldValue>>, IReadOnlyCollection<KeyValuePair<PdfName, PdfPortfolioFieldValue>>, IEnumerable<KeyValuePair<PdfName, PdfPortfolioFieldValue>>, IEnumerable
Public NotInheritable Class PdfPortfolioFieldValueDictionary
    Inherits PdfCollection(Of KeyValuePair(Of PdfName, PdfPortfolioFieldValue))
    Implements IList, ICollection, IList(Of KeyValuePair(Of PdfName, PdfPortfolioFieldValue)), ICollection(Of KeyValuePair(Of PdfName, PdfPortfolioFieldValue)), IReadOnlyList(Of KeyValuePair(Of PdfName, PdfPortfolioFieldValue)), IReadOnlyCollection(Of KeyValuePair(Of PdfName, PdfPortfolioFieldValue)), IEnumerable(Of KeyValuePair(Of PdfName, PdfPortfolioFieldValue)), IEnumerable
Inheritance:
System.Object
PdfCollection<System.Collections.Generic.KeyValuePair<PdfName, PdfPortfolioFieldValue>>
PdfPortfolioFieldValueDictionary
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<System.Collections.Generic.KeyValuePair<PdfName, PdfPortfolioFieldValue>>
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<PdfName, PdfPortfolioFieldValue>>
System.Collections.Generic.IReadOnlyList<System.Collections.Generic.KeyValuePair<PdfName, PdfPortfolioFieldValue>>
System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<PdfName, PdfPortfolioFieldValue>>
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<PdfName, PdfPortfolioFieldValue>>
System.Collections.IEnumerable

Properties

Item[PdfName]

Gets or sets the PdfPortfolioFieldValue associated with the specified PdfName key.

public PdfPortfolioFieldValue this[PdfName key] { get; set; }
Public Property Item(key As PdfName) As PdfPortfolioFieldValue
Parameters
key
PdfName

The PdfName key of the PdfPortfolioFieldValue to get or set.

Property Value
PdfPortfolioFieldValue

The PdfPortfolioFieldValue associated with the specified PdfName key. If the specified key is not found, a get operation returns the default PdfPortfolioFieldValue. A set operation overrides existing or adds a new entry with the specified PdfName key and PdfPortfolioFieldValue.

Exceptions
System.ArgumentNullException

key is null.

System.ArgumentException

key name is 'Type' which is reserved.

Methods

Add(PdfName, PdfPortfolioFieldValue)

Adds the specified PdfPortfolioFieldValue to the PdfPortfolioFieldValueDictionary under the specified PdfName key.

public void Add(PdfName key, PdfPortfolioFieldValue value)
Public Sub Add(key As PdfName, value As PdfPortfolioFieldValue)
Parameters
key
PdfName

The key under which to add the specified PdfPortfolioFieldValue.

value
PdfPortfolioFieldValue

The PdfPortfolioFieldValue to add under the specified PdfName key.

Exceptions
System.ArgumentException

A PdfPortfolioFieldValue with the same key already exists in the PdfPortfolioFieldValueDictionary or a key name is 'Type' which is reserved.

Contains(PdfName)

Determines whether the PdfPortfolioFieldValueDictionary contains the PdfPortfolioFieldValue with the specified PdfName key.

public bool Contains(PdfName key)
Public Function Contains(key As PdfName) As Boolean
Parameters
key
PdfName

The PdfName key to locate in the PdfPortfolioFieldValueDictionary.

Returns
System.Boolean

true if the PdfPortfolioFieldValueDictionary contains the PdfPortfolioFieldValue with the specified PdfName key; otherwise, false.

Exceptions
System.ArgumentNullException

key is null.

GetEnumerator()

Returns an enumerator that iterates through the PdfPortfolioFieldValueDictionary.

public PdfPortfolioFieldValueDictionary.Enumerator GetEnumerator()
Public Function GetEnumerator As PdfPortfolioFieldValueDictionary.Enumerator
Returns
PdfPortfolioFieldValueDictionary.Enumerator

Remove(PdfName)

Removes the PdfPortfolioFieldValue with the specified key from the PdfPortfolioFieldValueDictionary.

public bool Remove(PdfName key)
Public Function Remove(key As PdfName) As Boolean
Parameters
key
PdfName

The key of the PdfPortfolioFieldValue to remove.

Returns
System.Boolean

true if the key is found and the PdfPortfolioFieldValue removed; otherwise, false. This method returns false if key is not found in the PdfPortfolioFieldValueDictionary.

Exceptions
System.ArgumentNullException

key is null.

TryGet(PdfName, out PdfPortfolioFieldValue)

Gets the PdfPortfolioFieldValue associated with the specified PdfName key.

public bool TryGet(PdfName key, out PdfPortfolioFieldValue value)
Public Function TryGet(key As PdfName, ByRef value As PdfPortfolioFieldValue) As Boolean
Parameters
key
PdfName

The PdfName key of the PdfPortfolioFieldValue to get.

value
PdfPortfolioFieldValue

When this method returns, contains the PdfPortfolioFieldValue associated with the specified key, if the key is found; otherwise, the default PdfPortfolioFieldValue.

Returns
System.Boolean

true if the PdfPortfolioFieldValueDictionary contains a PdfPortfolioFieldValue with the specified key; otherwise, false.

Exceptions
System.ArgumentNullException

key is null.

Inherited Properties

Count

Gets the number of elements contained in the PdfCollection.

(Inherited from PdfCollection)

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Inherited Methods

Clear()

Removes all elements from the PdfCollection.

(Inherited from PdfCollection)

RemoveAt(System.Int32)

Removes the element at the specified index of the PdfCollection.

(Inherited from PdfCollection)

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IReadOnlyList<T>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods

Examples

See Also