Antenna House PDF Tool API V7.0

サンプルコードのビルドと実行手順 (.NET6)

アンテナハウス株式会社

1. はじめに

2. PDF Tool APIの開発環境を整える

2.1. ライブラリファイル、ヘッダーファイルを配置する

2.1.1. インストーラを利用する場合

2.1.2. インストーラを利用しない場合

2.2. ライセンスファイルを配置する

2.2.1. インストーラを利用した場合

2.2.2. インストーラを利用しなかった場合

2.3. フォントの準備

2.3.1. フォントの場所

2.3.2. フォント構築ファイルの作成

2.4. Windows開発環境における環境変数のまとめ

3. サンプルコードのプロジェクト作成とビルド方法

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

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

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

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

4. 発行されたファイルの実行方法について

4.1. Windowsでの実行について

4.2. Linuxでの実行について

付録1..NET6ランタイムのインストール方法

付録2.IPAフォントのインストール方法

5. Visual Studio Codeでのプログラム作成と実行方法

5.1. Linux環境

5.1.1. NET SDKのインストール

5.1.2. Visual Studio Codeのインストール

5.1.3. プロジェクトの作成

5.1.4. PDF Tool API のサンプルコードを使用したプログラムの作成

5.2. Windows環境

5.2.1. NET SDKのインストール

5.2.2. Visual Studio Codeのインストール

5.2.3. プロジェクトの作成

5.2.4. PDF Tool API のサンプルコードを使用したプログラムの作成

履歴

1. はじめに

本書では、まず、PDF Tool APIのC#サンプルコードをWindows環境のMicrosoft Visual Studio 2022でビルドあるいはアプリケーション発行する方法と、発行したアプリケーションファイルをWindowsとLinuxそれぞれで実行する方法を説明します。

次に、Visual Studio Codeを利用して、プロジェクト作成、ビルドと実行方法を説明します。

2. PDF Tool APIの開発環境を整える

ここでは、Windowsにおいて、Microsoft VIsual Studio 2022を利用してPDF Tool APIのサンプルコードをビルドするための環境整備について説明します。

2.1. ライブラリファイル、ヘッダーファイルを配置する

2.1.1. インストーラを利用する場合

  1. 「Setup-Windows\setup-lib.exe」をダブルクリックするなどして起動します。
  2. ダイアログの指示にしたがってインストールを行います。
  3. インストール途中に、Microsoft Visual C++ 2019 ランタイムライブラリのインストールを促すダイアログが表示された場合は、指示にしたがってインストールを行ってください。
  4. デフォルトのインストール先は以下のフォルダパスです。

{システムドライブ}:\Program Files\Antenna House\PDFToolAPI_V7_lib

2.1.2. インストーラを利用しない場合

「Lib-Windows」フォルダにライブラリファイルやヘッダファイルなどがあります。開発環境の任意の場所に配置します。

2.2. ライセンスファイルを配置する

2.2.1. インストーラを利用した場合

インストーラにより、ライセンスファイル「ptalic.dat」は「{インストールフォルダ}\License」フォルダに配置され、環境変数「PTL70_LIC_PATH」にフォルダパスが設定されます。

インストールされるライセンスファイルは、インストール後30 日間有効の評価用です。出力されるPDF ファイルに透かし文字列が挿入されます。

2.2.2. インストーラを利用しなかった場合

  • 配置方法1
  1. 弊社より発行するライセンスファイルを開発環境の任意の場所に配置します。
  2. 環境変数「PTL70_LIC_PATH」を作成し、配置したフォルダパスを設定します。
  • 配置方法2

ライセンスファイルを、PDF Tool APIのモジュールファイル「PdfTk70.dll」と同じ場所に配置します。

この場合、環境変数「PTL70_LIC_PATH」の作成は必要ありません。

2.3. フォントの準備

テキスト透かしを挿入したりページ上に文字を描画するには、フォント情報が必要です。

