.NETインターフェイス

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

Windows版

Linux版

注意: .NETインターフェイスを利用するとき、Docx to HTML V2.0 と他のバージョンの Docx to HTML を同一マシンにインストールしておくことはできません。どちらかをアンインストールして、環境変数PATHに不要な Docx to HTML へのPATHが含まれないようにしてください。

コンポーネントの登録

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

.NETコンポーネントファイル名.NET 8用DhcDotNetMCtl20.dll

クラス

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

名前 機能
DhcObj Docx to HTML V2.0 本体のクラスです。DhcObj

以下はC#の例です。

DhcObj adhc = new(); try { // 何かの処理 } catch (Exception e) { Console.WriteLine(e.Message); }

メソッド

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

名前 戻り値 引数 機能
execute なし なし 変換を実行し、setDocumentURIで指定された出力先に出力します。
setDocumentURI なし newVal : string 入力ファイル名を指定します。
newVal
入力ファイルのパスを指定します。
setOutputFilePath なし newVal : string 出力ファイル名を指定します。
newVal
出力ファイルのパスを指定します。
clrSettings なし なし オプション設定をクリアします。
lodeSettings なし newVal : string 指定した変換オプション設定ファイルを読み込みます。
newVal
変換オプション設定ファイルのパスを指定します。
setEnableXHTML なし newVal : bool タグ出力の文法を指定します。
newVal
trueの場合XML文法、falseの場合HTML文法を指定します。
setViewportContent なし content : string <head>に次の形式のメタタグを出力するように指定します。
<meta name="viewport" content="contentに指定した内容">
content
content属性に入力する属性値を指定
setEnableENDL なし newVal : bool ブロックタグの終わりに改行を出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setEnableEmptyParagraph なし newVal : bool Wordの空の行(改行のみの行)の扱いを指定します。
newVal
trueの場合空行を無視します、falseの場合、空行の数だけ空の<p>タグを出力します。
setEnableNonRefId なし newVal : bool Wordでは編集を重ねると文書ファイル内に参照されていないIDがdocxファイル内に沢山できてしまいます。
これらの内部的に参照されていないIDをHTML出力時に削除するかどうかを指定します。
newVal
trueの場合は削除しません、falseの場合は削除します。
setEnableImgWidth なし newVal : bool イメージの幅を出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setEnableHeadingStrong なし newVal : bool 見出しスタイルで指定された強調を無視するどうかを指定します。
newVal
trueの場合は無視します、falseの場合は出力します。
setEnableEmbedimage なし newVal : bool 画像をデータURLで本体HTMLに埋め込むかどうかを指定します。
newVal
trueの場合埋め込みます、falseの場合は画像はimageフォルダーに出力されます。
setEnableMathML なし newVal : bool Wordの数式エディタで編集した数式を<img>タグにMathML形式ファイルで出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setXmlMathML なし newVal : bool Wordの数式エディタで編集した数式をMathML形式マークアップで出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setOMath なし newVal : bool Wordの数式エディタで編集した数式をWord独自のOffice Math形式で出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setThroughImage なし newVal : bool Wordに挿入した元の画像形式のまま出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setEnablePStyle なし newVal : bool 段落のスタイル名をclass属性の値として出力するか指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setEnableCitation なし newVal : bool Citationフィールドのtagの値を<a>タグのhref属性の値に設定して出力するかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setTextColor なし newVal : bool 文字に指定されている色を<span style="color:カラー値">として出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setItalic なし newVal : int 文字に斜体が指定されているときの出力方法を指定します。
newVal
斜体の出力方法
0 : 出力しない(デフォルト)
1 : <i>タグとして出力
2 : <span style="font-style:italic">として出力
setUnderline なし newVal : int 文字に下線が指定されているときの出力方法を指定します。
newVal
下線の出力方法
0 : 出力しない(デフォルト)
1 : <u>タグとして出力
2 : <span style=""text-decoration-line:underline;">として出力
setLinethrough なし newVal : int 文字に取り消し線が指定されているときの出力方法を指定します。
newVal
取り消し線の出力方法
0 : 出力しない(デフォルト)
1 : <del>タグとして出力
2 : <span style=""text-decoration-line: line-through;">として出力
setEncoding なし newVal : string HTMLファイルの文字コード(符号化方式)を指定します。(デフォルト : "UTF-8")
newVal
文字コードを指定します。
setDefstyle なし newVal : bool <head>の<style>要素(デフォルトCSSスタイルを指定する要素)を出力するかどうかを指定します。
newVal
trueの場合は出力しません、falseの場合は出力します。
setSpaceIndent なし newVal : bool 段落先頭に1文字以上の字下げが指定されているとき、字下げを1文字の全角空白に変換するかどうかを指定します。
newVal
trueの場合は変換します、falseの場合は変換しません。
setOutputBR なし newVal : bool 段落を<p>タグで囲む代わりに、段落の終わりに<br>タグを出力するかどうかを指定します。
タグ出力でXML文法指定時は無効です。
newVal
trueの場合は<br>タグを出力します、falseの場合は<p>タグを出力します。
setFileimages なし newVal : bool 画像ファイルを格納するフォルダー名の付け方を指定します。
newVal
trueの場合は"変換先ファイル名.images"、falseの場合は"image"とします。
setCSS なし uri : string
media : string
リンクするCSSファイルを指定します。
uri
CSSファイルのパスを指定します。
media
オプションでmediaを指定できます。
setJS なし newVal : string <head>にscript タグを置き、そのsrc属性にJavaScriptファイルのパス(URL)を指定します。
newVal
JavaScriptファイルのパスを指定します。
saveSettings なし newVal : string オプション設定ファイルのパスを指定します。
setTablestyle なし newVal : bool テーブルスタイルを出力するかどうかを指定します。
newVal
trueの場合は出力します、falseの場合は出力しません。
setSplit なし newVal : int Word文書のアウトラインレベルに応じてHTMLファイルを分割して出力します。
newVal
アウトラインレベルは1~3を指定できます。
setEnableTocout なし newVal : bool 「setSplit」呼び出し時にWordの目次機能で挿入した目次箇所を、別のHTMLファイル(inc-toc.html)として出力します。
inc-toc.htmlはJavaScriptを利用して、分割したHTMLファイルにインクルード(読み込み)できます。inc-toc.htmlには目次箇所のタグ以外の<head>や<body>などのタグは出力されません。
JavaScriptを利用した目次箇所のインクルード方法については、下記Webページにサンプルを用意していますので、ご参考にしてください。
https://www.antenna.co.jp/xhw/sample.html
newVal
trueの場合は別のHTMLファイル(inc-toc.html)として出力します、falseの場合は目次箇所は分割したすべてのHTMLファイルの上部に出力されます。
setPagenavi なし newVal : string 「setSplit」を呼び出した時に分割したHTMLファイルの上部(目次箇所がある場合は目次箇所の直後)と下部に、前のページと次のページに移動するリンクを出力します。
newVal
「ja」を指定した場合は、日本語で「前へ」「次へ」リンクが出力されます。
「ja」以外を指定した場合、英語で「Prev」「Next」リンクが出力されます。
前のページまたは次のページが存在しない場合は、各リンクは省略します。
setLang なし newVal : string 出力するHTMLファイルの<html>タグに出力する言語(lang属性)を指定できます。
newVal
言語コードを指定します。(例. 日本語の場合:ja、英語の場合:en)
「none」を指定した場合は、<html>タグにlang属性を出力しません。
半角英数字、半角のハイフン以外の値を指定した場合は、Word文書から推定して「ja」(日本語)または「en」(英語)を出力します。
「setEnableXHTML」を呼び出した場合は、<html>タグのxml:lang属性とlang属性にそれぞれ指定した言語コードを出力します。
例. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">
setSection なし newVal : int HTMLの<section>(または<div class="section-area">)タグを出力するアウトラインレベルを指定できます。
newVal
1~6の半角数字(整数)を指定することで、指定したアウトラインレベルまでの<section>を出力します。
1~6以外を指定した場合は「6」を指定した場合と同等になります。例えばアウトラインレベル4以下は<section>タグを出力したくない場合は「3」を指定します。
setEndnoteId なし newVal : bool Word文書中に脚注、または文末脚注を挿入する際、脚注/文末脚注の連番の開始番号を「1」以外にした場合に、出力したHTMLの脚注/文末脚注文字(<sup>タグ)の番号と、その脚注/文末脚注を指定する「id」の末尾に使用される番号を一致させることができます。
newVal
trueの場合は有効にします、falseの場合は無効にします。
setFootnote なし newVal : int Word文書中に脚注がある場合に、htmlへの出力方法を指定します。
newVal
脚注がある場合のhtmlへの出力方法
0 : 脚注を文章の最後(分割してHTMLを出力する場合は最後のHTMLファイル内の文章の最後)に出力し、本文中の参照マークに付与したハイパーリンクから、該当の脚注に移動できるようにします。(デフォルト) 脚注は<aside>タグで囲って出力します。 「setEnableXHTML」の引数にtrueを指定した場合は、<div>タグで囲って出力します。
※「0」を指定した場合は、文末脚注も同様の出力をします。
1 : 本文中の参照マークに<span>タグを追加し、「title」属性の値に該当の脚注のテキストを出力し、参照マークのマウスオーバー時にツールチップを表示できます。
2 : 脚注および脚注の参照マークは出力しません。
setCustomSep なし newVal : bool 脚注、および文末脚注を挿入した場合の本文との境界線を指定します。
newVal
trueの場合は標準では境界線をすべて<hr>タグで出力します。Word上で編集した文字列や表を出力することができます。 境界線が含まれる場合は、<hr>タグの代わりに<span>タグで出力されます。falseの場合は出力しません。

サンプルプログラムの実行

[Install directory]/​samples/​dotnet は簡単なサンプルプログラムを含んでいます。

[Working directory]で、このサンプルプログラムを実行するには、次のようにします。
[Working directory]
samples以下のディレクトリをコピーしてください。このとき、DhcDotNetMCtl20.dllを[Working directory]/​​samples/​​dotnetにコピーしてください。

> cd [Working directory]/samples/dotnet > dotnet build sample.csproj > dotnet run ../sample.docx sample.html