ComponentOne 利用ガイド
コンポーネントをプロジェクトに組み込む
プロジェクト作成ガイド > コンポーネントをプロジェクトに組み込む

本製品のコンポーネントは NuGet パッケージ形式て提供されており、NuGet パッケージをプロジェクトへインストールすることで、プロジェクト上でそれぞれのコンポーネントが利用できるようになります。

このトピックでは、本製品の NuGet パッケージの構成およびプロジェクトへの組み込み手順について説明します。

WebForms エディションでは NuGet パッケージが提供されていないため、この手順はスキップしてください。
 NuGet パッケージの構成

本製品の NuGet パッケージ(.nupkg)のパッケージ名およびバージョンは、一般的な NuGet パッケージの表記規則とは異なり、対象となるプラットフォームや対象バージョンなどに基づいて定義しています。

例えば、「C1.Win.FlexGrid.GroupPanel.Ja.6.0.20221.548.nupkg」(ComponentOne for WinForms 2022Jv1 に含まれる C1.Win.FlexGrid.GroupPanel.6.dll のパッケージ)の場合は、以下のような構成でパッケージ名が定義されています。

1 2 3 4 5 6 7 8 9
C1 Win FlexGrid.GroupPanel Ja 6 0 20221 548 nupkg

それぞれの構成要素が示す意味については以下をご参考ください。

  1. 製品ブランド名

    ComponentOne 製品の場合は「C1」固定です。

  2. エディションおよび対応プラットフォーム

    表記 エディションおよび対象プラットフォーム
    (表記無し) Data Services、共通コンポーネントなど (例:C1.DataCollection、C1.Zip.Ja など)
    Android Xamarin (Xamarin.Android)
    AspNetCore.Api WebAPI (ASP.NET Core)
    AspNetCore.Mvc ASP.NET MVC (ASP.NET Core)
    Blazor Blazor
    iOS Xamarin (Xamarin.iOS)
    Web.Api WebAPI (ASP.NET)
    Web.Mvc ASP.NET MVC (ASP.NET)
    Win WinForms
    WinUI WinUI
    WPF WPF (.NET 6+)
    Xaml.WPF WPF (.NET Framework)
  3. アセンブリあるいはコンポーネントの名称

  4. パッケージの対応言語

    日本語版は「ja」固定です。英語版、あるいは日本語を含む多言語対応版は、表記無しとなります。

  5. 対応するプラットフォームのメジャーバージョン

    対象プラットフォームによって意味が異なります。

    パッケージの種類 表記の意味
    ASP.NET Core 用パッケージ
    • .NET Framework 向けに構築されているパッケージの場合は、対応する .NET Framework のメジャーバージョンを示します。この部分の表記が「4」の場合、.NET Framework 4.x プラットフォームに対応しています。
    • ASP.NET Core 6+ 向けに構築されているパッケージの場合は、対応する ASP.NET Core のメジャーバージョンを示します。この部分の表記が「8」の場合、ASP.NET Core 6 から ASP.NET Core 8 までのいずれかのプラットフォームに対応しています。
    .NET Standard 用パッケージ
    • 対応する .NET Stsandard のメジャーバージョンを示します。この部分の表記が「2」の場合は、.NET Standard 2 をサポートするプラットフォーム対応しています。
    上記以外のパッケージ
    • .NET Framework 向けに構築されているパッケージの場合は、対応する .NET Framework のメジャーバージョンを示します。この部分の表記が「4」の場合、.NET Framework 4.x プラットフォームに対応しています。
    • .NET 6+ 向けに構築されているパッケージの場合は、対応する .NET のメジャーバージョンを示します。この部分の表記が「8」の場合、.NET 6 から .NET 8 までのいずれかのプラットフォームに対応しています。
    • 一部のコンポーネントでは、.NET Framework と .NET 6+ の両方のプラットフォームに対応した NuGet パッケージとして提供されています。この場合、パッケージのメジャーバージョンは対応する .NET 6+ のメジャーバージョンを示しますが、.NET Framework をターゲットとするプロジェクトからも利用できます。
  6. 対応するプラットフォームのマイナーバージョン

    2023Jv3 以降の一部の NuGet パッケージでは、複数のターゲットフレームワークをサポートしています。NuGet パッケージのバージョンが「4.8」から始まる場合、.NET Framework の 4.6.2 でビルドしたアセンブリと 4.8 でビルドしたアセンブリが含まれており、プロジェクトのターゲットフレームワークによっていずれかのアセンブリが参照されます。

    Nuget パッケージがどのターゲットフレームワークで利用できるかは、nuget.org サイト上のそれぞれの NuGet パッケージのページにてご確認いただけます。対象となるパッケージのページに移動し、「Frameworks」タブを開くと、パッケージで定義されているターゲットフレームワーク(濃い色)と、追加で利用可能なターゲットフレームワーク(薄い色)が示されます。

    以下の例では、C1.Win.DataFilter.Ja パッケージの 8.0.20233.631 バージョンが .NET Framework 4.6.2~4.8.1 および .NET 6~8 のいずれかで利用できることを示しています。

  7. このパッケージの提供を開始したリリースバージョン

    例えばこの表記が「20213」の場合は、このバージョンのパッケージが 2021Jv3 から提供が開始されたことを意味します。

  8. 本製品のビルド番号

    同一のリリースバージョンでアップデートがあった場合は、この番号が更新されます。

  9. NuGet パッケージファイルの拡張子(nupkg 固定です)

 NuGet パッケージのインストール