Windows版では、PDF Tool APIはシステムのフォントフォルダに存在するフォントを参照します。

2.3.1. フォントの場所

Windows では、オペレーティングシステムの仕様によりフォントファイルは下記のフォントフォルダに存在しています。

{システムドライブ}:\WINDOWS\Fonts

{システムドライブ}:\Users\{ユーザー名}\AppData\Local\Microsoft\Windows\Fonts

上記のフォントフォルダとは異なる場所にあるフォントを参照する場合には、「フォント構築ファイル」を設定します。

2.3.2. フォント構築ファイルの作成

(1) フォント構築ファイルは、下記の場所にあります。

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

または、

 Lib_Windows\fontconfig

(2) fontconfig フォルダ内には以下の2つのファイルがあります。

 font-config.xml :フォント構築ファイルのひな型

 font-config.dtd :font-config.xml の定義ファイル

(3) font-config.xml の「font-folder path」タグに、フォントファイルが存在するフォルダパスを記述します。

 (例)

  <font-config>

   <font-folder path="C:\TestFont"></font-folder>

  </font-config>

  1. font-config.xml とfont-config.dtd を任意の場所に配置します。
  2. 環境変数「PTL70_FONT_CONFIGFILE」を作成し、font-config.xml のフルパスを設定します。

2.4. Windows開発環境における環境変数のまとめ

環境変数名

設定値

設定が必要な場合

PTL70_LIC_PATH

ライセンスファイル「ptalic.dat」が存在する

フォルダパス

「PdfTk70.dll」とは異なる場所にライセンスファイルを配置する場合

PTL70_FONT_CONFIGFILE

フォント構築ファイル

「font-config.xml」のフルパス

システムのフォントフォルダとは異なる場所にあるフォントを参照する場合

3. サンプルコードのプロジェクト作成とビルド方法

ここでは、サンプルコードをビルドするためのMicrosoft Visual Studio(Visual Studio)プロジェクトの作成とビルド手順について説明します。

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

(1) Visual Studio 2022を起動します。

Please enter alt text.

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

Please enter alt text.

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

Please enter alt text.

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

Please enter alt text.

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

Please enter alt text.

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

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

Please enter alt text.

(8) 「アクティブソリューション構成」と「アクティブソリューションプラットフォーム」を設定します。プラットフォームは、「x86」または「x64」のどちらかを新規作成します。

Please enter alt text.

Please enter alt text.

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

Please enter alt text.

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

Please enter alt text.

(11) ファイル選択ダイアログが開きます。インストールフォルダまたは任意の場所に配置したPDF Tool APIモジュールファイルの「PdfTkNet6_70.dll」を選択します。ソリューションプラットフォームが「x64」の場合は「bin64」フォルダにある64bit用、「x86」の場合は「bin32」フォルダにある32bit用の「PdfTkNet6_70.dll」を選択してください。

Please enter alt text.

(12) 「OK」ボタンをクリックして「参照マネージャー」ダイアログを閉じます。参照したDLLは、ソリューションエクスプローラーの「依存関係」‐「アセンプリ」で確認できます。

Please enter alt text.

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

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

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

(図のプロジェクト名はConsoleApp1です。)

Please enter alt text.

(2) 左側の「ビルド」タブを開き「出力」を選択します。

Please enter alt text.

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

(4) 「ビルド」メニューの「ソリューションのビルド」をクリックすると、ビルドが開始されます。

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

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

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

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

(図のプロジェクト名はConsoleApp1です。)

Please enter alt text.

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

Please enter alt text.

(3) 「プロファイルの起動」ダイアログの「作業ディレクトリ」の欄にPdfTkNet6_70.dll、PdfTkNet6.dllを含むPDF Tool APIのdllのあるフォルダを指定します。必要に応じて、「コマンドライン引数」を指定します。

Please enter alt text.

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

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

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

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

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

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

Please enter alt text.

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

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

Please enter alt text.

Please enter alt text.

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

ターゲットフレームワーク:net6.0

