New to Telerik Document Processing? Start a free 30-day trial

CollectionItemValue

Class

Represents a value in a collection item dictionary, storing custom metadata for an embedded file in a PDF Portfolio.

Collection item values correspond to fields defined in the portfolio schema. Each value has a type (text, number, or date) that should match the corresponding schema field type. A value can optionally have a prefix that is displayed before the main value in the PDF viewer. Use SetText(string, string), SetNumber(string, double), or SetDate(string, DateTime) to create instances.

Definition

Namespace:Telerik.Documents.Fixed.Model.Collections

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

public class CollectionItemValue

Inheritance: objectCollectionItemValue

Properties

DateValue

DateTime?

Gets the date value if ValueType is Date.

public DateTime? DateValue { get; }

Property Value:

The date value, or null if the value is not a date type.

NumberValue

double?

Gets the numeric value if ValueType is Number.

public double? NumberValue { get; }

Property Value:

The numeric value, or null if the value is not a number type.

Prefix

string

Gets or sets an optional prefix that is displayed before the main value in the PDF viewer. This corresponds to the P entry in a CollectionSubitem dictionary (PDF 1.7).

public string Prefix { get; set; }

When a prefix is set, the value is exported as a CollectionSubitem dictionary with P and D entries. Example: A subject field might have prefix "Re:" and data "Let's have lunch on Friday!".

TextValue

string

Gets the text value if ValueType is Text.

public string TextValue { get; }

Property Value:

The text value, or null if the value is not a text type.

ValueType

CollectionItemValueType

Gets the type of this collection item value.

public CollectionItemValueType ValueType { get; }