Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RadPdfViewer
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadPdfViewer

Class

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
[TelerikToolboxCategory("Visualization")]
[ToolboxBitmap(typeof(RadPdfViewer), "Toolbox.Icons.PdfViewer.png")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(Html5PdfViewer))]
[ClientScriptResource("Telerik.Web.UI.RadPdfViewer", "Telerik.Web.UI.PdfViewer.Scripts.RadPdfViewer.js")]
[EmbeddedSkin("PdfViewer", typeof(RadPdfViewer))]
[EmbeddedSkin("PdfViewer", "Default", typeof(RadPdfViewer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Classic, typeof(RadPdfViewer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Lightweight, typeof(RadPdfViewer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Mobile, typeof(RadPdfViewer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Classic, typeof(RadPdfViewer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadPdfViewer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadPdfViewer))]
public class RadPdfViewer : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl

Inheritance: objectControlWebControlRadWebControlRadPdfViewer

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.MergeStyle(Style)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadPdfViewer()

C#
public RadPdfViewer()

Properties

ActivePage

Gets or sets the active page number in the viewer.

C#
public int ActivePage { get; set; }

ClientEvents

Gets the client events handlers for the PdfViewer.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public PdfViewerClientEvents ClientEvents { get; }

CssClassFormatString

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:
C#
protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

DefaultPageSizeSettings

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

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public DefaultPageSize DefaultPageSizeSettings { get; }

MaxSerializerLength

Gets or sets the maximum length of accepted JSON strings. Default value is int.MaxValue (2048MB=2147483647).

C#
public int MaxSerializerLength { get; set; }

MessagesSettings

Gets the localization messages for the PdfViewer.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public Messages MessagesSettings { get; }

PdfjsProcessingSettings

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

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public PdfjsProcessing PdfjsProcessingSettings { get; }

Scale

Gets or sets the default scale of the pages.

C#
[TypeConverter(typeof(ScaleConverter))]
public Scale Scale { get; set; }

TagKey

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

ToolBar

Gets or sets a value indicating whether the toolbar will be displayed. Inherits Kendo UI ToolBar.

C#
public bool ToolBar { get; set; }

ToolBarSettings

Gets the toolbar settings for the PdfViewer. Inherits Kendo UI ToolBar.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public ToolBar ToolBarSettings { get; }

ZoomMax

Gets or sets the maximum zoom that can be applied to the pages.

C#
public double ZoomMax { get; set; }

ZoomMin

Gets or sets the minimum zoom that can be applied to the pages.

C#
public double ZoomMin { get; set; }

ZoomRate

Gets or sets the zoom rate applied to the pages. Used when zooming with the mouse wheel and for the zoomIn and zoomOut tools.

C#
public double ZoomRate { get; set; }

Methods

DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

LoadPostData(string, NameValueCollection)

Loads the posted content of the list control, if it is different from the last posting.

C#
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystring

The key identifier for the control, used to index the postCollection.

postCollectionNameValueCollection

A NameValueCollection that contains value information indexed by control identifiers.

Returns:

bool

true if the posted content is different from the last posting; otherwise, false.

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

LoadViewState(object)

C#
protected override void LoadViewState(object state)
Parameters:stateobject

Overrides: WebControl.LoadViewState(object)

OnPreRender(EventArgs)

Called before the control is rendered.

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

An EventArgs that contains the event data.

Overrides: RadWebControl.OnPreRender(EventArgs)

Render(HtmlTextWriter)

C#
protected override void Render(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.Render(HtmlTextWriter)

RenderContents(HtmlTextWriter)

C#
protected override void RenderContents(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderContents(HtmlTextWriter)

SaveViewState()

C#
protected override object SaveViewState()
Returns:

object

Overrides: WebControl.SaveViewState()

TrackViewState()

C#
protected override void TrackViewState()

Overrides: WebControl.TrackViewState()

In this article
DefinitionConstructorsRadPdfViewer()PropertiesActivePageClientEventsCssClassFormatStringDefaultPageSizeSettingsMaxSerializerLengthMessagesSettingsPdfjsProcessingSettingsScaleTagKeyToolBarToolBarSettingsZoomMaxZoomMinZoomRateMethodsDescribeClientEvents(IScriptDescriptor)DescribeComponent(IScriptDescriptor)LoadPostData(string, NameValueCollection)LoadViewState(object)OnPreRender(EventArgs)Render(HtmlTextWriter)RenderContents(HtmlTextWriter)SaveViewState()TrackViewState()
Not finding the help you need?
Contact Support