配置モード:「自己完結」

発行されるアプリケーションファイルには、ターゲットフレームワークのランタイムライブラリーが含まれます。このため、アプリケーションファイルを実行する環境に、ターゲットフレームワークの.NETランタイムライブラリーをインストールする必要はありません。ただし、ファイルサイズは大きくなります。

配置モード:「フレームワーク依存」

発行されるアプリケーションファイルには、ターゲットフレームワークのランタイムライブラリーは含まれません。アプリケーションファイルを実行する環境には、ターゲットフレームワークの.NETランタイムライブラリーをインストールしてください。

ターゲットランタイム

「win-x64 (Windows 64bit)」、「win-x86 (Windows 32bit)」、「linux-x64 (Linux 64bit)」のいずれかを選択します。PDF Tool APIは、arm、osx(Mac OS X)には対応していません。

Please enter alt text.

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

Please enter alt text.

Please enter alt text.

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

Please enter alt text.

Please enter alt text.

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

Please enter alt text.

Please enter alt text. Please enter alt text.

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

「ターゲットランタイム」が「linux-x64」の場合、発行された拡張子のないファイルが実行ファイルです。

4. 発行されたファイルの実行方法について

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

4.1. Windowsでの実行について

  1. 「配置モード」が「フレームワーク依存」であるアプリケーションファイルの場合、あらかじめ、ターゲットフレームワークの.NETランタイムライブラリーをインストールしてください。※1
  2. PDF Tool APIのモジュールファイルをセットアップします。※2
  3. 発行されたアプリケーションファイルを、PDF Tool APIのモジュールファイルと同じ場所に配置します。あるいは、環境変数「PATH」に、PDF Tool APIのモジュールファイルが存在するフォルダパスを設定します。
  4. PDF Tool APIのライセンスファイルを配置します。「「PdfTk70.dll」」と同じ場所に配置する、または、ライセンスファイルを配置したフォルダパスを環境変数「PTL70_LIC_PATH」に設定してください。※3
  5. 必要に応じ、フォント構築ファイルの設定を行ってください。※4
  6. コマンドプロンプトを起動しアプリケーションファイルが存在するフォルダパスをカレントディレクトリにして実行します。必要に応じて、コマンド入力時に引数を指定してください。

※1 .NET6ランタイム インストーラの入手先

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

「.NET Runtime 6.0.xx」の項にある「Windows」の「x64」または「x86」インストーラ-をダウンロードしてセットアップしてくだい。

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

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

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

4.2. 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 『付録1.,NET6ランタイムのインストール方法』参照

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

※3 環境変数と設定値

LD_LIBRARY_PATH={PDF Tool APIモジュールファイルのディレクトリ} :${LD_LIBRARY_PATH}

PTL70_LIC_PATH={ライセンスファイルのディレクトリ}

PTL70_FONT_CONFIGFILE={ font-config.xmlのパス}

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

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

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

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

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

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

付録1..NET6ランタイムのインストール方法

(1) 下記のサイトからNET6ランタイムのインストーラを入手します。

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

「.NET Runtime 6.0.xx」の項にある「dotnet-install scripts」をクリックします。

Please enter alt text.

(2) 「Bash」の項のアドレスからスクリプトをダウンロードします。

(3) インストールを実行します。

コマンド:sh ./dotnet-install.sh --version latest --runtime dotnet

(.NET6 ランタイムの最新バージョンをインストールする場合)

  1. インストール先を指定しなかった場合、「ホーム($HOME)/.dotnet」ディレクトリにインストールされます。「.dotnet」ディレクトリが表示されない場合、「隠しファイルを表示する」にチェックを入れてください。
  2. インストールした.NET6ランタイムの「dotnet」コマンドを使用するには、次の環境変数の設定が必要です。

「ホーム」の.bashrc (または.bash_profile)に以下の環境変数を追記し、システムを再起動します。

export DOTNET_ROOT=$HOME/.dotnet

