PDFViewerBuilder
Properties
WriteAction - Func
Methods
PdfjsProcessing(System.Action)
Specifies the PDF.JS configuration options. Including pdfjs is mandatory.
Parameters
configurator - System.Action<PDFViewerPdfjsProcessingSettingsBuilder>
The configurator for the pdfjsprocessing setting.
DplProcessing(System.Action)
Specifies the DPL configuration options. For a complete demo and a backend implementation, check the Telerik UI for ASP.NET Core DPL Processing demo.
Parameters
configurator - System.Action<PDFViewerDplProcessingSettingsBuilder>
The configurator for the dplprocessing setting.
Width(System.Double)
The width of the PDFViewer.
Parameters
value - System.Double
The value for Width
Height(System.Double)
The height of the PDFViewer.
Parameters
value - System.Double
The value for Height
DefaultPageSize(System.Action)
Specifies the default page size if no PDF is displayed in the PDFViewer. The page size will shrink to fit the viewer dimensions.
Parameters
configurator - System.Action<PDFViewerDefaultPageSizeSettingsBuilder>
The configurator for the defaultpagesize setting.
Page(System.Double)
The selected page number in the viewer.
Parameters
value - System.Double
The value for Page
Scale(System.Double)
Specifies the default scale of the pages.
Parameters
value - System.Double
The value for Scale
ZoomMin(System.Double)
Specifies the minimum zoom that could be applied to the pages.
Parameters
value - System.Double
The value for ZoomMin
ZoomMax(System.Double)
Specifies the maximum zoom that could be applied to the pages.
Parameters
value - System.Double
The value for ZoomMax
ZoomRate(System.Double)
Specifies the zoom rate that could be applied to the pages. Used when zooming on mousewheel and for the zoomIn and zoomOut tools.
Parameters
value - System.Double
The value for ZoomRate
View(System.Action)
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.
Parameters
configurator - System.Action<PDFViewerViewSettingsBuilder>
The configurator for the view setting.
Toolbar(System.Action)
Toolbar option accepts a Boolean value which indicates if the toolbar will be displayed or an Object with items and overflow configuration. Inherits Kendo UI Toolbar.
Parameters
configurator - System.Action<PDFViewerToolbarSettingsBuilder>
The configurator for the toolbar setting.
Example
@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =>
toolbar.Items(items =>
{
items.Add().Name("pager");
items.Add().Name("spacer");
items.Add().Name("print");
})
)
)
Toolbar(System.Boolean)
Toolbar option accepts a Boolean value which indicates if the toolbar will be displayed or an Object with items and overflow configuration. Inherits Kendo UI Toolbar.
Parameters
enabled - System.Boolean
Enables or disables the toolbar option.
Messages(System.Action)
Specifies the localization messages of the PDFViewer.
Parameters
configurator - System.Action<PDFViewerMessagesSettingsBuilder>
The configurator for the messages setting.
Document(System.String)
The client-side global variable or function to provide the JSON data for the PDF document.
Parameters
handler - System.String
The name of the JavaScript function that will be evaluated.
Document(System.Func)
The client-side global variable or function to provide the JSON data for the PDF document.
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<PDFViewerEventBuilder>
The client events action.
Example
@(Html.Kendo().PDFViewer()
.Name("PDFViewer")
.Events(events => events
.Render("onRender")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.