.NETインターフェイス

.NETインターフェイスを使えば、Visual Basic.NET、Visual C#.NET などで作成された .NETアプリケーションから Office Server Document Converter V8.0 の機能を利用することができます。

Windows版

Linux版

注意: Amazon Linux 2 Graviton2版には .NETインターフェイスは用意されていません。
Microsoft .NET Framework 1.0/1.1/2.0/3.0環境では使えません。
.NETインターフェイスを利用するとき、Office Server Document Converter V8.0 と他のバージョンの Office Server Document Converter を同一マシンにインストールしておくことはできません。どちらかをアンインストールして、環境変数PATHに不要な Office Server Document Converter へのPATHが含まれないようにしてください。

コンポーネントの登録

Office Server Document Converter .NETコンポーネントはグローバルアセンブリキャッシュへ自動的には登録されません。使用するにはアプリケーションのカレントフォルダに配置するか、もしくはアプリケーション構成ファイルを作成するなど、なんらかの方法でパスを解決する必要があります。

Windows版
.NETコンポーネントファイル名 .NET Framework 4.0/4.5.x/4.6.x/4.7.x/4.8.x 用 DfvDotNet40Ctl80.dll(build:VS2019)
.NET 5用 DfvDotNet50Ctl80.dll (build:VS2019)
Linux版
.NETコンポーネントファイル名 .NET 5用 DfvDotNet50MCtl80.dll

クラス

.NET コンポーネントには以下のクラスが含まれます。

名前 機能
DfvObj Office Server Document Converter V8.0 本体のクラスです。このクラスは IDisposableインターフェイスを実装しています。DfvObjクラスオブジェクトの使用を終了するときはリソースを解放するためにDisposeメソッドを呼ぶようにしてください。

以下はC#の例です。