export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools

(6) インストールしたランタイムのバージョンは以下のコマンドとオプションで確認できます。

コマンド:dotnet --list-runtimes

「Microsoft.NETCore.App 6.0.16 [/home/test/.dotnet/shared/Microsoft.NETCore.App]」
のように表示されます。

付録2.IPAフォントのインストール方法

Linuxでは、動作環境によって日本語用のフォントが存在しない場合があります。ここでは、「IPAフォント」のインストール方法を説明します。

(1) 下記のサイトからフォントファイルをダウンロードします。

文字情報技術促進協議会:https://moji.or.jp/ipafont/

(2) ダウンロードしたttfファイルを任意のディレクトリに配置します。ここでは、「/usr/share/fonts/ ipa」に配置します。

Please enter alt text.

(3) ttfファイルを開き、右上の「インストール」ボタンをクリックしてインストールします。

Please enter alt text.

5. Visual Studio Codeでのプログラム作成と実行方法

ここでは、Visual Studio Code(VSCode)を使用して、.NET6のプログラム作成と実行方法を説明します。

5.1. Linux環境

5.1.1. NET SDKのインストール

付録1..NET6ランタイムのインストール方法』の(3)でのインストールコマンドを
./dotnet-install.sh --version latest
に変更して実行します。このコマンドにより、.NET6をランタイムとしてではなく、SDKとしてインストールします。
インストールしたランタイムのバージョンは以下のコマンドとオプションで確認できます。
コマンド:dotnet --list-sdks
「6.0.408 [/home/test/.dotnet/sdk]」
のように表示されます。

5.1.2. Visual Studio Codeのインストール

(1) Download Visual Studio Code

https://code.visualstudio.com/download
を開いて「.rpm」をダウンロードします。

グラフィカル ユーザー インターフェイス, Web サイト

自動的に生成された説明

(2) ダウンロードしたrpmファイルをクリックして開きます。
左上の「インストール」ボタンを押すとインストールが始まります。

グラフィカル ユーザー インターフェイス, テキスト, アプリケーション

自動的に生成された説明

白黒の写真にテキストが書いてあるスマートフォンのスクリーンショット

低い精度で自動的に生成された説明

(3) VSCode拡張機能「Japanese Language Pack for VS Code」のインストール

左側アクティビティバーにある拡張機能をクリックします。
開いたサイドバー上部にある検索欄に「Japanese」と記入し結果に表れる「Japanese Language Pack for VS Code」を選択します。

グラフィカル ユーザー インターフェイス, アプリケーション

自動的に生成された説明グラフィカル ユーザー インターフェイス, アプリケーション

自動的に生成された説明グラフィカル ユーザー インターフェイス, アプリケーション

自動的に生成された説明

青色の「install」ボタンを押すとインストールが始まります。

グラフィカル ユーザー インターフェイス, テキスト

自動的に生成された説明

インストール終了後に再起動をすることによって日本語が適応されます。

(4) VSCode拡張機能「C#」のインストール

左側アクティビティバーにある拡張機能をクリックします。
開いたサイドバー上部にある検索欄に「C#」と記入し結果に表れる「C#」を選択します。

モニター画面に映るゲーム画面

低い精度で自動的に生成された説明モニター画面に映るゲーム画面

低い精度で自動的に生成された説明モニター画面に映るゲーム画面

低い精度で自動的に生成された説明

青色の「install」ボタンを押すとインストールが始まります。

グラフィカル ユーザー インターフェイス, アプリケーション

自動的に生成された説明

5.1.3. プロジェクトの作成

「フォルダを開く」と「ターミナルを開く」の2つの方法があります。

5.1.3.1. フォルダを開く

(1) 左側アクティビティバーにあるエクスプローラーを選択します。

(2) サイドバーに表示された「フォルダーを開く」をクリックします。
または、メニューバー左上の「ファイル」を選択し、開いたメニューの「フォルダーを開く」をクリックします。

