Skip to main content

WebDocumentViewerSettings.SettingsProgressBar Property

Provides access to the Web Document Viewer‘s progress bar settings.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.2.dll

NuGet Package: DevExpress.Web.Mvc5

#Declaration

public WebDocumentViewerProgressBarSettings SettingsProgressBar { get; }

#Property Value

Type Description
WebDocumentViewerProgressBarSettings

An object that specifies progress bar settings.

#Remarks

The SettingsProgressBar property allows you to set the Web Document Viewer‘s progress bar position and behavior.

This property provides access to the following properties:

  • Position - specifies the progress bar’s position.
  • KeepOnVisibleArea - specifies if the progress bar retains its position when users scroll a web page with the Document Viewer.

#Example

The code sample below illustrates how to change the progress bar’s position and reaction to web page scroll events.

@Html.DevExpress().WebDocumentViewer(settings => {
    settings.Name = "WebDocumentViewer1";
    // Place the progress bar in the Document Viewer's bottom left corner.
    settings.SettingsProgressBar.Position = DevExpress.XtraReports.Web.WebDocumentViewer.ProgressBarPosition.TopLeft;
    // Make the progress bar stay within the visible area when users scroll a web page that contains the Document Viewer.
    settings.SettingsProgressBar.KeepOnVisibleArea = true;
    })
    .Bind(new DevExpress.XtraReports.UI.XtraReport()).GetHtml()
See Also