DfvDotNetCtl.DfvObj obj = new DfvDotNetCtl.DfvObj(); try { // 何かの処理 } finally { obj.Dispose(); }
DfvException Office Server Document Converter V8.0 の例外クラスです。DfvObjクラスのExecuteメソッドがスローします。

プロパティ

DfvExceptionクラスのプロパティには以下のものがあります。

名前 入出力 機能
ErrorLevel Int32 R 変換でエラーが発生した場合のエラーレベルを示します。
1.情報
2.警告エラー
3.回復可能エラー
4.致命的エラー
ErrorCode Int32 R 変換で例外エラーが発生した場合のエラーコードを示します。正常終了した場合はゼロです。ゼロ以外は、何らかのエラーが起こったことを示します。

DfvObjクラスのプロパティには以下のものがあります。

名前 入出力 機能
Version String R Office Server Document Converter V8.0 のバージョン文字列を取得します。
DocumentURI String R/W 変換対象ドキュメントの URIを指定します。
  • 省略された場合、あるいは "@STDIN" の場合は、標準入力からドキュメントが読み込まれます。
PrinterName String R/W 変換結果の出力形式または出力するプリンタ名を指定します。
  • プリンタ名が指定された場合は変換結果をそのプリンタへ出力します。
  • "@STDPRN" が指定された場合は、"通常使うプリンタ" へ出力します。
  • "@PDF" が指定された場合は、変換結果を PDF へ出力します。
  • "@SVG" が指定された場合は、変換結果を SVG へ出力します。
  • "@XPS" が指定された場合は、変換結果を XPS へ出力します。
  • "@INX" が指定された場合は、変換結果を INX へ出力します。
  • "@Flash" が指定された場合は、変換結果を Flash へ出力します。
  • "@JPEG" が指定された場合は、変換結果を JPEG へ出力します。
  • "@PJPEG" と指定した場合は、変換結果を プログレッシブJPEG に出力します。
  • "@PNG" が指定された場合は、変換結果を PNG へ出力します。
  • "@IPNG" と指定した場合は、変換結果を インターレースPNG に出力します。
  • "@TIFF" が指定された場合は、変換結果を TIFF へ出力します。
  • "@TIFFC" が指定された場合は、変換結果を CMYK の TIFF へ出力します。
  • "@MTIFF" が指定された場合は、変換結果を multi-page TIFF へ出力します。
  • "@MTIFFC" が指定された場合は、変換結果を CMYK の multi-page TIFF へ出力します。
省略された場合は "@PDF" が指定されたとみなされます。
プリンタの指定(@STDPRN または プリンタ名)は、Windows版のみ対応しています。 プリンタ名に関しては、「プリンタ名の指定方法」を参照してください。
PDF出力に関しては、「PDF出力」を参照してください。
SVG出力に関しては、「SVG出力」を参照してください。
XPS出力に関しては、「XPS出力」を参照してください。
INX出力に関しては、「INX出力」を参照してください。
Flash出力に関しては、「Flash 出力」を参照してください。
モノクロ/256色カラーのJPEG 出力と PNG 出力、TIFF出力は Windows 版でのみ有効です。
OutputFilePath String R/W 変換結果の出力先ファイルパスを指定します。 PrinterNameで出力形式にプリンタが指定されている場合は、印刷結果がプリンタドライバによって、指定したファイルに保存されます。 プリンタ以外の出力形式が指定されている場合は、その出力形式で、指定したファイルに保存されます。 省略された場合、あるいは"@STDOUT" が指定された場合は標準出力に出力します。
StartPage
EndPage
Int32 R/W 出力の開始ページと終了ページを指定します。 開始ページが省略された場合や 0以下の場合は、先頭ページからとみなされます。 終了ページが省略された場合や 0の場合、あるいは実際のページ数より大きい場合は最終ページまでとみなされます。 矛盾する指定、例えば StartPage=5 EndPage=3 のような場合はエラーです。
OmitBlankPages Boolean R/W

文書先頭に空のページがあったとき、そのページをスキップするときに指定します。

変換元ファイルは MS Word または MS Excel のみ有効です。スキップしたページを1ページとしてカウントします。スキップして最初に見つかった内容のあるページのみを取得するときは EndPage=1 を組み合わせて指定します。先頭ページがheader,footerのみの場合もスキップします。

ExitLevel Int32 R/W 変換でエラーが発生した場合の処理の中止条件を指定します。ExitLevel で指定したエラーレベル以上のエラーが発生した場合、Office Server Document Converter V8.0 に変換を中止させます。初期値は2(警告エラー)で、2以上の場合は変換を 中止します。1~4の値を指定してください。5以上の値を指定した場合は4(致命的エラー)が指定されたとみなされます。4(致命的エラー)が発生した場合は指定したエラーレベルに関係なく処理は打ち切られます。なお、エラー表示自体は、どのレベルを指定しても表示されません。
ErrorLevel Int32 R 変換でエラーが発生した場合のエラーレベルを示します。
1.情報
2.警告エラー
3.回復可能エラー
4.致命的エラー
ErrorCode Int32 R 変換でエラーが発生した場合のエラーコードを示します。正常終了した場合はゼロです。ゼロ以外は、何らかのエラーが起こったことを示します。
ErrorMessage String R 変換でエラーが発生した場合のエラーメッセージ本体です。
ErrorStreamType Int32 R/W 変換中、設定したエラーレベル未満のエラーが発生した場合に標準出力、もしくは標準エラー出力へ、エラーメッセージを出力します。デフォルトではエラー情報を出力しません。
0.出力しない
1.標準出力
2.標準エラー出力

プロパティ – PDF出力の設定

名前 入出力 機能
PdfVersion Int32 R/W 作成するPDFのバージョンを指定します。バージョン番号は以下のいずれかを指定してください。
0.PDF1.3
1.PDF1.4
2.PDF1.5
3.PDF1.6
4.PDF1.7
10.PDF2.0
400.PDF/A-1b:2005
PdfEncryptLevel Int32 R/W 作成するPDFの暗号化時のキー長を指定します。キー長は以下のいずれかを指定してください。
0.40bit RC4
1.128bit RC4
2.128bit AES
3.256bit AES
128 RC4 はPDF1.4以降で、128bit AES はPDF1.6以降で、256bit AES はPDF1.7以降で有効です。
PdfTag Boolean R/W タグ付きPDFを生成します。PDFのバージョンによって、タグ付きにできないときは無視されます。
PdfUserPassword String W PDFに設定するユーザパスワードを指定します。32文字までのASCII文字を指定してください。
PdfOwnerPassword String W PDFに設定するオーナパスワードを指定します。32文字までのASCII文字を指定してください。
PdfNoPrinting Boolean R/W 作成されるPDFを印刷不可にします。
このプロパティは、PdfOwnerPassword の指定が必要です。
PdfNoChanging Boolean R/W 作成されるPDFを変更不可にします。
このプロパティは、PdfOwnerPassword の指定が必要です。
PdfNoContentCopying Boolean R/W 作成されるPDFの内容をコピー不可にします。
このプロパティは、PdfOwnerPassword の指定が必要です。
PdfNoAddingOrChangingComments Boolean R/W 作成されるPDFの注釈やフォーム追加不可にします。
このプロパティは、PdfOwnerPassword の指定が必要です。
PdfNoFillForm Boolean R/W 作成するPDFのフォームフィールドの入力と署名を不可にします。このパラメータは PdfVersion でPDF1.4以降を指定しなければ有効になりません。 このパラメータを有効にするには、他のパラメータの設定が必要な場合があります。詳しくはPDFリファレンスを参照してください。
PdfNoAccessibility Boolean R/W 作成するPDFのスクリーンリーダデバイスのテキストアクセスを不可にします。 このパラメータは PdfVersion でPDF1.4以降を指定しなければ有効になりません。
PdfNoAssembleDoc Boolean R/W 作成するPDFのページの挿入、削除、回転を不可にします。 このパラメータは PdfVersion でPDF1.4以降を指定しなければ有効になりません。
PdfEmbedAllFontsEx Int32 R/W 変換結果の文書内で使用されているすべてのフォントを PDF に埋め込むか否かを指定します。但し、すべてのフォントを埋め込む指定がされても、埋め込みが禁止されていたり、PDF に埋め込むことのできない形式のフォントを埋め込むことはできません。
0.指定されたフォントのみ
1.欧文基本14フォントを除くすべてのフォント
2.欧文基本14フォントを含むすべてのフォント
PdfEmbedFonts String R/W 作成するPDFに指定したフォントを埋め込みます。フォントを複数指定する場合はカンマ区切りで指定します。
PdfErrorOnEmbedFault Boolean R/W trueを指定するとフォント埋め込みに失敗したときにエラーを発行するようになります。
PdfErrorOnMissingGlyph Boolean R/W trueを指定するとフォントにグリフがなかったときにエラーを発行するようになります。
PdfPrintingAllowed Int32 R/W 作成するPDFの印刷を許可するかどうかを以下のいずれかで指定します。このパラメータは PdfVersion でPDF1.4以降を指定しなければ有効になりません。
0.許可しない
1.低解像度の印刷のみ許可
2.高解像度の印刷を許可
PdfImageCompression Int32 R/W PDFに直接格納できないカラー画像形式のとき、その画像はPDFと互換性のあるビットマップ形式に変換されてから格納されます。そのとき、PDFファイル内に格納するデータの圧縮方法を次のいずれかで指定します。
0.JPEGまたはZLIB圧縮
1.JPEG圧縮
2.ZLIB圧縮
3.JPEG 2000圧縮(PdfVersion が PDF1.5以降のときのみ有効)
自動 が指定された場合、PdfJPEGQualityPdfRasterizeResolution の指定に従ってイメージデータを作成し、JPEG、ZLIB 圧縮のサイズの小さい方を選択します。 この設定は、カラー画像に対するものです。グレイスケール画像に対しては PdfGrayscaleImageCompression、白黒画像に対しては PdfMonochromeImageCompression を指定してください。
PdfJPEGQuality Int32 R/W PDFに直接格納できないカラー画像形式のとき、PdfImageCompression に JPEG圧縮 が指定されたときの画質を 1~100 の範囲の数値で指定します。数字が大きいほど画質はよくなりますが、ファイルサイズは大きくなります。 この設定は、カラー画像に対するものです。グレイスケール画像に対しては PdfGrayscaleJPEGQuality を指定してください。
注意: JPEG形式の画像の画質を変更するためのものではありません。
PdfPutImageColorProfile Boolean R/W PDFに埋め込むカラー画像中のICCプロファイルをPDFに埋め込むかどうかを指定します。
PdfImageDownSampling Int32 R/W PDFに格納するラスタのカラー画像のダウンサンプリングの方法を指定します。
0.ダウンサンプリングしない
1.バイリニア法
2.バイキュービック法
3.ニアレストネイバー法
ダウンサンプリングしない 以外が指定されたときは PdfImageDownSamplingDPI で指定された解像度以上の画像を PdfImageDownSamplingTarget で指定された解像度にダウンサンプリングします。 この設定は、カラー画像に対するものです。グレイスケール画像に対しては PdfGrayscaleImageDownSampling、白黒画像に対しては PdfMonochromeImageDownSampling を指定してください。
PdfImageDownSamplingTarget Int32 R/W ラスタのカラー画像をダウンサンプリングするときの解像度を指定します。
PdfImageDownSamplingDPI Int32 R/W ダウンサンプリングを行うラスタのカラー画像の解像度を指定します。
PdfGrayscaleImageCompression Int32 R/W PDFに直接格納できないグレイスケール画像形式のとき、その画像はPDFと互換性のあるビットマップ形式に変換されてから格納されます。そのとき、PDFファイル内に格納するデータの圧縮方法を次のいずれかで指定します。
0.JPEGまたはZLIB圧縮
1.JPEG圧縮
2.ZLIB圧縮
3.JPEG 2000圧縮(PdfVersion が PDF1.5以降のときのみ有効)
自動 が指定された場合、PdfGrayscaleJPEGQualityPdfRasterizeResolution の指定に従ってイメージデータを作成し、JPEG、ZLIB 圧縮のサイズの小さい方を選択します。 この設定は、グレイスケール画像に対するものです。カラー画像に対しては PdfImageCompression、白黒画像に対しては PdfMonochromeImageCompression を指定してください。
PdfGrayscaleJPEGQuality Int32 R/W PDFに直接格納できないグレイスケール画像形式のとき、PdfGrayscaleImageCompression に JPEG圧縮 が指定されたときの画質を 1~100 の範囲の数値で指定します。数字が大きいほど画質はよくなりますが、ファイルサイズは大きくなります。 この設定は、グレイスケール画像に対するものです。カラー画像に対しては PdfJPEGQuality を指定してください。
注意: JPEG形式の画像の画質を変更するためのものではありません。
PdfGrayscaleImageDownSampling Int32 R/W PDFに格納するラスタのグレイスケール画像のダウンサンプリングの方法を指定します。
0.ダウンサンプリングしない
1.バイリニア法
2.バイキュービック法
3.ニアレストネイバー法
ダウンサンプリングしない 以外が指定されたときは PdfGrayscaleImageDownSamplingDPI で指定された解像度以上の画像を PdfGrayscaleImageDownSamplingTarget で指定された解像度にダウンサンプリングします。 この設定は、グレイスケール画像に対するものです。カラー画像に対しては PdfImageDownSampling、白黒画像に対しては PdfMonochromeImageDownSampling を指定してください。
PdfGrayscaleImageDownSamplingTarget Int32 R/W ラスタのグレイスケール画像をダウンサンプリングするときの解像度を指定します。
PdfGrayscaleImageDownSamplingDPI Int32 R/W ダウンサンプリングを行うラスタのグレイスケール画像の解像度を指定します。
PdfMonochromeImageCompression Int32 R/W PDFに直接格納できない白黒画像形式のとき、その画像はPDFと互換性のあるビットマップ形式に変換されてから格納されます。そのとき、PDFファイル内に格納するデータの圧縮方法を次のいずれかで指定します。
0.CCITT Group4
1.CCITT Group3
2.Run Length圧縮
3.ZLIB圧縮
4.なし
この設定は、白黒画像に対するものです。グレイスケール画像に対しては PdfGrayscaleImageCompression、カラー画像に対しては PdfImageCompression を指定してください。
PdfMonochromeImageDownSampling Int32 R/W PDFに格納するラスタの白黒画像のダウンサンプリングの方法を指定します。
0.ダウンサンプリングしない
1.バイリニア法
2.バイキュービック法
3.ニアレストネイバー法
ダウンサンプリングしない 以外が指定されたときは PdfMonochromeImageDownSamplingDPI で指定された解像度以上の画像を PdfMonochromeImageDownSamplingTarget で指定された解像度にダウンサンプリングします。 この設定は、白黒画像に対するものです。グレイスケール画像に対しては PdfGrayscaleImageDownSampling、カラー画像に対しては PdfImageDownSampling を指定してください。
PdfMonochromeImageDownSamplingTarget Int32 R/W ラスタの白黒画像をダウンサンプリングするときの解像度を指定します。
PdfMonochromeImageDownSamplingDPI Int32 R/W ダウンサンプリングを行うラスタの白黒画像の解像度を指定します。
PdfLinearize Boolean R/W リニアライズPDFを出力するかどうかを設定します。
PdfCompressContentStream Boolean R/W 作成するPDF中のテキストとラインアートを圧縮してPDFのサイズを小さくするかどうかを指定します。
PdfUseLaunchForRelativeURI Boolean R/W 相対アドレスで指定された外部へのリンクをPDFのリンクプロパティにどのように変換するかを指定します。trueを指定すると"ファイルから開く"に変換され、falseを指定すると"World Wide Web リンク"に変換されます。
PdfRGBConversion Int32 R/W 作成するPDFのRGBカラースペース(DeviceRGB)をDeviceGrayに変換する方法を以下のいずれかで指定します。
0.変換しない
1.黒をデバイスグレイ
2.グレイをデバイスグレイ
3.すべてデバイスグレイ
4.すべてCMYKに
PdfRasterizeResolution Int32 R/W ベクタイメージがラスタイメージに変換されてPDFに格納されるときのラスタイメージの解像度を70~500(dpi)の値で指定します。SVG、EMF、WMFはラスタイメージに変換されることなくPDF内に描画されます。
PdfColorProfile String R/W PdfVersion に PDF/A-1b:2005 を指定したときは、ICCプロファイルの指定が必須です。ICCプロファイルをフルパスで指定してください。PDF/A-1b:2005 以外ではこのパラメータは無効です。
PdfOutputScale String W 出力PDFの拡大縮小率を指定します。長さには単位付きの値または%値が指定できます。
PdfOutputHeight String R/W 出力PDFの高さを拡大縮小します。長さには単位付きの値または%値が指定できます。
PdfOutputWidth String R/W 出力PDFの幅を拡大縮小します。長さには単位付きの値または%値が指定できます。
PdfErrorOnPDFXFault Boolean R/W PDF/XまたはPDF/A出力のときエラーがあっても、それを発行しないようにします。

プロパティ – SVG出力の設定

名前 入出力 機能
SvgVersion Int32 R/W 作成するSVGのバージョンを指定します。バージョン番号は以下のいずれかを指定してください。
0.SVG 1.1
1.SVG Basic
2.SVG Tiny
SvgImageProcessingType Int32 R/W 作成するSVGに含まれる画像の処理方法を以下のいずれかで指定します。
0.すべての画像をSVGに埋め込みます。
1.すべての画像を SvgImageCopyPath で指定された複写先に複写してリンクします。
このパラメータを省略したときは 0 が指定されたものとみなし、すべての画像を埋め込みます。
SvgImageCopyPath String R/W SvgImageProcessingType に 1 を指定したときの複写先を指定します。
SvgGzipCompression Boolean R/W 出力するSVGをgzip圧縮するかどうかを指定します。
SvgSingleFile Boolean R/W 変換結果が複数ページに渡るとき、それらを複数のSVGに分割して出力するか、ひとつのSVGとして出力するかを指定します。 trueのときひとつのSVGを出力し、falseのとき複数のSVGを出力します。複数のSVGを出力するときは、ファイル名が SvgFormat の指定によって修飾されます。ファイルへの出力のときのみ有効です。ストリームなどファイル名を持たない出力では無効です。
SvgImageRename Boolean R/W 画像を SvgImageCopyPath などで指定したディレクトリに複写して処理するとき、そのファイル名をすべて SvgImagePrefix で指定したプレフィクスで命名し直すか、元のファイル名を利用するかを指定します。ファイル名が重複するときは、連番が補われます。true を指定すると、すべて命名し直します。
SvgImagePrefix String R/W 画像を SvgImageCopyPath で指定したディレクトリに複写して処理するとき、そのファイル名のプレフィクスを指定します。ファイル名は、プレフィクス+連番 となります。既定値は空文字列で、そのときは連番のみとなります。
SvgSinglePageNumber Boolean R/W SvgSingleFile=false のとき、出力されるSVGが1ページしかないときに連番を付けるかどうかを指定します。falseなら付けません。
SvgFormat String R/W 変換元文書が複数ページで SvgSingleFilefalse を指定しているときに複数のSVGファイルがファイル名末尾に連番を付けて出力されますが、連番のフォーマットを変更できます。 例えば、出力ファイル名に document.svg が与えられているとき、SvgFormat に "-01" を与えたならば、document-01.svgdocument-02.svg、… となります。 このパラメータが省略されたときは "1" が指定されたものとみなされます。
SvgEmbedAllFonts Boolean R/W 出力するSVGにフォントを埋め込むかどうかを指定します。
SvgEmbedFonts String R/W 作成するSVGに指定したフォントを埋め込みます。フォントを複数指定する場合はカンマ区切りで指定します。
SvgErrorOnEmbedFault Boolean R/W trueを指定するとフォント埋め込みに失敗したときにエラーを発行するようになります。
SvgImageConversion Int32 R/W 作成するSVGに格納する画像の変換方法を以下から選択します。
0.自動
1.JPEG変換
2.PNG変換
3.すべてJPEG変換
SvgJPEGQuality Int32 R/W SVGに直接格納できない画像形式のとき、SvgImageConversion に JPEG変換 が指定されたときの画質を 1~100 の範囲の数値で指定します。数字が大きいほど画質はよくなりますが、ファイルサイズは大きくなります。初期値は 80 です。
SvgRasterizeResolution Int32 R/W 一部のベクタイメージがラスタイメージに変換されてSVGに格納されるときのラスタイメージの解像度を70~500(dpi)の値で指定します。SVG、EMF、WMFはラスタイメージに変換されることなくSVG内に描画されます。
SvgSingleFileMaxHeight Int32 R/W SvgSingleFile=true のとき、複数ページを単一ページに割り付けたときの高さの最大値を指定します。値には単位を付けなければなりません。 SvgSingleFileMaxPagesSvgSingleFileMaxHeightのどちらかまたは両方を指定した場合は、最大サイズ(SvgSingleFileMaxHeight)または最大ページ数(SvgSingleFileMaxPages)のどちらかを超えたときエラーとして処理を中止します。 このパラメータが省略されたときは高さを制限しません。
SvgSingleFileMaxPages Int32 R/W SvgSingleFile=trueを指定したとき出力する最大ページ数を指定します。このメソッドが省略されたときは "5000" が指定されたものとみなします。 SvgSingleFileMaxPagesSvgSingleFileMaxHeightのどちらかまたは両方を指定した場合は、最大サイズ(SvgSingleFileMaxHeight)または最大ページ数(SvgSingleFileMaxPages)のどちらかを超えたときエラーとして処理を中止します。
SvgImageDownsamplingDPI Int32 R/W イメージを埋め込むときのダウンサンプリングの解像度を1以上の整数で指定します。もとのイメージの解像度が指定より低い場合はそのままの解像度で埋め込みます。
SvgImageDownsamplingMethod Int32 R/W ダウンサンプリング時の圧縮法を指定します。このパラメータが省略されたときは "IMGDOWNSAMPLING_AVERAGE" が指定されたものとみなします。
1.バイリニア法
2.バイキュービック法
3.ニアレストネイバー法

プロパティ – INX出力の設定

名前 入出力 機能
InxOutputMode Int32 R/W INX(InDesign® Interchange ファイル)出力モードを指定します。
0.テキストエリア単位出力モード
1.行単位出力モード
2.ブロック単位出力モード

プロパティ – Flash出力の設定

名前 入出力 機能
FlashPartiallyOutput Boolean R/W Flash出力でエラーが起きたときFlashを途中まで出力するようにします。
FlashHidePageButton Boolean R/W Flash出力で、ページ送りボタンを出力しません。
FlashSplitPage Boolean R/W Flash出力で、1ページごとに別ファイルに出力します。
FlashOutputAction Boolean R/W Flash出力で、ActionScript1.0を利用した機能(ページごとの停止、ページ送りボタン、リンクなど)を出力しません。
FlashImageLimitSize Long R/W Flashファイルに出力するイメージの最大ピクセル数を整数値で指定します。出力するイメージの幅、もしくは高さの長い辺が指定値を超えたとき、指定値に縮小して出力します。このパラメータが省略されたときは 1000 が適用されます。
Flashに埋め込めるイメージサイズは、ピクセル数で 幅×高さ が 2の24乗(16,777,216)までに制限されています。このサイズを超えたイメージが埋め込まれていると Flash Player で表示できないことがありますので注意してください。

プロパティ – 印刷設定

印刷設定のプロパティは、Windows版のみ対応しています。

名前 入出力 機能
PrnCopies Int32 R/W プリンタに出力のとき有効で、印刷する部数を指定します。 指定されなかった場合は 1とみなされます。
PrnCollate Boolean R/W プリンタに出力のときに出力部数が複数のときにのみ有効です。 指定されなかったときや falseが指定されたときは、同一ページを続けて複数部印刷します。 true が指定されたときは、指定開始ページから終了ページまでの印刷を繰り返します。
BatchPrint Boolean R/W falseを指定すると、印刷時に印刷設定ダイアログを表示します。 省略したときや、trueを指定したときは印刷設定ダイアログは表示されません。
PrnFitPaper Boolean R/W プリンタに出力のときにサイズを用紙に合わせて印刷します。デフォルト値はfalseです。

プロパティ – ラスタライズ設定

名前 入出力 機能
RasterDPI Int32 R/W 出力時の画像サイズを1~1,440(dpi) の範囲の整数値で指定します。このパラメータが範囲外であるか省略されたとき Windows では画面のフォントサイズで設定されている DPI値 が適用されます。
出力できる画像の最大サイズは、空きメモリ容量など Windows のシステムリソースに依存します。
RasterScale String R/W 出力時の縮小率を 0 より大きく 1 以下の範囲の数値で指定します。% 値または px(ピクセル)値で指定することもできます。このパラメータが範囲外であるか省略された場合 1 が適用されます。
RasterHeight Int32 R/W RasterScale で決まる出力イメージの最大高さを px(ピクセル)値で指定します。
RasterFormat String R/W 出力時のファイル名命名フォーマットを指定します。
RasterJpegQuality Int32 R/W JPEG への変換品質を 1~100(%)の値で指定します。このパラメータが省略されたときは 80 が指定されたものとみなします。
RasterUseGdiPlus Boolean R/W trueを指定するとイメージ変換にGdiPlusを使用します。この指定は Windows 7以降 / Windows Server 2008以降 でのみ有効です。
RasterMonochrome Boolean R/W trueを指定すると白黒画像として出力します。
RasterRGBProfile String R/W CMYK TIFF 出力時に、入力側のICCプロファイルをフルパスで指定します。
RasterCMYKProfile String R/W CMYK TIFF 出力時の出力用 CMYK用 ICCプロファイルをフルパスで指定します。
RasterGrayscale Boolean R/W 256階調のグレイスケールにして出力します。
Raster256Color Boolean R/W 256色カラーにして出力します。
RasterCompression String R/W TIFF/MTIFFへ出力する場合の圧縮方法を指定します。
none : None
lzw : LZW compression
dct : DCTDecode
flate : FlateDecode
runlength : Run Length compression
ccitt3 : CCITT Group3
ccitt4 : CCITT Group4
このパラメータが省略されたときは lzw が適用されます。

プロパティ – スムージング処理

名前 入出力 機能
GdiTextAntialias Boolean R/W trueが指定された場合、文字のスムージング処理を行います。
GdiLineartSmoothing Boolean R/W trueが指定された場合、線画のスムージング処理を行います。
GdiImageSmoothing Boolean R/W trueが指定された場合、イメージのスムージング処理を行います。
  これらのプロパティは Windows 7以降 / Windows Server 2008以降 でのみ有効です。

プロパティ – すかし文字列処理

名前 入出力 機能
WatermarkText String R/W 各ページに、指定したすかし文字列を表示します。\n で区切ることによって複数行にすることができます。評価版のときは無効です。
WatermarkFontFamily String R/W watermark-text で指定した文字列に対するフォントファミリを指定します。
WatermarkFontWeight String R/W watermark-text で指定した文字列に対するフォントの太さを指定します。normal、bold または 100~900 の数値が指定できます。
WatermarkFontStyle String R/W watermark-text で指定した文字列に対するフォントスタイルを指定します。normal または italic が指定できます。
WatermarkOpacity String R/W wmark-text で指定した文字列に対する不透明度を指定します。

プロパティ – PDF注釈設定

名前 入出力 機能
PdfAnnotation Boolean R/W PDFの注釈の出力の設定をします。
PDF入力時のみ有効です。

プロパティ – Word 目次の設定

名前 入出力 機能
PageNumberCorrection Boolean R/W 組版結果を元に目次部分のページ番号を調整し書き換えます。また、ページ番号挿入で表示されるページ総数を組版後のページ総数に書き換えます。

プロパティ – Word アウトラインレベル出力の設定

名前 入出力 機能
DocPdfBookmarkLevel int R/W WordのアウトラインレベルをPDFのしおりの階層に反映するかどうか指定します。
0 : 階層を生成しません。
1-9 : 階層を生成して値の階層で畳みます。

プロパティ – Word 変更履歴出力の設定

名前 入出力 機能
DocTrackChange Boolean R/W Wordの変更履歴を出力します。変更箇所の文字属性、文字色などを、「オプション設定ファイル」で指定することができます。

プロパティ – Excel ページ番号設定

名前 入出力 機能
ContinuePageNumber Boolean R/W ヘッダフッタで、ページ番号を全シートで連番/ページ数を全シート合計にします。

プロパティ – Excel シート指定

名前 入出力 機能
SheetOrderSelect String R/W 指定したシートを順番に出力します。
「,」で数値を出力順に指定します。
「-」で数値範囲指定も可能です。
数値は1オリジン、Excel上で表示されているシートが対象となり、非表示指定されているシートは数にカウントされません。 指定されたシートがない場合は無視します。
後述のSheetOrderActiveFirstと並存可能です。SheetOrderActiveFirst指定時は、SheetOrderActiveFirstに続けて指定数値のシートを出力します。ただし、指定数値にSheetOrderActiveFirstと同じシートがあっても指定どおり出力します。
SheetOrderActiveFirst Boolean R/W アクティブシートを先頭に出力し、以降はシート順序どおりにアクティブシート抜きで出力します。
XlsSelectedSheet Boolean R/W Excel上で選択状態のシートだけを出力します。
SheetOrderSelect、SheetOrderActiveFirstと並存可能です。
並存した場合は、SheetOrderSelect、SheetOrderActiveFirstを適用し出力対象となったシートのうち、Excel上で選択状態のシートを出力します。

プロパティ – Excel Locale指定

名前 入出力 機能
Locale String R/W Excelの変換で使用するLocaleを文字列で指定することができます。対象外の場合は、en-USが指定されたとして変換されます。
対応しているLocaleは以下のとおりです。
  • en-US 英語(米国)
  • ja-JP 日本語(日本)
  • de-AT ドイツ語 (オーストリア)
  • de-CH ドイツ語 (スイス)
  • de-DE ドイツ語 (ドイツ)
  • de-LU ドイツ語 (ルクセンブルク)
  • en-GB 英語 (イギリス)
  • en-IE 英語 (アイルランド)
  • es-ES スペイン語 (スペイン)
  • fr-BE フランス語 (ベルギー)
  • fr-CH フランス語 (スイス)
  • fr-FR フランス語 (フランス)
  • fr-LU フランス語 (ルクセンブルク)
  • it-CH イタリア語 (スイス)
  • it-IT イタリア語 (イタリア)
  • nl-BE オランダ語 (ベルギー)
  • nl-NL オランダ語 (オランダ)
  • pt-PT ポルトガル語 (ポルトガル)

プロパティ – Excel 列幅と行高の調整に関する指定

名前 入出力 機能
RowColControlParameter String R/W 列幅と行高を指定したパラメータ値で拡大縮小します。
パラメータ値はカンマ区切りでrow,colの順番で指定します(例:"100%,120%"など)。
RowColControlFileName String R/W 列幅と行高を指定したファイルの記述に従って拡大縮小します。
XMLファイル名を指定します。XMLファイルの記述に関してはExcel変換の項目を参照。
XlsInfoView Boolean R/W Excelファイルの内部情報をエラーレベル(情報)として戻す場合にtrueを指定します。内部情報とは(デフォルトフォント,各シートのプリンタ名)です。

プロパティ – Excel 用紙指定

名前 入出力 機能
XlsPaper String R/W 用紙などの指定を行います。
パラメータ値はカンマ区切りで記述され、先頭から順番に解釈されます(例:"A4,portrait"など)。
用紙サイズ・用紙方向・余白・拡大縮小の4つの要素を指定可能です。
記述に関してはExcelの用紙設定機能を参照。
XlsPaperDefault String R/W 用紙などのデフォルト値を指定します。
パラメータ値はカンマ区切りで記述され、先頭から順番に解釈されます(例:"custom:1000mm:1200mm,sheet:portrait,page:2:1,margin:10mm:10mm:15mm:15mm"など)。
用紙サイズ・用紙方向・余白・拡大縮小の4つの要素を指定可能です。
記述に関してはExcelの用紙設定機能を参照。

プロパティ – Excel Sheet単位のPDF分冊出力

名前 入出力 機能
MultiVolume Boolean R/W ExcelファイルをPDFに変換する場合、Sheet単位でPDFファイルを分割します。
StartVolume long R/W Sheet単位でPDFファイルを分割する場合、出力の開始ボリューム。
EndVolume long R/W Sheet単位でPDFファイルを分割する場合、出力の終了ボリューム。
PdfFormat String R/W 出力するPDFが複数になる場合のファイル名命名フォーマット。 例えば、出力ファイル名が workbook.pdf の場合、  "-01" と指定すれば、workbook-01.pdf、workbook-02.pdf、… となります。  デフォルト値は "1"です。

プロパティ – PowerPoint ノートレイアウト出力の設定

名前 入出力 機能
PptNotes Boolean R/W PowerPoint のノートレイアウトを出力します。

プロパティ – オープンパスワード

名前 入出力 機能
OpenPassword String W Microsoft Office 97-2019で作成されたWord/Excel/Powerpoint(doc/xls/ppt/docx/xlsx/pptx)、およびPDFに設定されているパスワード保護を解除することができます。 Microsoft Office 2007/2010で対応している暗号化アルゴリズムは、ハッシュが SHA-1 、暗号は AES 128 となります。Microsoft Office 2013/2016/2019で対応している暗号化アルゴリズムは、ハッシュが SHA-512 、暗号は AES 128 となります。

プロパティ – テキスト入力の設定

名前 入出力 機能
TextPaperWidth
TextPaperHeight
String R/W 入力データにテキスト形式を指定した場合の用紙サイズを指定します。
TextMarginLeft
TextMarginTop
TextMarginRight
TextMarginBottom
String R/W 入力データにテキスト形式を指定した場合の余白サイズを指定します。
TextFontFamily String R/W 入力データにテキスト形式を指定した場合のフォントファミリ名を指定します。
TextFontSize String R/W 入力データにテキスト形式を指定した場合のフォントサイズを指定します。
TextShowPageNumber Boolean R/W 入力データにテキスト形式を指定した場合にページ番号を表示します。
TextShowLineNumber Boolean R/W 入力データにテキスト形式を指定した場合に行番号を表示します。
TextLineNumberOffset String R/W 入力データにテキスト形式を指定して行番号を表示する場合の表示位置を本文領域からのオフセット値で指定します。
TextLineNumberFormat String R/W 入力データにテキスト形式を指定して行番号を表示する場合の表示形式を指定します。
  変換元ファイルが小さいと、エンコーディングの判定ができず読み込みに失敗することがあります。

値に付加する単位には、次のいずれかが指定できます。

表記 意味
cm センチメートル
mm ミリメートル。 1mm = 0.1cm
in インチ。 1in = 2.54cm
pt ポイント。 1pt = 1in/72
pc パイカ。 1pc = 12pt
jpt 1jpt = 0.3514mm
q 1q = 0.25mm

メソッド

DfvObjクラスの提供するメソッドは次のとおりです。

名前 戻り値 引数 機能
Dispose なし なし リソースを解放します。オブジェクトの使用を終了するときは、このメソッドを呼ぶようにしてください。
Execute なし なし 変換を実行し、OutputFilePathで指定された出力先、もしくはPrinterNameで指定されたプリンタに出力します。
Clear なし なし 変換エンジンを初期化します。
GetFormattingError なし errlist : Collections.ArrayList 変換終了後に呼ぶことができます。変換中に発生したExitLevel未満のエラーレベルを持つエラー情報を取得し、引数に指定したCollections.ArrayListへ格納します。エラー情報はXfoErrorInformationクラスのオブジェクトとしてArrayListに格納されます。 XfoErrorInformationクラスにはエラー情報としてErrorLevelErrorCodeErrorMessageという3つのプロパティが存在します。
GetOptionFileURI String index : Int32 指定したインデクスからオプション設定ファイルのURIを取得します。
AddOptionFileURI なし fileURI : String Office Server Document Converter V8.0 のオプションを記述したXML形式のオプション設定ファイルのURIを追加します。オプション設定ファイルの内容は、直ちに評価されます。すでに設定されているプロパティと背反する設定は上書きされます。
Render なし inputStream : Stream
outputStream : Stream
outDevice : String
inputStreamに指定されたドキュメントの変換を実行し、outDeviceに指定された出力形式でoutputStreamへ出力します。

プログラミング例

下記はC#のプログラミング例です。 この他、[Install directory]/​samples/​dotnet にC#、VisualBasic.NET用のサンプルファイルがいくつか含まれています。

using System; public class MainApp { static public void Main() { DfvDotNetCtl.DfvObj obj = new DfvDotNetCtl.DfvObj(); obj.DocumentURI = "c:\\temp\\test.ppt"; obj.OutputFilePath = "c:\\temp\\test.pdf"; obj.ExitLevel = 4; try { obj.Execute(); } catch(XfoException e) { Console.WriteLine("ErrCode : " + e.ErrorCode + "\n" + e.Message); } catch(Exception e) { Console.WriteLine(e.Message); } finally { obj.Dispose(); } } }