New to Telerik Document ProcessingStart a free 30-day trial

Represents the schema of a PDF Portfolio, defining the fields (columns) displayed for embedded files.

Definition

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

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

C#
public class PortfolioSchema : IReadOnlyList<PortfolioField>, IReadOnlyCollection<PortfolioField>, IEnumerable<PortfolioField>, IEnumerable

Inheritance: objectPortfolioSchema

Implements: IEnumerableIEnumerable<PortfolioField>IReadOnlyCollection<PortfolioField>IReadOnlyList<PortfolioField>

Methods

Adds a predefined field for displaying creation dates.

C#
public PortfolioField AddCreationDateField(int order = 5)
Parameters:orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Adds a custom date field to the schema.

C#
public PortfolioField AddDateField(string key, string displayName, int order = 0)
Parameters:keystring

The unique key identifying this field.

displayNamestring

The display name shown in the user interface.

orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Adds a predefined field for displaying file descriptions.

C#
public PortfolioField AddDescriptionField(int order = 2)
Parameters:orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Adds a predefined field for displaying file names.

C#
public PortfolioField AddFileNameField(int order = 1)
Parameters:orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Adds a predefined field for displaying modification dates.

C#
public PortfolioField AddModificationDateField(int order = 4)
Parameters:orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Adds a custom number field to the schema.

C#
public PortfolioField AddNumberField(string key, string displayName, int order = 0)
Parameters:keystring

The unique key identifying this field.

displayNamestring

The display name shown in the user interface.

orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Adds a predefined field for displaying file sizes.

C#
public PortfolioField AddSizeField(int order = 3)
Parameters:orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Adds a custom text field to the schema.

C#
public PortfolioField AddTextField(string key, string displayName, int order = 0)
Parameters:keystring

The unique key identifying this field.

displayNamestring

The display name shown in the user interface.

orderint

The display order of the column.

Returns:

PortfolioField

The created PortfolioField.

Removes all fields from the schema.

C#
public void Clear()

Returns an enumerator that iterates through the fields.

C#
public IEnumerator<PortfolioField> GetEnumerator()
Returns:

IEnumerator<PortfolioField>

An enumerator for the fields collection.

Implements: IEnumerable<PortfolioField>.GetEnumerator()

Configures the schema with default fields containing common file properties.

C#
public void UseDefaultSchema()

Properties

Gets the number of fields in the schema.

C#
public int Count { get; }

Implements: IReadOnlyCollection<PortfolioField>.Count

Gets the field at the specified index.

C#
public PortfolioField this[int index] { get; }
Parameters:indexint

The zero-based index of the field to get.

Property Value:

The field at the specified index.

Implements: IReadOnlyList<PortfolioField>.this[int]