以下にHTML Help ActiveXコントロールのコマンドを示します。
一部のコマンドは、Web形式のHTML Helpでは使用できません。
次のコマンド名の後の(C)はコンパイル形式でのみ使用可能なコマンド、(C/W)はコンパイル形式とWeb形式の両方で使用可能なコマンドを示します。
- ALink(C)
- Aリンク名を含むトピックへのリンクを設定します。
- Close(C)
- HTML Helpウインドウを閉じます。
- Contents(C/W)
- 目次を表示します。
- HH Version(C/W)
- HTML Help ActiveX コントロールのバージョン番号を表示します。
- Index(C/W)
- キーワードを表示します。
- KLink(C)
- Kリンク名(キーワード)を含むトピックへのリンクを設定します。
- Related Topics(C/W)
- 指定したトピックファイルへのリンクを設定します。
- Shortcut(C)
- Windowsプログラムへのショートカットを作成します。
- Splash(C/W)
- ヘルプの起動画面を表示します。
- TCard(C)
- トピックにトレーニングカード機能を付加します。
- WinHelp(C)
- WinHelpを表示します。
指定したAリンク名を含むトピックファイルへのリンクを設定し、ジャンプ先のトピック一覧を表示します。
トピック一覧はダイアログまたはポップアップメニューに表示されます。
- トピックファイルにAリンク名を挿入するには、[Edit]メニューの[Compiler Information]を使用します。
- ALinkコマンドは、コンパイルしたHTML Helpでのみ有効です。
構文
<PARAM name="Command" value="ALink [,menu|dialog]">
<PARAM name="Item1" value="chmファイルのパス名">
[<PARAM name="Item2" value="Aリンク名"> ]
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Default Topic" value="代替ファイルのパス名またはURL">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[,PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Flags" value=",,1">]
[<PARAM name="Flags" value="1">]
[<PARAM name="Frame" value="フレーム名">]
[<PARAM name="Text" value="Text:リンクテキスト">]
パラメータ
- Command:
- ALinkコマンドを呼び出します。オプションでトピック一覧をポップメニューに表示するか(menu)、ダイアログに表示するか(dialog)を指定できます。"ALink,menu"のようにAlinkの後にカンマ(,)で区切って指定します。オプションを省略すると、ダイアログに表示されます。
- Item1:
- 複数のchmファイルを結合する場合に、Aリンク名が含まれているchmファイルのパス名を指定します。""のようにファイル名を指定しないと、現在のchmファイル中でAリンク名を含むトピックが一覧表示されます
- Item2:
- トピックファイルに挿入されているAリンク名を指定します。複数のAリンク名を指定する場合は、同様に<PARAM name="Item3"
value="Aリンク名"><PARAM name="Item4" value="Aリンク名">と続けて指定します。
- Button:
- Aリンクのボタンのスタイルを指定します。
Text
ラベル付きボタンを表示します。
「Text:」の後にラベルのテキストを指定します。
Bitmap
指定したビットマップをボタンにします。
「Bitmap:」の後にビットマップファイル(*.bmp)のパス名を指定します。
「Bitmap:Shrtcut」と指定すると、ショートカットボタンが表示されます。
Icon
指定したアイコンをボタンにします。
「Icon:」の後にアイコンファイル(*.ico)のパス名を指定します。
- Buttonパラメータの値に""を指定するか、Buttonパラメータを省略すると、ラベルのないミニボタンが表示されます。
- Buttonで指定したBMPファイルまたはアイコンファイルは、[Project]タブの[FILES]セクションで指定する必要があります。
- Default Topic:
- ジャンプ先のトピックファイルが見つからない場合に、代わりに表示するHTMLファイルのURL/パス名を指定します。
- Font:
- ボタンのラベルまたは<PARAM name="Text">でテキストリンクを設定した場合のテキストのフォント属性を指定します。フォント名、フォントサイズ(単位:ポイント)、文字コードセット、色、スタイル(PLAIN、BOLD
ITALIC、UNDERLINE)をカンマ(,)で区切って指定します。
- Flags:
- ",,1"とカンマ(,)を2つ続けた後で1を指定すると、指定したAリンク名を含むトピックが存在しない場合にボタンを無効(グレー表示)にします。
"1"と指定すると、指定したAリンク名を含むトピックが1つだけの場合もトピック一覧のダイアログまたはポップアップメニューを表示します。
""のみ指定した場合は、Aリンク名を含むトピックが存在しない場合に「この項目に対応するヘルプトピックはありません」と知らせるダイアログを表示します。Aリンク名を含むトピックが1つだけの場合は、トピック一覧を表示せず、すぐにそのトピックにジャンプします。
<PARAM name="Flags" value=",,1">
<PARAM name="Flags" value="1">
のように、value=",,1"とvalue="1"の両方を同時に指定できます。
- Frame:
- フレーム使用時に、トピックを表示するフレーム名を指定します。このパラメータを省略すると、現在のフレームに表示されます。
- Text:
- テキストをクリックしたときにAリンクを呼び出します。「Text:」の後にリンクテキストを入力します。
- トピックファイルの他の文字はInternet Explorerで設定したフォントで表示されるのに対し、リンクテキストの部分のみはFontパラメータで指定したフォント属性になるため、アンバランスになる場合があります。
フォント属性を他の部分と揃えるには、トピックファイル本文全体のフォントの属性をカスケーディングスタイルシートで指定し、同じフォント属性をFontで指定してください。またはTextパラメータのかわりにClickメソッドまたはHHClickメソッドを使用してリンクテキストを指定してください。この場合はリンクテキストのフォント属性は、トピックファイルの他の部分と同じ属性になります。
(一覧に戻る)
カレントトピックが表示されいてるHTML Helpウインドウを閉じます。
- Closeコマンドは、コンパイル形式でのみ有効です。
構文
<PARAM name="Command" value="Close">
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[, PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Text" value="Text:リンクテキスト">]
パラメータ
- Command:
- Closeコマンドを呼び出します。
その他のパラメータはALinkと同じです。
詳細は「ALink」の項をご覧ください。
(一覧に戻る)
指定した目次ファイルの内容に基づいて目次を表示します。
構文
<PARAM name="Command" value="Contents">
<PARAM name="Item1" value="目次ファイルのパス名">
<PARAM name="Flags" value="0xn,0xn">
パラメータ
- Command:
- Contentsコマンドを呼び出します。
- Item1:
- 目次ファイル(*.hhc)のパス名を指定します。
- Flags:
- 目次のスタイルの組み合わせを0xから始まる16進数で指定します。
HTML Help Workshopの
(HTML
Help ActiveX Control)で[Table of Contents ]を選んでスタイルを選択すると、<PARAM name="Flags"
value="0x4000,0x800035">のように値が表示されますので、その値を参考にしてください。
省略すると、初期設定のスタイルになります。
- キーワードのスタイルは変更できませんので、目次のボーダーやエッジのスタイルを変更すると、キーワードとの釣り合いがとれなくなります。
(一覧に戻る)
HTML Help ActiveX コントロールのバージョン番号をダイアログに表示します。
構文
<PARAM name="Command" value="HH Version">
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[, PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Text" value="Text:リンクテキスト">]
パラメータ
- Command:
- HH Versionコマンドを呼び出します。
その他のパラメータはALinkと同じです。
詳細は「ALink」の項をご覧ください。
(一覧に戻る)
指定した索引ファイル(*.hhk)の内容に基づいてキーワードを表示します。
構文
<PARAM name="Command" value="Index">
<PARAM name="Item1" value="索引ファイルのパス名">
パラメータ
- Command:
- Indexコマンドを呼び出します。
- Item1:
- 索引ファイル(*.hhk)のパス名を指定します。
(一覧に戻る)
指定したKリンク名(キーワード)を含むトピックファイルへのリンクを設定し、ジャンプ先のトピック一覧を表示します。
トピック一覧はダイアログまたはポップアップメニューに表示されます。
HTMLファイルにキーワードを挿入するには、[Edit]メニューの[Compiler Information]を使用します。
- KLinkコマンドは、コンパイル形式でのみ有効です。
構文
<PARAM name="Command" value="KLink [,menu|dialog]">
<PARAM name="Item1" value="chmファイルのパス名">
[<PARAM name="Item2" value="キーワード"> ]
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Default Topic" value="代替ファイルのパス名またはURL">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[, PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Flags" value=",,1">]
[<PARAM name="Flags" value="1">]
[<PARAM name="Frame" value="フレーム名">]
[<PARAM name="Text" value="Text:リンクテキスト">]
パラメータ
- Command:
- KLinkコマンドを呼び出します。オプションでトピック一覧をポップメニューに表示するか(menu)、ダイアログに表示するか(dialog)を指定できます。"KLink,menu"のようにKlinkの後にカンマ(,)で区切って指定します。オプションを省略すると、ダイアログに表示されます。
- Item1:
- 複数のchmファイルを結合する場合に、キーワードが含まれているchmファイルのパス名を指定します。 ""のようにファイル名を指定しないと、現在のchmファイル中でキーワードを含むトピックが一覧表示されます
- Item2:
- トピックファイルに挿入されているキーワードを指定します。複数のキーワードを指定する場合は、同様に<PARAM name="Item3"
value="キーワード"><PARAM name="Item4" value="キーワード">と続けて指定します。
その他のパラメータはALinkと同じです。
詳細は「ALink」の項をご覧ください。
(一覧に戻る)
指定したトピックファイルへのリンクを設定し、ジャンプ先のトピック一覧を表示します。
トピック一覧はダイアログまたはポップアップメニューに表示されます。
ALink、KLinkの場合は、1つのAリンク名、キーワードを指定すると、そのAリンク名、キーワードが挿入されているすべてのトピックファイルのタイトルがそのまま一覧表示されるのに対し、Related
Topicsの場合は、トピックファイル名を指定し、一覧表示されるタイトルには任意の文字列を指定できます。
構文
<PARAM name="Command" value="Related Topics [,menu|dialog]">
<PARAM name="Item1" value="トピックタイトル1;トピックファイルのURL/パス名;代替URL/パス名">
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[, PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Frame" value="フレーム名">]
[<PARAM name="Text" value="Text:リンクテキスト">]
パラメータ
- Command:
- Related Topicsコマンドを呼び出します。オプションでトピック一覧をポップメニューに表示するか(menu)、ダイアログに表示するか(dialog)を指定できます。"Related
Topics,menu"のようにRelated Topicsの後にカンマ(,)で区切って指定します。オプションを省略すると、ダイアログに表示されます。
- Item1:
- 次の3つをカンマ(,)で区切って指定します。
- ジャンプ先のトピックのタイトル。任意の文字列を指定できます。
- トピックファイルのURLまたはパス名
- 指定したURL/パス名にアクセスできない場合の代替のURL/パス名(省略可能)
複数のトピックファイルを指定する場合は、同様に<PARAM name="Item2" ・・・ ><PARAM name="Item3"
・・・ >と続けて指定します。
その他のパラメータはALinkと同じです。
詳細は「ALink」の項をご覧ください。
(一覧に戻る)
プログラムへのショートカットを作成します。
構文
<PARAM name="Command" value="ShortCut">
<PARAM name="Item1" value="ウインドウクラス,プログラム名,パラメータ">
<PARAM name="Item2" value="メッセージ,wParam,lParam">
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[, PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Text" value="Text:リンクテキスト">]
- Shortcutコマンドは、コンパイル形式でのみ有効です。
パラメータ
- Command:
- ShortCutコマンドを呼び出します。
- Item1:
- プログラムのウインドウクラス、実行ファイル名、プログラムに渡すパラメータをカンマ(,)で区切って指定します。
実行ファイル名を指定せず、パラメータに文書ファイル名を指定すると、そのファイルに関連付けられているアプリケーションが自動的に起動して指定したファイルが開きます。
- Item2:
- プログラムに送るメッセージ、wParam、lParamをカンマ(,)で区切って指定します。(省略可能)
その他のパラメータはALinkと同じです。
詳細は「ALink」の項をご覧ください。
(一覧に戻る)
HTML Help ActiveXコントロールが挿入されたHTMLファイルが開く時に、指定した時間だけイメージデータを表示します。
HTML Helpヘルプ起動時の起動画面として使用します。
構文
<PARAM name="Command" value="Splash">
<PARAM name="Item1" value="イメージファイルのパス名">
<PARAM name="Item2" value="表示時間">
パラメータ
- Command:
- Splashコマンドを呼び出します。
- Item1:
- 表示するイメージファイル(*.bmp、*.gif、*.jpg)のパス名を指定します。
- Item2:
- イメージの表示時間をミリ秒(1ミリ秒=1/1000秒)で指定します。
(一覧に戻る)
プログラムにWindowsのWM_TCARDメッセージを送り、トレーニングカードトピックを表示するか、その他のアクションを起こします。
トレーニングカードは、プログラムと直接やりとりするヘルプトピックです。ユーザーがヘルプウインドウ内のボタンをクリックするなどのアクションを起こすと、それに応じたメッセージをプログラムに送ります。プログラムはそのメッセージを処理し、特定のアクションを起こします。
チュートリアルヘルプで、ユーザにアプリケーションを実際に操作させ、それに応じてヘルプトピックを表示する場合などに使用します。
- TCardコマンドは、コンパイル形式でのみ有効です。
構文
<PARAM name="Command" value="TCard">
<PARAM name="Item1" value="wParam,lParam">
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[, PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Text" value="Text:リンクテキスト">]
パラメータ
- Command:
- TCardコマンドを呼び出します。
- Item1:
- WM_TCARDメッセージに渡すwPARAMとlPARAMを指定します。
wPARAMには通常ユーザーのアクションのIDを指定します。wPARAMには数値のみ指定できます。
lPARAMは追加の情報を指定します。wPARAMによって、lPARAMの内容は異なります。lPARAMには数値または文字列を指定できます。
その他のパラメータはALinkと同じです。
詳細は「ALink」の項をご覧ください。
- スクリプト言語でTCardコマンドを何度も呼び出すような場合には、TCardメソッドを使用します。
(一覧に戻る)
HTML HelpからWinHelp(*.hlp)のウインドウを開き、指定したWinHelpトピックを表示します。
WinHelpのメインウインドウ、2次ウインドウ、ポップアップウインドウのいずれかの中にトピックを表示できます。WinHelpウインドウの外見は、WinHelpのプロジェクトファイル(*.hpj)で指定した内容になります。
- WinHelpコマンドは、コンパイル形式でのみ有効です。
構文
<PARAM name="Command" value="WinHelp [,Popup]">
<PARAM name="Item1" value="WinHelpヘルプファイルのパス名[>ウインドウ名]">
<PARAM name="Item2" value="トピックID|マップ番号">
[<PARAM name="Button" value="[Text:ボタンのラベル|Bitmap:BMPファイルのパス名|Icon:アイコンファイルのパス名]">]
[<PARAM name="Font" value="フォント名[,フォントサイズ[,文字コードセット[,色[, PLAIN BOLD
ITALIC UNDERLINE]]]]">]
[<PARAM name="Text" value="Text:リンクテキスト">]
パラメータ
- Command:
- WinHelpコマンドを呼び出します。
- Item1:
- 呼び出す"WinHelpヘルプファイル(*.hlp)のパス名を指定します。
>に続けてトピックを表示するウインドウ名(WinHelpヘルプの二次ウインドウ名)を指定できます。ウインドウ名を指定しない場合は、メインウインドウに表示されます。
CommandパラメータでPopupを指定した場合は、ウインドウ名は指定しません。
- Item2:
- 表示するWinHelpのトピックのトピックIDまたはマップ番号を指定します。
その他のパラメータはALinkと同じです。
詳細は「ALink」の項をご覧ください。
(一覧に戻る)