Loading...
Area: Episerver CMS
Applies to versions: Episerver CMS UI 11.1.0 and higher & PDF Preview 1 and higher

Episerver PDF Preview

Recommendations [hide]

This topic describes the Episerver PDF Preview add-on, which allows editors to preview PDF documents in the Episerver CMS edit view. This is useful for websites where you manage multiple content items in PDF format.

How it works

When accessing the edit view in Episerver CMS, you can select a PDF document from a media folder, to preview its content.

PDF_preview.png

In the PdfPreview package, there is a class named PdfFile which handles uploaded files with the .pdf extension.

User scenarios

These are the typical user scenarios for adding PDF preview to your solution.

The system does not have a model for handling PDF files

If the system does not have a model for handling PDF files, the default PdfFile model provided by the package is used. Editors can now preview PDF files in edit view without any extra steps.

The system already has a model for handling PDF files

By default, the ContentMediaResolver class from Episerver CMS Core gets the first matching media implementation type registered for an extension. If there is an existing type registered for “pdf”, the PdfFile media implementation in the Episerver package is used but in this case, the existing type should be chosen in this case.

To change this default behavior, a media resolver class named PdfContentMediaResolver is used to ignore the PdfFile type in the Episerver package and thus, the existing registered media type is the candidate.

PdfContentMediaResolver inherits ContentMediaResolver and overrides the Type GetFirstMatching(string extension) method to handle the business logic above. 

To turn on the PDF preview, the PDF media model must implement the IPdfFile interface. For example:

[ContentType(DisplayName = "PdfFile", GUID = "…", Description = "")]

[MediaDescriptor(ExtensionString = "pdf")]

public class PdfFile : MediaData, IPdfFile

{

}

Note: Due to current limitations, after installing the add-on only newly uploaded PDFs can be previewed. Existing PDFs must be uploaded again to be previewed.

Do you find this information helpful? Please log in to provide feedback.

Last updated: Aug 05, 2020

Recommendations [hide]