4. .NETのビルドと実行手順

4.1. .NET 8(C#)サンプルコードのビルドと発行方法

ここでは.NET 8を用いてC#サンプルコードをビルド、実行する手順について説明します。

{インストールフォルダ}\samples\dotnet

4.1.1. . NET SDKのインストール

.NET 8の開発には.NET SDKのインストールが必要です。
以下のwebページにアクセスし、「SDK 8.0.xx」の項にある「Windows」の「x64」インストーラ－をダウンロードしてセットアップします。

.NET8.0のダウンロード
https://dotnet.microsoft.com/ja-jp/download/dotnet/8.0

Please enter alt text.

4.1.2. プロジェクトの新規作成とPDF Tool APIモジュールファイルの参照追加

(1) Visual Studio 2022を起動し、「新しいプロジェクトの作成」を選択します。

Please enter alt text.

(2) 「新しいプロジェクトを作成」において、C#の「コンソールアプリ」を選択し「次へ」ボタンをクリックします。

Please enter alt text.

(3) 「プロジェクト名」、「場所」を設定し「次へ」ボタンをクリックします。

Please enter alt text.

(4) 「フレームワーク」に「.NET 8.0（長期的なサポート）」が選択されているのを確認し「作成」ボタンをクリックするとプロジェクトが開きます。

Please enter alt text.

(5) 「プロジェクト」メニューの「既存の項目の追加...」を選択するとファイル選択ダイアログが表示されます。

Please enter alt text.

(6) サンプルのcsファイルをひとつ選択します。C#用サンプルコードはプロジェクトのソースファイルとして追加されます。
プロジェクト生成時に作成されるcsファイルは不要です。プロジェクトから削除してください。

(7) 「ビルド」メニューの「構成マネージャー...」を選択します。

Please enter alt text.

(8) 「アクティブソリューション構成」と「アクティブソリューションプラットフォーム」を設定します。プラットフォームは「x64」を選択して新規作成します。

Please enter alt text.

Please enter alt text.

(9) 「プロジェクト」メニューの「プロジェクト参照の追加...」を選択すると、「参照マネージャー」ダイアログが開きます。

Please enter alt text.

(10) 「参照」タブを開き、ダイアログ右下の「参照...」ボタンをクリックします。

Please enter alt text.

(11) ファイル選択ダイアログが開きます。インストールフォルダまたは任意の場所に配置したPDF Tool APIモジュールファイルの「PdfTkNet8_80.dll」を選択します。
「OK」ボタンをクリックして「参照マネージャー」ダイアログを閉じます。

Please enter alt text.

(12) 参照したDLLは、ソリューションエクスプローラーの「依存関係」‐「アセンブリ」で確認できます。

Please enter alt text.

4.1.3. ビルドの設定とビルド

Windows用のビルドを行います。

(1) ソリューション エクスプローラーでプロジェクトを選択した上で「プロジェクト」メニューを開き、「（プロジェクト名）のプロパティ」を選択します。

Please enter alt text.

(2) プロパティのウィンドウが開きます。左側の「ビルド」タブを開き「出力」を選択します。

(3) 「基本出力パス」の欄にPdfTkNet8_80.dll、PdfTkNet8.dllを含むPDF Tool APIのdllが存在するフォルダを指定します。

Please enter alt text.

(4) 「ビルド」メニューの「（プロジェクト名）のビルド」をクリックすると、ビルドが開始されます。
（ソリューション内のプロジェクトが１つだった場合は「ソリューションのビルド」でもビルドを実行できます。）

Please enter alt text.

(5) ビルドされたexeを実行するには、exeとともに作成される、「exeと同名のdllファイル」と「.runtimeconfig.json」が必要です。

4.1.4. デバッグビルドの設定とデバッグ実行

Windows用のデバッグビルドを行います。

(1) 「プロジェクト」メニューの「（プロジェクト名）のプロパティ」を選択します。

（図のプロジェクト名はConsoleAppCSです。）

Please enter alt text.

(2) 左側の「デバッグ」タグを開き「デバッグ起動プロファイルUIを開く」をクリックして「プロファイルの起動」ダイアログを開きます。

Please enter alt text.

(3) 「プロファイルの起動」ダイアログの必要事項を指定します。

  • 「作業ディレクトリ」の欄にPdfTkNet8_80.dll、PdfTkNet8.dllを含むPDF Tool APIのdllのあるフォルダを指定します。
  • 必要に応じて、「コマンドライン引数」を指定します。

Please enter alt text.

(4) 「デバッグ」メニューの「デバッグの開始」をクリックすると、デバッグ実行できます。

Please enter alt text.

4.1.5. アプリケーションの発行

Windows用、Linux用それぞれのアプリケーションファイルを発行します。

(1) プロジェクトを右クリックし、開いたメニュー上の「発行...」を選択します。

Please enter alt text.

(2) 「公開」ダイアログが開くので公開先を指定します。
ここでは、ローカルフォルダーにアプリケーションを作成しますので、「フォルダー」を選択し、右下の「次へ」ボタンをクリックします。

Please enter alt text.

(3) 次の画面でも「フォルダー」を選択し右下の「次へ」ボタンをクリックします。

Please enter alt text.

(4) 「フォルダーの場所」を指定し、「完了」を押します。

Please enter alt text.

(5) 「実行プロファイル作成の進行状況」が表示された場合は、「閉じる」ボタンをクリックします。

(6) 中央下にある「すべての設定を表示」をクリックします。

Please enter alt text.

(7) 「プロファイル設定」ダイアログが開くので各項目を設定します。

  • ターゲットフレームワーク：「net8.0」であることを確認
  • 配置モード：以下２つから選択　違いは以下の通りです。
    • 「自己完結」
      発行されるアプリケーションファイルには、ターゲットフレームワークのランタイムライブラリーが含まれます。このため、アプリケーションファイルを実行する環境に、ターゲットフレームワークの.NETランタイムライブラリーをインストールする必要はありません。ただし、ファイルサイズは大きくなります。
    • 「フレームワーク依存」
      発行されるアプリケーションファイルには、ターゲットフレームワークのランタイムライブラリーは含まれません。アプリケーションファイルを実行する環境には、ターゲットフレームワークの.NETランタイムライブラリーをインストールしてください。
  • ターゲットランタイム：「win-x64 (Windows 64bit)」「linux-x64 (Linux 64bit)」のいずれかを選択
    PDF Tool APIは、arm、osx（Mac OS X）には対応していません。

Please enter alt text.

(8) 「ファイルの公開オプション」を開きます。「単一ファイルの作成」にチェックを入れます。

Please enter alt text.

(9) 「発行」ボタンをクリックすると、「（日時）に公開が成功しました。」と表示され発行が完了します。

Please enter alt text.

(10) 「フォルダーを開く」または「ターゲットの場所」をクリックすると「フォルダーの場所」に指定したフォルダが開き、発行されたファイルを確認できます。

Please enter alt text.

(11) ターゲットランタイムごとの各実行ファイルは以下の通りです。

  • 「ターゲットランタイム」が「win-x64」の場合、発行された拡張子「.exe」ファイルが実行ファイルです。.exeファイルとPDF Tool APIのモジュールファイルを同じフォルダに配置することで実行可能です。
  • 「ターゲットランタイム」が「linux-x64」の場合、発行された拡張子のないファイルが実行ファイルです。

4.1.6. .NET 8で発行された実行ファイルの実行方法について

ここでは、『4.1 .NET 8(C#)サンプルコードのビルドと発行方法』で発行されたアプリケーションファイルを、開発環境とは異なるコンピュータ上で実行する方法を説明します。

Windowsでの実行について

(1) アプリケーションファイルの発行時に「配置モード」を「フレームワーク依存」で指定した場合、ターゲットフレームワークの.NETランタイムライブラリーをインストールしてください。（※1）

(2) PDF Tool APIのモジュールファイルを配置します。（※2）

(3) 発行されたアプリケーションファイルを、PDF Tool APIのモジュールファイルと同じ場所に配置します。あるいは、環境変数「PATH」に、PDF Tool APIのモジュールファイルが存在するフォルダパスを設定します。

(4) PDF Tool APIのライセンスファイルを配置します。「PdfTk80.dll」と同じ場所に配置する、または、ライセンスファイルを配置したフォルダパスを環境変数「PTL80_LIC_PATH」に設定してください。（※3）

  1. 必要に応じ、フォント構築ファイルの設定を行ってください。（※4）
  2. 必要に応じ、カラープロファイル、フォント構築ファイルを利用するための環境変数を設定します。（※3）
  3. コマンドプロンプトを起動しアプリケーションファイルが存在するフォルダパスをカレントディレクトリにして実行します。必要に応じて、コマンド入力時に引数を指定してください。

（※1）
.NET8ランタイム　インストーラの入手先

https://dotnet.microsoft.com/ja-jp/download/dotnet/8.0

「.NET Runtime 8.0.xx」の項にある「Windows」の「x64」インストーラ－をダウンロードしてセットアップしてくだい。
なお、ランタイム単体のインストーラーではなく、ランタイムが含まれるSDKのインストーラーで代用することも可能です。

Please enter alt text.

（※2）
実行環境にモジュールファイルを配置する場合、PDF Tool API付属のインストーラは使用しないでください。

（※3）
『Windows開発環境における環境変数のまとめ』をご参照くさい。

（※4）
『フォントの準備』をご参照ください。

Linuxでの実行について

  1. 「配置モード」が「フレームワーク依存」であるアプリケーションファイルの場合、あらかじめ、ターゲットフレームワークの.NETランタイムライブラリーをインストールしてください。（※1）
  2. PDF Tool APIのモジュールファイルをセットアップします。（※2）
  3. アプリケーションファイルを任意の場所に配置します。
  4. PDF Tool APIのライセンスファイルを配置します。
  5. テキスト透かしやテキスト追加など文字を扱う処理を行う場合、「font-config.xml」（フォント構築ファイル）にてフォントディレクトリの設定を行います。
    Linuxでは、フォント構築ファイルは必須です。
  6. モジュールファイル、ライセンスファイル、カラープロファイル、フォント構築ファイル、を利用するための環境変数を設定します。（※3）
  7. 「端末」を起動し、アプリケーションファイルがあるディレクトリをカレントにして実行します。必要に応じて、コマンド入力時に引数を指定してください。（※4a）（※4b）

（※1）
Linux版サンプル実行手順の『.NET ランタイムのセットアップ』をご参照ください。

（※2）
実行環境にモジュールファイルをセットアップする場合、PDF Tool API付属のインストーラは使用しないでください。

（※3）
環境変数と設定値の例
LD_LIBRARY_PATH={PDF Tool APIモジュールファイルのディレクトリ} :${LD_LIBRARY_PATH}
PTL80_LIC_PATH={ライセンスファイルのディレクトリ}
PTL80_FONT_CONFIGFILE={ font-config.xmlのフルパス}
PTL80_ICCPROFILE_PATH={「sRGB2014.icc」「JapanColor2001Coated.icc」の配置ディレクトリ}

（※4a）
「配置モード」が「自己完結」設定のアプリケーションファイルを実行する場合

「dotnet」コマンドは不要です。アプリケーションファイルに.NET8ランタイムライブラリーが含まれています。

必要コマンド：

./{アプリケーションファイル名} {オプション}

（※4b）
「配置モード」が「フレームワーク」設定のアプリケーションファイルを実行する場合

「dotnet」コマンドを付けて実行します。

必要コマンド：

dotnet {アプリケーションファイル名} {オプション}

4.2. .NET Framework(C#)サンプルコードのビルドと実行方法

ここでは、.NET Frameworkを用いてC#サンプルコードをビルド、実行する手順について説明します。

{インストールフォルダ}\samples\dotnet

4.2.1. プロジェクトの新規作成とPDF Tool APIモジュールファイルの参照追加

(1) Visual Studio 2022を起動し、「新しいプロジェクトの作成」を選択します。

Please enter alt text.

(2) 「新しいプロジェクトを作成」において、C#の「コンソールアプリ(.NET Framework)」を選択し「次へ」ボタンをクリックします。

Please enter alt text.

(3) 「プロジェクト名」、「場所」を設定します。
さらに「フレームワーク」で.NET Framework 4.8以降が選択されているのを確認します。
「作成」ボタンをクリックするとプロジェクトが開きます。

Please enter alt text.

(4) 「プロジェクト」メニューの「既存の項目の追加...」を選択するとファイル選択ダイアログが表示されます。

Please enter alt text.

(5) サンプルのcsファイルをひとつ選択します。C#用サンプルコードはプロジェクトのソースファイルとして追加されます。
プロジェクト生成時に作成されるcsファイルは不要です。プロジェクトから削除してください。

(6) 「ビルド」メニューの「構成マネージャー...」を選択します。

Please enter alt text.

(7) 「アクティブソリューション構成」と「アクティブソリューションプラットフォーム」を設定します。プラットフォームは「x64」を選択して新規作成します。

Please enter alt text.

Please enter alt text.

(8) 「プロジェクト」メニューの「参照の追加...」を選択すると、「参照マネージャー」ダイアログが開きます。

Please enter alt text.

(9) 「参照」タブを開き、ダイアログ右下の「参照...」ボタンをクリックします。

Please enter alt text.

(10) ファイル選択ダイアログが開きます。インストールフォルダなどに配置されたPDF Tool APIモジュールファイルの「PdfTkNet80.dll」を選択します。
「OK」ボタンをクリックして「参照マネージャー」ダイアログを閉じます。

Please enter alt text.

(11) 参照したDLLは、ソリューションエクスプローラーの「参照」タブを開くと確認できます。

Please enter alt text.

4.2.2. ビルドの設定とビルド

(1) 「ビルド」メニューの「（プロジェクト名）のビルド」をクリックすると、ビルドが開始されます。
（ソリューション内のプロジェクトが１つだった場合は「ソリューションのビルド」でもビルドを実行できます。）

Please enter alt text.

(2) ビルドが完了すると、出力ウィンドウにexeファイルの出力先が表示されます。

4.2.3. デバッグビルドの設定とデバッグ実行

Windows用のデバッグビルドを行います。

(1) 「プロジェクト」メニューの「（プロジェクト名）のプロパティ」を選択します。

（図のプロジェクト名はConsoleAppDotNetFWです。）

Please enter alt text.

(2) 指定したい引数がある場合は、左側の「デバッグ」タグを開き「開始オプション」―「コマンド引数」に引数を指定します。

Please enter alt text.

(3) 「デバッグ」メニューの「デバッグの開始」をクリックします。
コンソールが新規に開き、デバッグが実行されます。

Please enter alt text.

4.2.4. .NET Frameworkでビルドされたexeファイルの実行

ビルドされたexeファイルはダブルクリックやコンソールなどで実行可能です。
.NET FrameworkでビルドされたexeファイルはWindowsでのみ実行可能です。実行時には、以下の条件が必要です。

  • 実行環境にモジュールファイルがあること（※1）（※2）
  • 同じ階層に[PdfTkNet80.dll]が配置されていること

※1：
必要なモジュールファイルに関する詳細はライブラリ版マニュアルの『モジュールファイルについて』をご参照ください。

※2：
PDF Tool APIのインストーラを実行した際にダイアログで指定していた場合、環境変数「PATH」にモジュールファイルへのパスが指定されています。

4.3. .NET 8サンプルコード実行ソリューションの利用方法

PDF Tool APIのサンプルには、.NET 8の各種サンプルコードをビルドするためのソリューションが同梱されています。本項ではその利用法を説明します。

{インストールフォルダ}\samples\samples-net8.sln

4.3.1. .NET 8サンプルコード実行用ソリューションの読み込み

(1) Visual Studio 2022を起動し、「プロジェクトやソリューションを開く」を選択します。

Please enter alt text.

(2) 配置フォルダにある「samples-net8.sln」を開きます。

(3) 以下の手順でサンプルコード実行の説明書を開きます。

ソリューション エクスプローラーからdocフォルダを選択し、内部にある「ReadMe_samples-net8.txt」を開きます。
各サンプルの実行内容や実行に必要なモジュールファイルに関しては「ReadMe_samples-net8.txt」をご参照ください。

Please enter alt text.

4.3.2. ビルドの設定とビルド

(1) 「ビルド」メニューの「構成マネージャー...」を選択します。

Please enter alt text.

(2) 「アクティブソリューション構成」は「Release」を、プラットフォームは「x64」を選択して「OK」ボタンを押して構成マネジャー画面を閉じます。

Please enter alt text.

(3) 実行したいサンプルのプロジェクトを選択し、ビルドします。

ソリューション エクスプローラーから実行したいサンプルのプロジェクトを選択します。
「ビルド」メニューを開きます。
「(プロジェクト名)のビルド」をクリックすると、ビルドが開始されます。

（実行したいプロジェクトを右クリックして「ビルド」を選択することでも実行できます）

Please enter alt text.

(4) コンソールウィンドウの出力メッセージに、ビルドされたexeファイルの出力パスが記載されます。

4.3.3. アプリケーションの発行

『4.1 .NET 8(C#)サンプルコードのビルドと発行方法』にある『4.1.5 アプリケーションの発行』をご参照ください。