WebDocumentViewerBuilder Class

A builder for the Web Document Viewer.

Namespace: DevExpress.AspNetCore.Reporting.WebDocumentViewer

Assembly: DevExpress.AspNetCore.Reporting.v24.2.dll

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public class WebDocumentViewerBuilder :
    WebDocumentViewerBuilderBase<WebDocumentViewerSettings, WebDocumentViewerBuilder, WebDocumentViewerModel>

VB.NET

Public Class WebDocumentViewerBuilder
    Inherits WebDocumentViewerBuilderBase(Of WebDocumentViewerSettings, WebDocumentViewerBuilder, WebDocumentViewerModel)

Related API Members

The following members return WebDocumentViewerBuilder objects:

Show 12 links

• BuilderFactoryExtensions.WebDocumentViewer(BuilderFactory, String)
• BuilderFactoryExtensions.WebDocumentViewer(BuilderFactory)
• WebDocumentViewerBuilder.AllowUrlWithJsContent(Boolean)
• WebDocumentViewerBuilder.Bind(String)
• WebDocumentViewerBuilder.ClientSideEvents(Action<WebDocumentViewerClientSideEventsBuilder>)
• WebDocumentViewerBuilder.ExportSettings(Action<ExportSettings>)
• WebDocumentViewerBuilder.MobileMode(Boolean)
• WebDocumentViewerBuilder.MobileSettings(Action<MobileViewerSettings>)
• WebDocumentViewerBuilder.ProgressBarSettings(Action<ProgressBarSettings>)
• WebDocumentViewerBuilder.RemoteSourceSettings(Action<RemoteSourceSettings>)
• WebDocumentViewerBuilder.SearchSettings(Action<SearchSettings>)
• WebDocumentViewerBuilder.TabPanelSettings(Action<TabPanelSettings>)

Remarks

Create an instance of this class using the WebDocumentViewer extension method.

The following code creates the Web Document Viewer component on the page, specifies various settings, and handles the OnExport event:

CSHTML

@{
    var viewerRender = Html.DevExpress().WebDocumentViewer("DocumentViewer")
        .Height("100%")
        .ExportSettings(configure=>configure.UseSameTab=false)
        .ProgressBarSettings(configure=>configure.Position= 
            DevExpress.XtraReports.Web.WebDocumentViewer.ProgressBarPosition.TopRight)
        .TabPanelSettings(configure => configure.Position = "Left" )
        .ClientSideEvents(ev=>ev.OnExport("onExportAction"))
        .Bind("TestReport");
    @viewerRender.RenderHtml()
}

Refer to the ASP.NET Core Reporting article to learn how to add a Web Document Viewer to an ASP.NET Core application in detail.

Inheritance

Object

DevExpress.AspNetCore.Reporting.Native.HtmlContentBuilderBase<DevExpress.AspNetCore.Reporting.WebDocumentViewer.Native.WebDocumentViewerSettings, WebDocumentViewerBuilder>

ClientControlContentBuilderBase<DevExpress.AspNetCore.Reporting.WebDocumentViewer.Native.WebDocumentViewerSettings, WebDocumentViewerBuilder>

WebDocumentViewerBuilderBase<DevExpress.AspNetCore.Reporting.WebDocumentViewer.Native.WebDocumentViewerSettings, WebDocumentViewerBuilder, WebDocumentViewerModel>

WebDocumentViewerBuilder