All docs
V20.2
21.1 (EAP/Beta)
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.KeepOnVisibleArea Property

Gets or sets whether the progress bar should stay on the visible area when users scroll a web page that contains the Document Viewer.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

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

Declaration

[DefaultValue(true)]
public bool KeepOnVisibleArea { get; set; }

Property Value

Type Default Description
Boolean

true

true, if the progress bar should stay on the visible area; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library Object Type Path to KeepOnVisibleArea
Reporting ASPxWebDocumentViewer
.SettingsProgressBar.KeepOnVisibleArea
ASP.NET MVC Extensions MVCxWebDocumentViewer
.SettingsProgressBar.KeepOnVisibleArea
WebDocumentViewerSettings
.SettingsProgressBar.KeepOnVisibleArea

Remarks

When KeepOnVisibleArea is set to true, the progress bar retains its position in the browser window if its assigned Document Viewer's corner is scrolled out of user's view.

When KeepOnVisibleArea is set to false, the progress bar is scrolled together with the Document Viewer.

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);
See Also