DevExpress.Win.ProjectTemplates 24.2.3

DevExpress WinForms Templates

What's Included

This NuGet package contains project templates you can use with the DevExpress WinForms components.

Common

• Blank Application: dx.win - Creates a desktop (WinForms) application with a single empty form with DevExpress themes/styles.
• Grid-based Application: dx.win.grid - Creates a desktop (WinForms) application with a Ribbon UI-based form that hosts a Data Grid control for browsing and editing data.
• Ribbon-based Application: dx.win.ribbon - Creates a desktop (WinForms) application with an empty form featuring the Ribbon UI.
• Toolbar-based Application: dx.win.toolbar - Creates a desktop (WinForms) application with an empty form featuring the toolbar/menu UI.
• Fluent Design Application: dx.win.fluent - Creates a desktop (WinForms) application with a Fluent Design form that features an adaptive layout and an integrated hamburger menu with DirectX-based visual effects.
• DirectX-based Application: dx.win.directx - Creates a desktop (WinForms) application with an empty form that enables DirectX (for enhanced performance on high resolution displays) for DevExpress controls that support this rendering engine. You can use HTML & CSS templates to paint the form's title bar, borders, and content area.

Office-Inspired Controls

• Outlook-Inspired Application: dx.win.outlook - Creates a desktop (WinForms) application with a Ribbon UI-based form with a Data Grid control. The Grid is switched to the Tile View and mimics Microsoft 365 Outlook's Compact View option.
• Word Processing Application: dx.win.word - Creates a desktop (WinForms) application with an integrated Rich Text Editor and Ribbon UI. The application mimics Microsoft Word for editing DOCX/RTF files.
• Spreadsheet Application: dx.win.excel - Creates a desktop (WinForms) application with an integrated Spreadsheet control and Ribbon UI. The application mimics Microsoft Excel for editing XLSX/CSV files.
• PDF Viewer Application: dx.win.pdf - Creates a desktop (WinForms) application with a form that hosts a PDF Viewer component and provides PDF-specific actions using the Ribbon UI.
• Scheduling Application: dx.win.scheduling - Creates a desktop (WinForms) application with an integrated calendar/scheduler, navigation bar, and Ribbon UI.
• Map Application: dx.win.map - Creates a desktop (WinForms) application with a form that contains a Map Control component for browsing terrain data retrieved from map services, and provides map-specific commands using the Ribbon UI.

Hybrid & Enterprise Development

• Blazor Hybrid WinForms Application: dx.win.hybrid.blazor - Creates a hybrid desktop (WinForms) application with a BlazorWebView-powered form and DevExpress themes/styles. The application supports Dependency Injection (DI) and integrates the DevExpress Blazor Data Grid control (requires a subscription that includes Blazor UI components: https://www.devexpress.com/buy/net/).
• JavaScript Hybrid WinForms Application: dx.win.hybrid.js - Creates a hybrid desktop (WinForms) application with a WebView2-powered form and DevExpress themes/styles. The application supports Dependency Injection (DI) and integrates the DevExtreme JavaScript (JS) HTML Editor (requires a subscription that includes DevExtreme: https://www.devexpress.com/buy/js/).
• HTML Hybrid WinForms Application: dx.win.hybrid.html - Creates a hybrid desktop (WinForms) application with a list and detail forms powered by the DevExpress HTML & CSS engine and reusable UI Templates. The rendering and templating engines allow you to make advanced UI customizations in HTML format, and customize the appearance of UI elements using CSS styles (size, padding, and layout options).
• OData-based Application: dx.win.odata - Creates a desktop (WinForms) application with a secure data layer powered by ASP.NET Core OData, EF Core, and XAF's Backend Web API Service (requires the Universal subscription: https://www.devexpress.com/buy/net/). With this additional layer of protection (authentication, authorization, and encryption), desktop UI clients cannot access database connection information or modify database tables directly.
• MVVM Application: dx.win.mvvm - Creates a desktop (WinForms) application with a separate presentation layer, entity model, and business logic. The application supports Dependency Injection (DI), Model-View-ViewModel (MVVM), and Repository architectural patterns. MVVM integration is powered by the DevExpress or Microsoft (CommunityToolkit.Mvvm) application framework.
• Shared WinForms & .NET MAUI Application: dx.win.maui - Creates both desktop (WinForms) and mobile (.NET MAUI for iOS/Android) applications with a shared presentation and data layer(entity model, business logic, and data service). The application supports Dependency Injection (DI) and Model-View-ViewModel (MVVM) architectural patterns.

Navigation & Document Layout

• Tabbed MDI Application: dx.win.mdi - Creates a desktop (WinForms) application with a Tabbed MDI. The application is based on the TabForm, which lets you incorporate tabs and custom buttons into or below the form title bar. At runtime, end users have the ability to drag tabs from the main form to create separate forms.
• Modular Application: dx.win.modular - Creates a desktop (WinForms) application with one form that represents a single module of a standard three-module application (navigation screen, collection browser screen, and single entity editor screen). Any module can be designed differently depending on the selected UI type. After the project has been created, you can add missing application modules by right-clicking your project and selecting "Add DevExpress Item...".
• Tile Application: dx.win.tileui.navigation - Creates a desktop (WinForms) application with a tile-based UI that features a hub page, a section page, and an item detail page. The application is powered by the Application UI Manager component with a two-level object hierarchy. You can add more pages and implement custom navigation.
• Wizard Application: dx.win.tileui.wizard - Creates a desktop (WinForms) application with a tile-based UI and a wizard control.

How to Install the Package

To download and install the package, run the following command in the Command Prompt or the Terminal Window:

dotnet new install DevExpress.Win.ProjectTemplates

How to Create a Project

Once the package is installed, included project templates appear in the New Project wizard in your IDE. Use the "DevExpress" keyword to find all installed templates.

To create a new project in the CLI, execute the dotnet new <template> command. For example:

dotnet new dx.win --help
dotnet new dx.win -n MyProjectName

To ensure that your project can access the required DevExpress NuGet packages, run the DevExpress Unified Component Installer or register the online DevExpress NuGet Feed in your IDE / CLI (if you have not done so yet). For additional information, review the following:

• Choose Between Offline and Online DevExpress NuGet Feeds | Start a 30-Day Trial Period
• Install NuGet Packages in Visual Studio, VS Code, and Rider | Install NuGet Packages with Command Line Interface (CLI) Tools

NOTE: Currently, the rich design-time functionality for DevExpress UI components (designers, project wizards, etc.) is only available in the Visual Studio IDE for Windows and requires the DevExpress Unified Component Installer. In other IDEs, standard design-time support for UI platforms may not be available.

How to Get Started

To get started with DevExpress WinForms components, refer to the following help topic WinForms Get Started.