NuGet パッケージをプロジェクトにインストールするには、以下の手順に従ってください。

  1. ソリューションエクスプローラーで、プロジェクトのコンテキストメニューから [NuGet パッケージの管理] を選択し、「NuGet パッケージマネージャー」を開きます。

  2. 画面右上にある「パッケージソース」を「nuget.org」(もしくは手動で追加したパッケージソース)に設定します。次に、参照タブに切り替え、一覧内から対象のパッケージを選択します(画像は FlexGrid for WinForms の .NET Framework 4.8 用 NuGet パッケージの例を示しています)。

    • インストールする NuGet パッケージの ID を検索ボックスに入力すると、一覧に表示されるパッケージが絞り込まれ、対象のパッケージが探しやすくなります。
    • 選択したパッケージが、対象となるプロジェクトのプラットフォーム向け(.NET Framework/.NET 6+)のものであるか、日本語版のパッケージであるかをご確認ください。
  3. 使用するバージョンを選択し、インストールボタンをクリックします。依存関係にある NuGet パッケージが検出され、それらを含めたライセンスの同意画面が表示されます。利用条件など問題が無ければ、同意して続行してください。

これにより、プロジェクトに NuGet パッケージがインストールされ、コンポーネントへの参照が追加されます。

 NuGet パッケージソースを追加する

本製品の NuGet パッケージファイルは、nuget.org にて公開されているほか、本製品のインストール先フォルダにある「Packages」フォルダに保存されています。

インターネットに接続されていない環境では、それら NuGet パッケージファイルを任意のフォルダにコピーし、下記の手順に従って NuGet パッケージソースを追加してから、本製品の NuGet パッケージをインストールしてください。

  1. Visual Studio の[ツール]メニューから、[NuGet パッケージマネージャー]→[パッケージマネージャー設定]を選択します。[オプション]ダイアログボックスが表示されます。

  2. 左ペインで、[パッケージソース]を選択します。

  3. 右上隅にある [+] ボタンをクリックします。[利用可能なパッケージソース]に新しいソースが追加されます。

  4. 新しいパッケージソースの名前を設定します。

  5. [ソース]フィールドの横にある省略符ボタンをクリックして、NuGet パッケージファイルが保存されたフォルダを参照します。

  6. フォルダを選択したら、[更新]ボタンをクリックし、最後に[OK]をクリックします。

これにより、任意のフォルダをパッケージソースとして利用できるようになります。「NuGet パッケージのインストール」の手順2にてこのパッケージソースを指定すると、このフォルダ内にある本製品の NuGet パッケージが参照できるようになります。

関連トピック