Class
PortfolioCollection

Represents a PDF Portfolio (also known as PDF Collection or PDF Package) that provides enhanced presentation of embedded file attachments with customizable views, schema, and sorting.

Definition

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

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
public class PortfolioCollection

Inheritance: objectPortfolioCollection

Properties

InitialDocument

Gets or sets the name of the embedded file to display initially when the portfolio is opened. If null or not found, the container PDF document is displayed.

Declaration

cs-api-definition
public string InitialDocument { get; set; }

Property Value

string

IsEnabled

Gets or sets a value indicating whether the portfolio presentation is enabled. When true, the document will be presented as a PDF Portfolio in compliant viewers.

Declaration

cs-api-definition
public bool IsEnabled { get; set; }

Property Value

bool

Remarks

Set this property to true to enable portfolio mode for the document's embedded files. The portfolio will only be exported if this property is true and the document contains embedded files.

Schema

Gets the schema that defines the fields (columns) displayed for embedded files. Use the schema's Add methods to add fields to the portfolio.

Declaration

cs-api-definition
public PortfolioSchema Schema { get; }

Property Value

PortfolioSchema

Sort

Gets the sort settings that define how embedded files are ordered in the portfolio.

Declaration

cs-api-definition
public PortfolioSort Sort { get; }

Property Value

PortfolioSort

ViewMode

Gets or sets the initial view mode for displaying the portfolio. Default value is Details.

Declaration

cs-api-definition
public PortfolioViewMode ViewMode { get; set; }

Property Value

PortfolioViewMode