チュートリアル - C#/WinRT コンポーネントを作成し、C++/WinRT から使用する

[アーティクル]
06/02/2023

C#/WinRT を使うと、.NET を使用する開発者は、クラスライブラリプロジェクトを使って C# で独自の Windows ランタイムコンポーネントを作成できます。作成されたコンポーネントは、ネイティブデスクトップアプリケーションでパッケージ参照として、またはいくつかの変更を加えたプロジェクト参照として使用することができます。

このチュートリアルでは、C#/WinRT を使用して単純な Windows ランタイムコンポーネントを作成し、コンポーネントを NuGet パッケージとして配布し、C++/WinRT コンソールアプリケーションからコンポーネントを使用する方法について説明します。この記事のコードを提供する完全なサンプルについては、C#/WinRT 作成のサンプルを参照してください。作成について詳しくは、コンポーネントの作成を参照してください。

Windows App SDK アプリケーションで特に使用する C#/WinRT での WinUI コントロールの作成に関するチュートリアルについては、「チュートリアル: WinUI 3 コントロールを使用して C# コンポーネントを作成し、C++ Windows App SDK アプリから使用する」を参照してください

前提条件

このチュートリアルでは、次のツールとコンポーネントが必要です。

Visual Studio 2022
.NET 6.0 SDK 以降
C++/WinRT VSIX for C++/WinRT プロジェクトテンプレート

C#/WinRT を使用して単純な Windows ランタイムコンポーネントを作成する

まず、Visual Studio で新しいプロジェクトを作成します。 [クラスライブラリ] プロジェクトテンプレートを選択し、そのテンプレートに AuthoringDemo という名前を付けます。プロジェクトに次の追加と変更を加える必要があります。

AuthoringDemo.csproj ファイル内の TargetFramework を更新し、以下の要素を PropertyGroup に追加します。
```
<PropertyGroup>
    <TargetFramework>net6.0-windows10.0.19041.0</TargetFramework>
    <Platforms>x64</Platforms>
</PropertyGroup>
```
Windows ランタイムの種類にアクセスするには、TFM で特定の Windows SDK バージョンを設定する必要があります。サポートされているバージョンの詳細については、「.NET 6 以降: TFM オプションを使用する」を参照してください。
Microsoft.Windows.CsWinRT NuGet パッケージをプロジェクトにインストールします。

a. ソリューションエクスプローラーで、プロジェクトノードを右クリックし、[NuGet パッケージの管理] を選択します。

b. Microsoft.Windows.CsWinRT NuGet パッケージを検索し、最新バージョンをインストールします。このチュートリアルでは、C#/WinRT バージョン 1.4.1 を使用します。
CsWinRTComponent プロパティを設定する新しい PropertyGroup 要素を追加します。これにより、プロジェクトをビルドするときに .winmd ファイルが生成されるように、プロジェクトが Windows ランタイムコンポーネントであることが指定されます。
```
<PropertyGroup>   
    <CsWinRTComponent>true</CsWinRTComponent>
</PropertyGroup>
```
C#/WinRT プロジェクトのプロパティの完全な一覧は、C#/WinRT NuGet のドキュメントで参照してください。
ライブラリ .cs クラスファイルを使用して、ランタイムクラスを作成できます。 Class1.cs ファイルを右クリックし、Example.cs に名前を変更します。このファイルに次のコードを追加します。これにより、パブリックプロパティとメソッドがランタイムクラスに追加されます。ランタイムコンポーネントで公開するすべてのクラスは、必ず public としてマークしてください。
```
namespace AuthoringDemo
{
    public sealed class Example
    {
        public int SampleProperty { get; set; }

        public static string SayHello()
        {
            return "Hello from your C# WinRT component";
        }
    }
}
```
これで、プロジェクトをビルドして、コンポーネントの .winmd ファイルを生成できるようになりました。 ソリューションエクスプローラーでプロジェクトを右クリックし、[ビルド] をクリックします。ビルド出力フォルダーに生成された AuthoringDemo.winmd ファイルが表示されます。

コンポーネントの NuGet パッケージを生成する

ほとんどの開発者は、Windows ランタイムコンポーネントを NuGet パッケージとして配布して共有したいと考えます。もう 1 つのオプションは、コンポーネントをプロジェクト参照として使用することです。次の手順では、AuthoringDemo コンポーネントをパッケージ化する方法を示します。パッケージを生成すると、C#/WinRT によって、ネイティブアプリケーションから使用できるように、パッケージ内のコンポーネントとホスティングアセンブリが構成されます。

NuGet パッケージを生成するには、いくつかの方法があります。

プロジェクトをビルドするたびに NuGet パッケージを生成する場合は、次のプロパティを AuthoringDemo プロジェクトファイルに追加してから、プロジェクトをリビルドします。
```
<PropertyGroup>
    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
</PropertyGroup>
```
代わりに、ソリューションエクスプローラーで AuthoringDemo プロジェクトを右クリックして [パック] を選択することにより、NuGet パッケージを生成することもできます。

パッケージをビルドすると、[ビルド] ウィンドウに、NuGet パッケージ AuthoringDemo.1.0.0.nupkg が正常に作成されたことが示されます。 .NET CLI を使用した NuGet パッケージのプロパティの詳細については、「dotnet CLI を使用してパッケージを作成する」を参照してください。

C++/WinRT アプリからコンポーネントを使用する

