ClassPortfolioSchema
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:
public class PortfolioSchema : IReadOnlyList<PortfolioField>, IReadOnlyCollection<PortfolioField>, IEnumerable<PortfolioField>, IEnumerableInheritance: objectPortfolioSchema
Implements:
Properties
Count
Gets the number of fields in the schema.
this[int]
Gets the field at the specified index.
Declaration
public PortfolioField this[int index] { get; }Parameters
index
The zero-based index of the field to get.
Property Value
The field at the specified index.
Implements
Methods
AddCreationDateField(int)
Adds a predefined field for displaying creation dates.
Declaration
public PortfolioField AddCreationDateField(int order = 5)Parameters
order
The display order of the column.
Returns
The created PortfolioField.
AddDateField(string, string, int)
Adds a custom date field to the schema.
Declaration
public PortfolioField AddDateField(string key, string displayName, int order = 0)Parameters
key
The unique key identifying this field.
displayName
The display name shown in the user interface.
order
The display order of the column.
Returns
The created PortfolioField.
AddDescriptionField(int)
Adds a predefined field for displaying file descriptions.
Declaration
public PortfolioField AddDescriptionField(int order = 2)Parameters
order
The display order of the column.
Returns
The created PortfolioField.
AddFileNameField(int)
Adds a predefined field for displaying file names.
Declaration
public PortfolioField AddFileNameField(int order = 1)Parameters
order
The display order of the column.
Returns
The created PortfolioField.
AddModificationDateField(int)
Adds a predefined field for displaying modification dates.
Declaration
public PortfolioField AddModificationDateField(int order = 4)Parameters
order
The display order of the column.
Returns
The created PortfolioField.
AddNumberField(string, string, int)
Adds a custom number field to the schema.
Declaration
public PortfolioField AddNumberField(string key, string displayName, int order = 0)Parameters
key
The unique key identifying this field.
displayName
The display name shown in the user interface.
order
The display order of the column.
Returns
The created PortfolioField.
AddSizeField(int)
Adds a predefined field for displaying file sizes.
Declaration
public PortfolioField AddSizeField(int order = 3)Parameters
order
The display order of the column.
Returns
The created PortfolioField.
AddTextField(string, string, int)
Adds a custom text field to the schema.
Declaration
public PortfolioField AddTextField(string key, string displayName, int order = 0)Parameters
key
The unique key identifying this field.
displayName
The display name shown in the user interface.
order
The display order of the column.
Returns
The created PortfolioField.
GetEnumerator()
Returns an enumerator that iterates through the fields.
Declaration
public IEnumerator<PortfolioField> GetEnumerator()Returns
An enumerator for the fields collection.
Implements
UseDefaultSchema()
Configures the schema with default fields containing common file properties.
Declaration
public void UseDefaultSchema()