アセンブリ - リファレンス


アセンブリは「.NET Framework」 に対応したコンパイルされたコードライブラリです。
「.NET Framework」 アプリケーションではアセンブリを通じて様々な機能を簡単に利用することができます。

「PDF Server」「PDF Client」には専用のアセンブリが準備されていて「.NET Framework」 アプリケーションで利用することができます。

このページでは、アセンブリから「PDF Server」「PDF Client」を起動しPDFを作成する方法について説明します。



アセンブリではCOMをカプセル化し機能を提供しています。
実際に動作するのはCOMの「PDF Server」「PDF Client」となります。


アセンブリファイルとクラス情報
各種設定
各種設定 - 参照設定

各種設定 - DCOMの設定とDLLの配置
メソッド
使用例


IIS/ASP.NETからの利用について



アセンブリファイルとクラス情報


「PDF Server」「PDF Client」のアセンブリはDLLファイルとして「.NET Framework」のバージョン毎に準備されています。
(AnyCPU版)

.NET Framework アセンブリ(DLL)ファイル名
.NET Framework 2.0 WfrLib_20.dll(version 3.0.0.132以降のバージョンはありません)
.NET Framework 3.5 WfrLib_35.dll(version 3.0.0.132以降のバージョンはありません)
.NET Framework 4.0 WfrLib_40.dll(version 3.0.0.132以降のバージョンはありません)
.NET Framework 4.5 WfrLib_45.dll
.NET Framework 4.5.1 WfrLib_451.dll
.NET Framework 4.5.2 WfrLib_452.dll
.NET Framework 4.6 WfrLib_46.dll
.NET Framework 4.6.1 WfrLib_461.dll
.NET Framework 4.7 WfrLib_46.dll
.NET Framework 4.7.1 WfrLib_47.1.dll
.NET Framework 4.7.2 WfrLib_47.2.dll
.NET Framework 4.8 WfrLib_48.dll


アセンブリファイル(DLL)は次の方法で入手可能です。
使用する「.NET Framework」のバージョンと同じバージョン(WfrLib_xxx.dll)のDLLファイルを1つだけコピーして使用してください。


オブジェクト情報は次の通りです。
「.NET Framework」 からはオブジェクトを通じて各種機能を使用することができます。

<「PDF Server」のオブジェクト情報>
オブジェクト名(型) WfrLib.PdfServer 


<「PDF Client」のオブジェクト情報>
オブジェクト名(型) WfrLib.PdfClient 



WfrLib_*.dll には「Preview」用のクラスも定義されていますが、ここでの説明は省略します。


「.NET Framework」ではガベージコレクション(GC)により不要なメモリは解放されます。
しかし、解放タイミングが不規則なためリソースの圧迫やファイルを開いたままにする等、システムに悪影響を与える可能性があります。
不要となったリソースは明示的に解放(破棄)してください。
アセンブリでは「Dispose」を呼び出してオブジェクトを破棄します。
このヘルプの多くのサンプルではエラー処理を省いていますが、エラー発生時でもオブジェクトの破棄は行う必要があります。

詳しくは「SetErrorMode」を参照。


各種設定


アセンブリは、COMをカプセル化することで各機能を実現しています。
このためアセンブリを使うには、システムへの「PDF Server」または「PDF Client」のインストールが必須となります。

「VB」や「C#」からアセンブリを使うには参照設定を行う必要があります。
また、Webシステムから利用する場合はDCOMの設定とWebサイトの「Bin」フォルダへのアセンブリファイルの配置が必要となります。

「version 3.0.0.133」以降では、内部処理はCOM(DCOM)ではなくコマンド起動で行うことができるようになりました。WebサーバーでDCOMの利用が制限される場合でもアセンブリ利用することができます。(詳細:「CreateObject」-「DCOMの利用が制限される環境で運用する場合」)



参照設定
DCOMの設定とDLLの配置



1.参照設定

「VB」や「C#」からアセンブリを使う場合は参照設定が必要です。

「Visual Studio 2015」の場合の手順は次の通りです。

  1. 「再配布」ファイルにある「.NET Framework」 のバージョンに合ったアセンブリDLLファイルを任意のフォルダにコピーします。

  2. 「プロジェクト」メニューから「参照の追加」を実行し、
    「参照マネージャー」ダイアログの「参照」ボタンから「1」のDLLファイルを選択します。





  3. 「参照マネージャー」ダイアログの「参照」タグに「2」で選択したDLLファイルが表示されます。(チェック有り)



  4. 「OK」ボタンで「参照マネージャー」ダイアログを閉じることで参照設定を追加することができます。





2.DCOMの構成とDLLの配置

Webシステム(ASP.NET)からアセンブリを使って「PDF Server」を利用する場合は、「DCOMの構成」でCOMに実行権限を付与し「.NET Framework」 のバージョンに合ったDLLファイルをWebサイトの「Bin」フォルダにコピーすることで利用できるようになります。(例 c:\wwwroot\Bin\WfrLib_452.dll)

「DCOMの構成」については、「COM - リファレンス」の「DCOMの構成」を参照してください。


Webサイトの「Bin」フォルダには「ASP.NET」「.NET Framework」のバージョンと一致するものを1つだけコピーしてください。
複数コピーすると正しく動作しない可能性があります。



「version 3.0.0.133」以降では、内部処理はCOM(DCOM)ではなくコマンド起動で行うことができるようになりました。WebサーバーでDCOMの利用が制限される場合でもアセンブリを利用することができます。(詳細:「CreateObject」-「DCOMの利用が制限される環境で運用する場合」)


メソッド


アセンブリで使用可能なメソッドについては「メソッド・キーワード一覧」の「メソッド一覧」を参照してください。



使用例


アセンブリを使った使用例です。

帳票定義ファイル(*.wfr)にデータを入力してPDFイメージをクライアントに出力する例(ASP.NET-アセンブリ-C#)sample.aspx
Webサイトの「Bin」フォルダに「WfrLib_452.dll」を配置。(「.NET Framework 4.5.2」 を使う場合)



テンプレートファイルからPDFイメージを作成しクライアントに出力する例(ASP.NET-アセンブリ-VB)sample.aspx
Webサイトの「Bin」フォルダに「WfrLib_452.dll」を配置。(「.NET Framework 4.5.2」 を使う場合)



ボタンアクションから帳票定義ファイル(*.wfr)にデータを入力してPDFファイルに出力する例(Windowsフォーム-アセンブリ-C#)
参照設定に「WfrLib_452.dll」を追加。(「.NET Framework 4.5.2」 を使う場合)




このページの先頭へ