All docs
V20.2
20.2
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

WebDocumentViewerProgressBarSettings Class

Contains settings for the progress bar that appears while a report is generated.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

Assembly: DevExpress.XtraReports.v20.2.Web.WebForms.dll

Declaration

public class WebDocumentViewerProgressBarSettings :
    PropertiesBase,
    IPropertiesOwner
Public Class WebDocumentViewerProgressBarSettings
    Inherits PropertiesBase
    Implements IPropertiesOwner

The following members accept/return WebDocumentViewerProgressBarSettings objects:

Library Related API Members
Reporting ASPxWebDocumentViewer.SettingsProgressBar
ASP.NET MVC Extensions WebDocumentViewerSettings.SettingsProgressBar

Remarks

The progress bar appears while a report is generated for the preview in Web Document Viewer when asynchronous export is enabled (the AsyncExportApproach is set to true).

Use the SettingsProgressBar.Position property to specify the progress bar's position.

Set the SettingsProgressBar.KeepOnVisibleArea property to true to make the progress bar stay within the visible area when users scroll a web page that contains the Document Viewer.

NOTE

Settings from the WebDocumentViewerProgressBarSettings object are applicable in ASP.NET MVC and ASP.NET Web Forms applications. For ASP.NET Core applications, use the WebDocumentViewer.DataContracts.ProgressBarSettings object instead.

Examples

The code sample below illustrates how to change the progress bar's position and reaction to web page scroll events in ASP.NET Web Forms applications.

using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Web.WebDocumentViewer;
// ...

XtraReport1 report = new XtraReport1();
// Place the progress bar in the Document Viewer's bottom left corner.
ASPxWebDocumentViewer1.SettingsProgressBar.Position = ProgressBarPosition.BottomLeft;
// Make the progress bar stay within the visible area when users scroll a web page that contains the Document Viewer.
ASPxWebDocumentViewer1.SettingsProgressBar.KeepOnVisibleArea = true;
ASPxWebDocumentViewer1.OpenReport(report);

Inheritance

Object
StateManager
PropertiesBase
WebDocumentViewerProgressBarSettings
See Also