Procédure pas à pas : créer un composant C# avec des contrôles WinUI 3 et l’utiliser à partir d’une application C++/WinRT qui utilise le Kit de développement logiciel (SDK) d’application Windows

C#/WinRT prend en charge la création de composants Windows Runtime, notamment des types personnalisés WinUI et des contrôles personnalisés. Ces composants peuvent être consommés à partir d’applications C# ou C++/WinRT qui utilisent le Kit de développement logiciel (SDK) d’application Windows. Nous vous recommandons d’utiliser C#/WinRT v1.6.4 ou version ultérieure pour créer des composants d’exécution avec la prise en charge de l’empaquetage NuGet.

Pour plus d’informations sur les scénarios pris en charge, reportez-vous à composants C#/WinRT dans le dépôt GitHub C#/WinRT.

Cette procédure pas à pas montre comment créer un composant C# avec un contrôle WinUI 3 personnalisé et comment utiliser ce composant à partir d’une application C++/WinRT à l’aide des modèles de projet du SDK d’application Windows.

Conditions préalables

Cette procédure pas à pas nécessite les outils et composants suivants :

Visual Studio 2022
SDK .NET 6.0
VSIX du Kit de développement logiciel (SDK) d’application Windows (1.1 à partir du canal stable)

Créer votre composant C#/WinRT à l’aide du Kit de développement logiciel (SDK) d’application Windows

Créez un projet de bibliothèque C# à l’aide du modèle Bibliothèque de classes (WinUI 3 in Desktop) fourni par le Kit de développement logiciel (SDK) d’application Windows. Pour cette procédure pas à pas, nous avons nommé le projet de bibliothèque WinUIComponentCs et la solution AuthoringWinUI.

