Skip to content

ProgressBarViewItem

Apostolis Bekiaris edited this page Aug 12, 2019 · 25 revisions

GitHub issues GitHub close issues

About

The ProgressBarViewItem package contains a ViewItem that can help you display a progress for your long running tasks. Examples in the details section of this page.

Installation

  1. First you need the nuget package so issue this command to the VS Nuget package console

    Install-Package Xpand.XAF.Modules.ProgressBarViewItem.

    The above only references the dependencies and nexts steps are mandatory.

  2. Ways to Register a Module or simply add the next call to your module constructor

    RequiredModuleTypes.Add(typeof(Xpand.XAF.Modules.ProgressBarViewItemModule));

Versioning

The module is not bound to DevExpress versioning, which means you can use the latest version with your old DevExpress projects Read more.

The module follows the Nuget Version Basics.

Dependencies

.NetFramework:

DevExpress.ExpressApp Any
System.Reactive 4.1.6
System.ValueTuple 4.5.0
Xpand.XAF.Modules.Reactive 1.2.46
Xpand.VersionConverter 1.0.34

Issues-Debugging-Troubleshooting

To Step in the source code you need to enable Source Server support in your Visual Studio/Tools/Options/Debugging/Enable Source Server Support. See also How to boost your DevExpress Debugging Experience.

If the package is installed in a way that you do not have access to uninstall it, then you can unload it with the next call when XafApplication.SetupComplete.

((Xpand.XAF.Modules.ProgressBarViewItemModule) Application.Modules.FindModule(typeof(Xpand.XAF.Modules.ProgressBarViewItemModule))).Unload();

Details

The module registers a ProgressViewItem into the ViewItems of your application. image.

This is a ViewItem and is not bound to a property. To add it in a DetailView Layout you have first to add it in the IModelViewItems collection.

Let's assume you have a long running task such as an import which is done in a different thread and an asynchronous sequence emits its progress. To bind the sequence to a DetailView ProgressViewItem we have to:

var progressBarViewItem = View.GetItems<ProgressBarViewItemBase>().First();
progressBarViewItem.Start();

The ProgressViewItem implements the IObserver<decimal> so after start the binding becomes as simple as:

await signal.Cast<Decimal>.Do(progressBarViewItem);

The ProgressBarViewItem features completion notification which can be configured like:

progressBarViewItem.SetFinishOptions(new MessageOptions(){});

image

Tests

The module is tested on Azure for each build with these tests

Examples

The module is integrated with the ExcelImporter.

Next we see how it looks on Desktop:

win

and the same view on the web:

web2

You can’t perform that action at this time.