DevExpress WPF: Prism Adapters

DevExpress.Wpf.PrismAdapters connects the Prism application framework to DevExpress WPF container controls. This package implements region adapters that allow Prism to work with the DevExpress Dock Layout Manager, tab control, and navigation controls (in addition to standard WPF controls). You can use Prism's modularity and view injection capabilities together with DevExpress WPF docking and navigation UI.

dotnet add package DevExpress.Wpf.PrismAdapters

Key Features

• Region adapters for DevExpress containers — DXTabControl, DocumentGroup, LayoutGroup, LayoutPanel, TabbedGroup, NavBarControl, NavBarGroup, NavigationFrame, and any ContentControl descendant.
• DXRegionManager: Declares region names for DevExpress UI control elements, such as NavBarGroup, where the standard Prism RegionManager.RegionName attached property cannot be used.
• Multi-version Prism support: Adapters are available for Prism versions 5, 6, 7, 8, and 9.
• AdapterFactory: Creates adapter instances when you register DevExpress adapters in your bootstrapper or container.
• Delayed region creation: Delays region registration until the host control is ready to avoid initialization-order issues at startup.

Examples

Example 1: Declare a Prism Region in a DevExpress Container

DevExpress Docking components in this example require the DevExpress.Wpf.Docking package.

<UserControl
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:dxdo="http://schemas.devexpress.com/winfx/2008/xaml/docking"
    xmlns:dxprism="http://schemas.devexpress.com/winfx/2008/xaml/prism">

    <dxdo:DockLayoutManager>
        <dxdo:LayoutGroup>
            <!-- DXRegionManager works on DevExpress elements that Prism's own
                 RegionManager attached property cannot target. -->
            <dxdo:LayoutPanel Caption="Main"
                              dxprism:DXRegionManager.RegionName="MainRegion" />
        </dxdo:LayoutGroup>
    </dxdo:DockLayoutManager>
</UserControl>

Prism can now inject views into MainRegion, and they appear inside the docking panel.

Example 2: Pin the Prism Version Explicitly

using DevExpress.Xpf.Prism;

public partial class App : PrismApplication {
    protected override void OnStartup(StartupEventArgs e) {
        // Skips version auto-detection and selects the Prism 9 adapters.
        DXRegionManager.PrismVersion = PrismVersion.Prism9;
        base.OnStartup(e);
    }
}

This example explicitly activates adapters for Prism 9. Specifying the version directly allows the framework to skip automatic version detection (assembly inspection) at startup.

Example 3: Register the Region Adapter for a DevExpress Control

Map a DevExpress control to its region adapter in a Prism application. AdapterFactory.Make() builds the adapter for the chosen control. For Prism 5 and 6, override ConfigureRegionAdapterMappings in the bootstrapper; for Prism 7, 8, and 9, override the method in PrismApplication.

using DevExpress.Xpf.Core;
using DevExpress.Xpf.Prism;
using Prism.Regions; // Prism 6-8; for Prism 9 use Prism.Navigation.Regions

public partial class App : PrismApplication {
    protected override void ConfigureRegionAdapterMappings(RegionAdapterMappings regionAdapterMappings) {
        base.ConfigureRegionAdapterMappings(regionAdapterMappings);

        var factory = Container.Resolve<IRegionBehaviorFactory>();
        // Registers the DevExpress region adapter for DXTabControl.
        regionAdapterMappings.RegisterMapping(
            typeof(DXTabControl),
            AdapterFactory.Make<RegionAdapterBase<DXTabControl>>(factory));
    }
}

After you register the mapping, Prism can inject views into a DXTabControl region declared with dxprism:DXRegionManager.RegionName. See the Prism Adapters help topic for equivalent Unity/Autofac bootstrapper syntax used by Prism 5 and 6.

Evaluation Period, Pricing Options, and Licensing Terms

Whether you own a license or want to start a 30-day evaluation period, download and register your DevExpress license key. To obtain your key, log in to the DevExpress Download Manager. Use your existing DevExpress.com account or create a new account for free. For key registration instructions, see License Key for DevExpress Products.

If you purchase a license after evaluating a product, re-register your updated DevExpress license key to remove evaluation version warnings/messages.

This package is included in the following commercial subscriptions:

• DevExpress WPF Subscription
• DevExpress DXperience Subscription
• DevExpress Universal Subscription

See DevExpress Subscriptions & Licensing for subscription comparison tables, purchasing FAQ, and licensing information.

Related Components/Packages

DevExpress.Wpf.Docking - DevExpress WPF Dock Layout Manager, the most common host for Prism regions.

dotnet add package DevExpress.Wpf.Docking

DevExpress.Wpf.NavBar - DevExpress WPF Navigation Bar control with region adapter support.

dotnet add package DevExpress.Wpf.NavBar

DevExpress.Wpf.Core - DevExpress WPF core library and theme engine shared by all DevExpress WPF controls.

dotnet add package DevExpress.Wpf.Core

Demos

NOTE: Demo links below only work if you already have DevExpress WPF Demos installed on your machine. To install demos, download and run the DevExpress Unified Installer (evaluation or licensed version). Remember to select "Demo Applications" on the product selection screen.

• DevExpress WPF MVVM Framework - POCO View Models
• DevExpress WPF MVVM Framework - Interaction of View Models

Documentation

• Prism Adapters
• DevExpress.Xpf.Prism Namespace
• Regions

Software Bill of Materials (SBOM)

To access SBOM files for DevExpress packages, please refer to the following article: Software Bill of Materials (SBOM) for DevExpress .NET assemblies/NuGet packages, JavaScript, VCL and other redistributable artifacts.

See Also: Information Security | Security - What You Need to Know

Useful Online Resources

• www.devexpress.com
• DevExpress Support Center
• DevExpress Blogs