New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

PDFViewerBuilder

Class

Defines the fluent API for configuring the Kendo PDFViewer for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class PDFViewerBuilder : WidgetBuilderBase<PDFViewer, PDFViewerBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<PDFViewer, PDFViewerBuilder>PDFViewerBuilder

Implements: IHtmlString

Constructors

PDFViewerBuilder(PDFViewer)

Initializes a new instance of the PDFViewer class.

public PDFViewerBuilder(PDFViewer component)

Parameters:componentPDFViewer

The component.

Methods

DefaultPageSize(Action<PDFViewerDefaultPageSizeSettingsBuilder>)

Specifies the default page size if no PDF is displayed in the PDFViewer. The page size will shrink to fit the viewer dimensions.

public PDFViewerBuilder DefaultPageSize(Action<PDFViewerDefaultPageSizeSettingsBuilder> configurator)

Parameters:configuratorAction<PDFViewerDefaultPageSizeSettingsBuilder>

The action that configures the DefaultPageSize.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.DefaultPageSize(dfpagesize =&gt; dfpagesize
.Width(595)
.Height(842)
)
)

Document(Func<object, object>)

The client-side global variable or function to provide the JSON data for the PDF document.

public PDFViewerBuilder Document(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the document action.

Returns:

PDFViewerBuilder

Document(string)

The client-side global variable or function to provide the JSON data for the PDF document.

public PDFViewerBuilder Document(string handler)

Parameters:handlerstring

The value that configures the document action.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Document("getJsonData")
)

DplProcessing(Action<PDFViewerDplProcessingSettingsBuilder>)

Specifies the DPL configuration options. For a complete demo and a backend implementation, check the Telerik UI for ASP.NET Core DPL Processing demo.

public PDFViewerBuilder DplProcessing(Action<PDFViewerDplProcessingSettingsBuilder> configurator)

Parameters:configuratorAction<PDFViewerDplProcessingSettingsBuilder>

The action that configures the DPL processing.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.DplProcessing(dpl =&gt; {
dpl.Read(r =&gt; r.Url(Url.Action("GetInitialPdf", "PdfViewer")));
dpl.Upload(upload =&gt; upload.Url(Url.Action("GetPdf", "PdfViewer")).SaveField("file"));
dpl.LoadOnDemand(true);
})
)

Events(Action<PDFViewerEventBuilder>)

Configures the client-side events.

public PDFViewerBuilder Events(Action<PDFViewerEventBuilder> configurator)

Parameters:configuratorAction<PDFViewerEventBuilder>

The client events action.

Returns:

PDFViewerBuilder

Example:

@( Html.Kendo().PDFViewer()
.Name("PDFViewer")
.Events(events =&gt; events
.Render("onRender")
)
)

Height(double)

The height of the PDFViewer.

public PDFViewerBuilder Height(double value)

Parameters:valuedouble

The value that configures the height.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Height(1200)
)

Messages(Action<PDFViewerMessagesSettingsBuilder>)

Specifies the localization messages of the PDFViewer.

public PDFViewerBuilder Messages(Action<PDFViewerMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<PDFViewerMessagesSettingsBuilder>

The action that configures the messages.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Messages(messages =&gt; messages.DefaultFileName("PDFDocument"))
)

Page(double)

The selected page number in the viewer.

public PDFViewerBuilder Page(double value)

Parameters:valuedouble

The value that configures the page.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Page(1)
)

PdfjsProcessing(Action<PDFViewerPdfjsProcessingSettingsBuilder>)

Specifies the PDF.JS configuration options. Including PDF.JS is mandatory.

public PDFViewerBuilder PdfjsProcessing(Action<PDFViewerPdfjsProcessingSettingsBuilder> configurator)

Parameters:configuratorAction<PDFViewerPdfjsProcessingSettingsBuilder>

The action that configures the PDF.JS processing.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.PdfjsProcessing(pdf =&gt; pdf
.File(Url.Content("~/Content/web/pdfViewer/sample.pdf"))
)
)

Scale(double)

Specifies the default scale of the pages.

public PDFViewerBuilder Scale(double value)

Parameters:valuedouble

The value that configures the scale.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Scale(1.5)
)

Toolbar(Action<PDFViewerToolbarSettingsBuilder>)

Toolbar option accepts a Boolean value which indicates if the toolbar will be displayed or an Object with items.

public PDFViewerBuilder Toolbar(Action<PDFViewerToolbarSettingsBuilder> configurator)

Parameters:configuratorAction<PDFViewerToolbarSettingsBuilder>

The action that configures the toolbar.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Command("PageChangeCommand").Type("pager").Name("pager");
})
)
)

Toolbar(bool)

Toolbar option accepts a Boolean value which indicates if the toolbar will be displayed or an Object with items.

public PDFViewerBuilder Toolbar(bool enabled)

Parameters:enabledbool

Enables or disables the toolbar option.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(false)
)

View(Action<PDFViewerViewSettingsBuilder>)

Defines the page surface options. This setting is available only for DPL Processing. The page render a drawing Surface and all of its configuration options could be defined.

public PDFViewerBuilder View(Action<PDFViewerViewSettingsBuilder> configurator)

Parameters:configuratorAction<PDFViewerViewSettingsBuilder>

The action that configures the view.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.View(view =&gt; view.Type("svg"))
)

Width(double)

The width of the PDFViewer.

public PDFViewerBuilder Width(double value)

Parameters:valuedouble

The value that configures the width.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Width(500)
)

ZoomMax(double)

Specifies the maximum zoom that could be applied to the pages.

public PDFViewerBuilder ZoomMax(double value)

Parameters:valuedouble

The value that configures the ZoomMax.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.ZoomMax(2)
)

ZoomMin(double)

Specifies the minimum zoom that could be applied to the pages.

public PDFViewerBuilder ZoomMin(double value)

Parameters:valuedouble

The value that configures the ZoomMin.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.ZoomMin(1)
)

ZoomRate(double)

Specifies the zoom rate that could be applied to the pages. Used when zooming on mousewheel and for the zoomIn and zoomOut tools.

public PDFViewerBuilder ZoomRate(double value)

Parameters:valuedouble

The value that configures the ZoomRate.

Returns:

PDFViewerBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.ZoomRate(0.5)
)