API Reference
Class
PdfPortfolioOptions
Configures the collection dictionary used to present generated embedded files as a portfolio.
Inheritance
- Object
- PdfPortfolioOptions
Usage
Explore 5 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
- Property PdfOptions.Portfolio
- Method PdfPortfolioOptions.ClearFields
- Method PdfPortfolioOptions.RemoveField
- Method PdfPortfolioOptions.SetField
Accepted by parameters 1
- Method PdfOptions.SetPortfolio
Constructors
public PdfPortfolioOptions() #Creates portfolio options with a visible file-name field.
Methods
public PdfPortfolioOptions ClearFields() #Returns:
PdfPortfolioOptionsRemoves every portfolio field.
public PdfPortfolioOptions RemoveField(PdfPortfolioFieldKind kind) #Returns:
PdfPortfolioOptionsRemoves a standard portfolio field.
Parameters
- kind OfficeIMO.Pdf.PdfPortfolioFieldKind
public PdfPortfolioOptions SetField(PdfPortfolioField field) #Returns:
PdfPortfolioOptionsAdds or replaces a standard portfolio field.
Parameters
- field OfficeIMO.Pdf.PdfPortfolioField
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String? InitialDocumentFileName { get; set; } #Optional embedded file to open initially. The name must match a generated embedded file.
public PdfPortfolioFieldKind? SortBy { get; set; } #Optional standard property used to sort portfolio entries.
public Boolean SortAscending { get; set; } #Whether the configured sort is ascending.
public IReadOnlyList<PdfPortfolioField> Fields { get; } #Configured portfolio fields in display order.