Class
CollectionItemValues

Represents a collection of field values for an embedded file in a PDF Portfolio. Each entry maps a schema field key to its value.

Definition

Namespace:Telerik.Windows.Documents.Fixed.Model.Collections

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
public class CollectionItemValues : IEnumerable<KeyValuePair<string, CollectionItemValue>>, IEnumerable

Inheritance: objectCollectionItemValues

Implements: IEnumerableIEnumerable<KeyValuePair<string, CollectionItemValue>>

Properties

Count

Gets the number of values in the collection.

Declaration

cs-api-definition
public int Count { get; }

Property Value

int

this[string]

Gets or sets the value associated with the specified field key.

Declaration

cs-api-definition
public CollectionItemValue this[string fieldKey] { get; set; }

Parameters

fieldKey

string

The key of the schema field.

Property Value

CollectionItemValue

The collection item value associated with the key.

Methods

Clear()

Removes all values from the collection.

Declaration

cs-api-definition
public void Clear()

ContainsKey(string)

Determines whether the collection contains a value with the specified field key.

Declaration

cs-api-definition
public bool ContainsKey(string fieldKey)

Parameters

fieldKey

string

The key to locate.

Returns

bool

true if the collection contains a value with the key; otherwise, false.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

cs-api-definition
public IEnumerator<KeyValuePair<string, CollectionItemValue>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<string, CollectionItemValue>>

An enumerator for the collection.

Implements IEnumerable<KeyValuePair<string, CollectionItemValue>>.GetEnumerator()

Remove(string)

Removes the value with the specified field key.

Declaration

cs-api-definition
public bool Remove(string fieldKey)

Parameters

fieldKey

string

The key of the value to remove.

Returns

bool

true if the value was removed; otherwise, false.

SetDate(string, DateTime)

Sets a date value for the specified field key.

Declaration

cs-api-definition
public CollectionItemValue SetDate(string fieldKey, DateTime date)

Parameters

fieldKey

string

The key of the schema field.

date

DateTime

The date value.

Returns

CollectionItemValue

The created CollectionItemValue, allowing further configuration such as setting a prefix.

SetNumber(string, double)

Sets a numeric value for the specified field key.

Declaration

cs-api-definition
public CollectionItemValue SetNumber(string fieldKey, double number)

Parameters

fieldKey

string

The key of the schema field.

number

double

The numeric value.

Returns

CollectionItemValue

The created CollectionItemValue, allowing further configuration such as setting a prefix.

SetText(string, string)

Sets a text value for the specified field key.

Declaration

cs-api-definition
public CollectionItemValue SetText(string fieldKey, string text)

Parameters

fieldKey

string

The key of the schema field.

text

string

The text value.

Returns

CollectionItemValue

The created CollectionItemValue, allowing further configuration such as setting a prefix.

TryGetValue(string, out CollectionItemValue)

Tries to get the value associated with the specified field key.

Declaration

cs-api-definition
public bool TryGetValue(string fieldKey, out CollectionItemValue value)

Parameters

fieldKey

string

The key of the value to get.

value

CollectionItemValue

When this method returns, contains the value, or null if not found.

Returns

bool

true if the value was found; otherwise, false.