Laissez la case "Placer la solution et le projet dans le même répertoire" non cochée (sinon, le dossier de l'application C++ de la section précédente finira par interférer avec le projet de bibliothèque C#).
Supprimez le Class1.cs fichier inclus par défaut.
Installez le dernier package NuGet Microsoft.Windows.CsWinRT dans votre projet.

i. Dans l’Explorateur de solutions, cliquez avec le bouton droit sur le nœud du projet, puis sélectionnez Gérer les packages NuGet.

ii. Recherchez le package NuGet Microsoft.Windows.CsWinRT et installez la dernière version.
Ajoutez les propriétés suivantes à votre projet de bibliothèque :
```
<PropertyGroup>   
    <CsWinRTComponent>true</CsWinRTComponent>
</PropertyGroup>
```
- La CsWinRTComponent propriété spécifie que votre projet est un composant Windows Runtime afin qu’un .winmd fichier soit généré lorsque vous générez le projet.
Ajoutez un contrôle personnalisé ou un contrôle utilisateur à votre bibliothèque. Pour ce faire, cliquez avec le bouton droit sur votre projet dans Visual Studio, cliquez sur Ajouter>un nouvel élément, puis sélectionnez WinUI dans le volet gauche. Pour cette procédure pas à pas, nous avons ajouté un nouveau contrôle utilisateur (WinUI 3) et l’avons NameReporter.xamlnommé . Le contrôle utilisateur NameReporter permet à un utilisateur d’entrer un prénom et un nom dans le contrôle TextBox approprié, puis de cliquer sur un bouton. Le contrôle affiche ensuite une boîte de message portant le nom entré par l’utilisateur.

Collez le code suivant dans le NameReporter.xaml fichier :

<UserControl
x:Class="WinUIComponentCs.NameReporter"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:local="using:WinUIComponentCs"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
mc:Ignorable="d">

    <StackPanel HorizontalAlignment="Center">
        <StackPanel.Resources>
            <Style x:Key="BasicTextStyle" TargetType="TextBlock" BasedOn="{StaticResource BodyTextBlockStyle}">
                <Setter Property="Margin" Value="10,10,10,10"/>
            </Style>
        </StackPanel.Resources>

        <TextBlock Text="Enter your name." Margin="0,0,0,10"/>
        <StackPanel Orientation="Horizontal" Margin="0,0,0,10">
            <TextBlock Style="{StaticResource BasicTextStyle}">
                First Name:
            </TextBlock>
            <TextBox Name="firstName" />
        </StackPanel>
        <StackPanel Orientation="Horizontal" Margin="0,0,0,10">
            <TextBlock Style="{StaticResource BasicTextStyle}">
                Last Name:
            </TextBlock>
            <TextBox Name="lastName" />
        </StackPanel>
        <Button Content="Submit" Click="Button_Click" Margin="0,0,0,10"/>
        <TextBlock Name="result" Style="{StaticResource BasicTextStyle}" Margin="0,0,0,10"/>
    </StackPanel>
</UserControl>

Ajoutez la méthode suivante à NameReporter.xaml.cs:

using System.Text;
...
private void Button_Click(object sender, RoutedEventArgs e)
{
    StringBuilder displayText = new StringBuilder("Hello, ");
    displayText.AppendFormat("{0} {1}.", firstName.Text, lastName.Text);
    result.Text = displayText.ToString();
}

Vous pouvez maintenant générer le projet WinUIComponentCs pour générer un .winmd fichier pour le composant.

Remarque

Vous pouvez également empaqueter le composant en tant que package NuGet pour les consommateurs d’applications finaux à référencer. Pour plus d’informations, consultez Création de composants C#/WinRT sur le dépôt GitHub C#/WinRT.

Référencer le composant à partir d’une application C++/WinRT du Kit de développement logiciel (SDK) d’application Windows App

Les étapes suivantes montrent comment utiliser le composant créé à partir de la section précédente à partir d’une application sdk d’application Windows C++/WinRT. L’utilisation d’un composant C#/WinRT à partir de C++ nécessite actuellement l’utilisation du modèle application vide, empaquetée (WinUI 3 in Desktop). Notez que les composants C# peuvent également être référencés à partir d’applications empaquetées C# sans inscriptions de classes.

La consommation à partir d’applications empaquetées qui utilisent une windows Application Packaging (WAP) distincte n’est pas prise en charge actuellement. Consultez Création de composants C#/WinRT dans le référentiel GitHub C#/WinRT pour connaître les dernières mises à jour des configurations de projet prises en charge.

Ajoutez un nouveau projet d’application Windows App SDK C++ à votre solution. Cliquez avec le bouton droit sur votre solution dans Visual Studio, puis sélectionnez Ajouter>un nouveau projet. Sélectionnez le modèle C++ application vide, empaquetée (WinUI 3 sur Bureau) fourni par le SDK d’application Windows. Pour cette procédure pas à pas, nous avons nommé l’application CppApp.
Ajoutez une référence de projet à partir de l’application C++ au composant C#. Dans Visual Studio, cliquez avec le bouton droit sur le projet C++, puis choisissez Ajouter> uneréférence, puis sélectionnez le projet WinUIComponentCs.

Remarque

L’utilisation de composants en tant que référence de package NuGet est prise en charge avec certaines limitations. À savoir, les composants avec des contrôles utilisateur personnalisés ne peuvent pas être utilisés actuellement en tant que référence de package NuGet.

Dans le fichier d’en-tête de pch.h l’application, ajoutez les lignes suivantes :

#include <winrt/WinUIComponentCs.h>
#include <winrt/WinUIComponentCs.WinUIComponentCs_XamlTypeInfo.h>

Ouvrez le fichier manifeste du package. Package.appxmanifest

Remarque

Il existe un problème connu où le Package.appxmanifest fichier n’apparaît pas dans l’Explorateur de solutions Visual Studio. Pour contourner ce problème, cliquez avec le bouton droit sur votre projet C++, sélectionnez Décharger le projet, puis double-cliquez sur le projet pour ouvrir le CppApp.vcxproj fichier. Ajoutez l’entrée suivante au fichier projet, puis rechargez le projet :
```
<ItemGroup>
    <AppxManifest Include="Package.appxmanifest">
    <SubType>Designer</SubType>
    </AppxManifest>
</ItemGroup>
```
Dans Package.appxmanifest, ajoutez les inscriptions de classes activables suivantes. Vous aurez également besoin d’une entrée supplémentaire ActivatableClass pour la classe WinUIComponentCs.WinUIComponentCs_XamlTypeInfo.XamlMetaDataProvider afin d’activer les types WinUI. Cliquez avec le bouton droit sur le Package.appxmanifest fichier et sélectionnez Ouvrir avec>XML (Éditeur de texte) pour modifier le fichier.
```

<Extensions>
    <Extension Category="windows.activatableClass.inProcessServer">
        <InProcessServer>
            <Path>WinRT.Host.dll</Path>
            <ActivatableClass ActivatableClassId="WinUIComponentCs.NameReporter" ThreadingModel="both" />
            <ActivatableClass ActivatableClassId="WinUIComponentCs.WinUIComponentCs_XamlTypeInfo.XamlMetaDataProvider" ThreadingModel="both" />
        </InProcessServer>
    </Extension>
</Extensions>
```
Ouvrez le fichier MainWindow.xaml .

i. Ajoutez une référence à l’espace de noms du composant en haut du fichier.
```
xmlns:custom="using:WinUIComponentCs"
```
ii. Ajoutez le contrôle utilisateur au code XAML existant.
```
<StackPanel>
    ...
    <custom:NameReporter/>
</StackPanel>
```
Définissez CppApp comme projet de démarrage—cliquez avec le bouton droit sur CppApp, puis sélectionnez Définir comme projet de démarrage. Définissez la configuration de la solution sur x86. Avant de compiler, vous devrez peut-être également recibler votre solution pour utiliser les outils de build de Visual Studio 2022. Cliquez avec le bouton droit sur la solution, sélectionnez recibler la solution, puis mettez à jour l'ensemble d'outils de la plateforme vers v143.
Générez et exécutez l'application pour voir le contrôle personnalisé NameReporter.

Problèmes connus

L’utilisation d’un composant C# en tant que référence de projet nécessite que PublishReadyToRun soit défini sur False. Pour plus d’informations , consultez le problème Github #1151 .
L’utilisation d’un composant C# conçu pour AnyCPU C++ est prise en charge uniquement à partir d’applications x86 actuellement. x64 et Arm64 les applications entraînent une erreur d’exécution similaire à : %1 n’est pas une application Win32 valide. Pour plus d’informations , consultez le problème Github #1151 .

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2025-08-13