ReportStorageWebExtension.GetUrlsAsync() Method

Returns a dictionary that contains the report names (URLs) and display names.

Namespace: DevExpress.XtraReports.Web.Extensions

Assembly: DevExpress.XtraReports.v25.2.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public virtual Task<Dictionary<string, string>> GetUrlsAsync()

VB.NET

Public Overridable Function GetUrlsAsync As Task(Of Dictionary(Of String, String))

Returns

Type	Description
Task<Dictionary<String, String>>	A task that returns the dictionary of the existing report names (URLs) and display names.

Remarks

The GetUrlsAsync method returns a dictionary whose keys are URLs of all reports available in the current Report Storage, and whose values are the display names of these reports.

The Report Designer calls the GetUrlsAsync method in asynchronous mode to populate the report list before the Open Report and Save Report dialogs are shown, and after a new report is saved to a storage.

The GetUrlsAsync method is called when the application uses an asynchronous engine. To enable an asynchronous engine, call one of the following methods at the application startup:

ASP.NET MVC	ASP.NET Core
DefaultWebDocumentViewerContainer.UseAsyncEngine, DefaultReportDesignerContainer.UseAsyncEngine	ReportingConfigurationBuilder.UseAsyncEngine

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetUrlsAsync() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-asp-net-core-azure-blob-storage/CS/Controllers/HomeController.cs#L43

[FromServices] ReportStorageWebExtension reportStorageWebExtension) {
var availableReports = await reportStorageWebExtension.GetUrlsAsync();
var viewrModel = string.IsNullOrEmpty(ReportName)