グラフィカル ユーザー インターフェイス, テキスト

自動的に生成された説明グラフィカル ユーザー インターフェイス, テキスト

自動的に生成された説明

(3) プロジェクトのファイルを生成するフォルダを指定して右上の「開く」をクリックします。

(4) 左側のサイドバーのエクスプローラーに指定したファイル名が表示されます。
画像ではTEST_NET6というフォルダを指定しています。

グラフィカル ユーザー インターフェイス, テキスト, アプリケーション

自動的に生成された説明

(5) 下記のダイアログが表示されるので「はい、作成者を信頼します」を選択します。

テキスト

自動的に生成された説明

5.1.3.2. ターミナルを開く

(1) 「ターミナル」メニューの「新しいターミナル」を選択します。

グラフィカル ユーザー インターフェイス, テキスト, アプリケーション, メール

自動的に生成された説明

(2) 開かれたターミナル画面に dotnet new のコマンドを入力して新しいコンソールアプリケーションのプロジェクトを作成します。

コマンド:dotnet new console --framework net6.0 --use-program-main

dotnet new <TEMPLATE> - .NET CLI | Microsoft Learn

テキスト

自動的に生成された説明

テキスト

自動的に生成された説明

5.1.4. PDF Tool API のサンプルコードを使用したプログラムの作成

(1) PDF Tool APIのインストール

2.PDF Tool APIの開発環境を整える」を参照してください。

(2) VSCodeを起動してプロジェクトを作成します。

(3) 「(フォルダ名).csproj」 を開いて赤字の箇所を追記します。
<HintPath> にはPdfTkNet6_70.dllのパスを記入します。

Please enter alt text.

(4) 「ファイル」メニューの「ファイルを開く」を選択して使用したいサンプルコードのcsファイルを開きます。

グラフィカル ユーザー インターフェイス, テキスト, アプリケーション

自動的に生成された説明

(5) 「ファイル」メニューの「名前を付けて保存」を選択してプロジェクト生成時に作成された「Program.cs」に上書き保存します。または、「ファイル」メニューの「名前を付けて保存」を選択して別名保存を行い、その後「Program.cs」を選択し右クリックメニューで「削除」します。

グラフィカル ユーザー インターフェイス, アプリケーション

自動的に生成された説明

グラフィカル ユーザー インターフェイス, テキスト, アプリケーション

自動的に生成された説明

(6) ターミナルに下記のコマンドを入力しビルドを行います。

dotnet build -c Release

(7) ビルドが完了したら、下記のコマンドで実行します。

dotnet run

5.2. Windows環境

5.2.1. NET SDKのインストール

.NET6.0のウンロード

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

「SDK 6.0.xx」の項にある「Windows」の「x64」または「x86」インストーラ-をダウンロードしてセットアップします。

5.2.2. Visual Studio Codeのインストール

(1) Download Visual Studio Code

https://code.visualstudio.com/download

を開いて「windows」をダウンロードします。

グラフィカル ユーザー インターフェイス

自動的に生成された説明

  1. ダウンロードしたexeファイルをクリックして開くとインストールが始まります。
  2. VSCodeの拡張機能「Japanese Language Pack for VS Code」と「C#」をインストールします。「5.1.2. Visual Studio Codeのインストール」の(3)、(4)をご参照ください。

5.2.3. プロジェクトの作成

 「5.1.3.プロジェクトの作成」をご参照ください。

5.2.4. PDF Tool API のサンプルコードを使用したプログラムの作成

 「5.1.4.PDF Tool API のサンプルコードを使用したプログラムの作成」をご参照ください。

履歴

日付

更新内容

2023.5.29

・初版

2023.7.4

・「5.Visual Studio Codeでのプログラム作成と実行方法」を追加しました。

Antenna House PDF Tool API V7.0

サンプルコードのビルドと実行手順(.NET6)

2023.7.4

Antenna House Inc. 2023 All Rights Reserved.

目次へ