C#/WinRT で作成された Windows ランタイムコンポーネントは、任意の Windows ランタイム (WinRT) 互換言語から使用できます。次の手順では、C++/WinRT コンソールアプリケーションで上記の作成済みコンポーネントを呼び出す方法を示します。

Note

C#/.NET アプリからの C#/WinRT コンポーネントの使用は、パッケージ参照とプロジェクト参照の両方でサポートされています。このシナリオは、通常の C# クラスライブラリを使用することと同じであり、ほとんどの場合、WinRT のアクティブ化には関係しません。 C#/WinRT 1.3.5 以降では、C# 使用者向けのプロジェクト参照には .NET 6 が必要です。

新しい C++/WinRT コンソールアプリケーションのプロジェクトをソリューションに追加します。このプロジェクトを別のソリューションの一部にすることもできます。

a. ソリューションエクスプローラーで、ソリューションノードを右クリックし、[追加] - > [新しいプロジェクト] をクリックします。

b. [新しいプロジェクトの追加] ダイアログボックスで、C++/WinRT コンソールアプリケーションのプロジェクトテンプレートを検索します。テンプレートを選択して [次へ] をクリックします。

c. 新しいプロジェクトに CppConsoleApp という名前を付け、[作成] をクリックします。
NuGet パッケージまたはプロジェクト参照として、AuthoringDemo コンポーネントへの参照を追加します。
- オプション 1 (パッケージ参照):
  
  a. CppConsoleApp プロジェクトを右クリックし、[NuGet パッケージの管理] を選択します。 AuthoringDemo NuGet パッケージへの参照を追加するには、パッケージソースを構成することが必要になる場合があります。これを行うには、NuGet パッケージマネージャーで [設定 アイコンをクリックし、パッケージソースを適切なパスに追加します。
  
  b. パッケージソース:の構成後、AuthoringDemo パッケージを検索して [インストール] をクリックします。
- オプション 2 (プロジェクト参照):
  
  a. CppConsoleApp プロジェクトを右クリックして、[追加] -> [参照] を選択します。 プロジェクト ノードの下で、AuthoringDemo プロジェクトへの参照を追加します。
コンポーネントをホストするには、アクティブ化可能なクラス登録用のマニフェストファイルを追加する必要があります。マネージドコンポーネントのホストの詳細については、「マネージドコンポーネントのホスト」を参照してください。

a. マニフェストファイルを追加するには、プロジェクトを再び右クリックして、[追加] -> [新しい項目] を選択します。 テキストファイルのテンプレートを検索し、CppConsoleApp.exe.manifest という名前を付けます。アクティブ化可能なクラス登録エントリを使用してランタイムクラスを指定する次の内容を貼り付けます。
```
<?xml version="1.0" encoding="utf-8"?>
<assembly manifestVersion="1.0" xmlns="urn:schemas-microsoft-com:asm.v1">
    <assemblyIdentity version="1.0.0.0" name="CppConsoleApp"/>
    <file name="WinRT.Host.dll">
        <activatableClass
            name="AuthoringDemo.Example"
            threadingModel="both"
            xmlns="urn:schemas-microsoft-com:winrt.v1" />
    </file>
</assembly>
```
パッケージ化されていないアプリには、アプリケーションマニフェストファイルが必要です。パッケージアプリの場合、アプリコンシューマーは、「チュートリアル: WinUI 3 コントロールを使用して C# コンポーネントを作成し、C++ Windows App SDK アプリケーションから使用する」で説明されているように、アクティブ化可能なクラスを Package.appxmanifest パッケージマニフェストファイルに登録する必要があります。

b. プロジェクトを配置するときに、出力にマニフェストファイルを含めるようにプロジェクトを変更します。 ソリューションエクスプローラーで CppConsoleApp.exe.manifest ファイルをクリックし、[コンテンツ] プロパティを True に設定します。次に例を示します。
プロジェクトのヘッダーファイルの下にある pch.h を開き、以下のコード行を追加して、コンポーネントが含まれるようにします。
```
#include <winrt/AuthoringDemo.h>
```

プロジェクトのソースファイルの下にある main.cpp を開き、以下の内容で置き換えます。

#include "pch.h"
#include "iostream"

using namespace winrt;
using namespace Windows::Foundation;

int main()
{
    init_apartment();

    AuthoringDemo::Example ex;
    ex.SampleProperty(42);
    std::wcout << ex.SampleProperty() << std::endl;
    std::wcout << ex.SayHello().c_str() << std::endl;
}

CppConsoleApp プロジェクトをビルドして実行します。次の出力が表示されます。

次の方法で共有

チュートリアル - C#/WinRT コンポーネントを作成し、C++/WinRT から使用する

前提条件

C#/WinRT を使用して単純な Windows ランタイムコンポーネントを作成する

コンポーネントの NuGet パッケージを生成する

C++/WinRT アプリからコンポーネントを使用する

その他のリソース

次の方法で共有

チュートリアル - C#/WinRT コンポーネントを作成し、C++/WinRT から使用する

前提条件

C#/WinRT を使用して単純な Windows ランタイム コンポーネントを作成する

コンポーネントの NuGet パッケージを生成する

C++/WinRT アプリからコンポーネントを使用する

関連トピック

その他のリソース

C#/WinRT を使用して単純な Windows ランタイムコンポーネントを作成する