execCommand メソッド
| Microsoft FrontPage Visual Basic リファレンス (ページ オブジェクト モデル) |
execCommand メソッド
現在のドキュメント、現在の選択範囲、または指定された範囲を対象に所定のアクションを実行し、コマンドが正しく完了したかどうかを示すブール型 (Boolean) の値を取得します。
expression.execCommand(cmdID, showUI, value)
*expression * 必ず指定します。対象となるオブジェクトへの参照を表すオブジェクト式を指定します。
cmdID 必ず指定します。実行するコマンドを表す文字列型 (String) の値を指定します。
cmdID パラメータには、次のいずれかの文字列型 (String) の値を使用できます。
| コマンド | 説明 |
|---|---|
BackColor |
現在の選択範囲の背景色を設定します。value パラメータに背景色の色名を指定する必要があります。使用できる色名については、「HTML カラー テーブル」を参照してください。
次のコード例では、選択範囲の背景色を黄色に設定します。
メモ 指定には色名を使用する必要があります。Web Safe カラーの RGB 値 (#663399 など) は使用しないでください。 |
Copy |
現在の選択範囲をクリップボードにコピーします。
次のコード例では、選択範囲をクリップボードにコピーします。
|
CreateBookmark |
選択したテキストの部分にブックマークのアンカーを設定します。
次のコード例では、選択したテキストの部分に "newbookmark" という名前のブックマークのアンカーを設定します。
|
CreateLink |
現在の選択範囲にハイパーリンクを挿入します。または、ユーザーが URL を指定して現在の選択範囲にハイパーリンクとして挿入できるダイアログ ボックスを表示します。value パラメータにはそのハイパーリンクの URL を指定する必要があります。
次のコード例は、Microsoft の Web サイトへのハイパーリンクを作成します。
|
Cut |
現在の選択範囲を切り取って、クリップボードにコピーします。
次のコード例では、選択したテキストを切り取って、そのコピーをクリップボードに置きます。
|
Delete |
現在の選択範囲を、コピーを保存せずに削除します。
次のコード例では、選択したテキストを削除します。
|
FontName |
現在の選択範囲にフォントを設定します。value パラメータに、使用するフォントの名前を指定する必要があります。
次のコード例では、選択したテキストに Stencil フォントを設定します。
メモ value パラメータで指定したフォント名のフォントがユーザーのコンピュータで使用できない場合、選択したテキストはブラウザに既定のフォントで表示されます。 |
FontSize |
現在の選択範囲のフォント サイズを設定します。value パラメータに、使用するフォント サイズを指定する必要があります。フォント サイズに指定できる値については、fontSize プロパティを参照してください。
次のコード例では、選択したテキストのフォント サイズを、親要素のフォント設定の 115 パーセントのサイズに設定します。
|
ForeColor |
選択したテキストの色を設定します。value パラメータに、テキストの色名を指定する必要があります。使用できる色名については、「HTML カラー テーブル」を参照してください。
次のコード例では、選択したテキストの色を赤に設定します。
メモ 指定には色名を使用する必要があります。Web Safe カラーの RGB 値 (#663399 など) は使用しないでください。 |
Indent |
選択したテキスト、および同じ親要素に所属するすべてのテキストの前後に BLOCKQUOTE 要素を挿入することによって、そのテキストにインデントを設定します。
次のコード例では、選択したテキストと、関連する周囲のテキストにインデントを設定します。
|
InsertButton |
カーソル位置に BUTTON 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、id 属性の値が "newbutton" の BUTTON 要素をカーソル位置に挿入します。
|
InsertFieldset |
カーソル位置に FIELDSET 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、id 属性の値が "newfield" の FIELDSET 要素をカーソル位置に挿入します。
|
InsertHorizontalRule |
カーソル位置に HR 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。
次のコード例では、カーソル位置に HR 要素を挿入します。
|
InsertIFrame |
カーソル位置に IFRAME 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、インライン フレームに表示されるソース ファイルを指定します。
次のコード例では、src 属性の値が "form.htm" の IFRAME 要素をカーソル位置に挿入します。
|
InsertImage |
カーソル位置に IMG 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、画像ファイルの名前を指定します。
次のコード例では、ドキュメントのカーソル位置に chelan.jpg という画像ファイルを挿入します。
|
InsertInputButton |
カーソル位置にタイプが "button" の INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、id 属性の値が "newbutton" の新しい入力ボタンをカーソル位置に挿入します。
|
InsertInputCheckbox |
カーソル位置にタイプが "checkbox" の INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、id 属性の値が "newcheckbox" の新しいチェック ボックスをカーソル位置に挿入します。
|
InsertInputFileUpload |
カーソル位置にタイプが "fileupload" の INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。テキストの選択範囲にあるファイル アップロード コントロールは上書きされます。
次のコード例では、カーソル位置にタイプが "fileupload" の INPUT 要素を挿入します。
|
InsertInputHidden |
カーソル位置にタイプの "hidden" の INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、非表示の INPUT 要素をカーソル位置に挿入します。
|
InsertInputPassword |
カーソル位置にタイプが "password" の INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置にパスワード入力のためのテキスト ボックスを挿入します。
|
InsertInputReset |
カーソル位置にタイプが "reset" の INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置に [リセット] ボタンを挿入します。
|
InsertInputSubmit |
カーソル位置にタイプが "submit" の INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置に [送信] ボタンを挿入します。
|
InsertInputText |
カーソル位置に INPUT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置に 1 行のテキスト ボックスを挿入します。
|
InsertMarquee |
カーソル位置に MARQUEE 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。
次のコード例では、カーソル位置に新しい MARQUEE 要素を挿入します。
|
InsertOrderedList |
テキストが選択されている場合は、そのテキストを番号付きリスト形式のアイテムにするか、通常の段落のアイテムにするかを切り替えます。テキストが選択されていない場合は、LI 要素を 1 つ持つ OL 要素を挿入します。
次のコード例では、カーソル位置に番号付きリストを挿入するか、選択したテキストを番号付きリストに変換します。
|
InsertParagraph |
カーソル位置に P 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置に新しい段落を挿入します。
|
InsertSelectDropdown |
カーソル位置に SELECT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置に新しいドロップダウン リストを挿入します。
|
InsertSelectListbox |
カーソル位置に、multiple 属性を含む SELECT 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置にリスト ボックスを挿入します。
|
InsertTextArea |
カーソル位置に TEXTAREA 要素を挿入します。テキストが選択されている場合、そのテキストは新しい要素で上書きされます。value パラメータを使用して、この新しい要素の id 属性を指定します。
次のコード例では、カーソル位置に複数行のテキスト ボックスを挿入します。
|
InsertUnorderedList |
テキストが選択されている場合は、そのテキストを記号付きリスト形式のアイテムにするか、通常の段落のアイテムにするかを切り替えます。テキストが選択されていない場合は、LI 要素を 1 つ持つ UL 要素を挿入します。
次のコード例では、カーソル位置に記号付きリストを挿入するか、選択したテキストを記号付きリストに変換します。
|
Italic |
現在の選択範囲を斜体にするか、通常の書体にするかを切り替えます。
次のコード例では、選択したテキストを斜体にするかどうかを切り替えます。
|
JustifyCenter |
選択したテキスト、および同じ親要素に所属するすべてのテキストを中央揃えに設定します。対象となるテキストの配置がすでに中央揃えに設定されている場合、このコマンドはテキストの配置を既定の配置に戻します。
次のコード例では、選択したテキスト、およびそれに関連するすべてのテキストを中央揃えに設定します。
|
JustifyLeft |
選択したテキスト、および同じ親要素に所属するすべてのテキストを左揃えに設定します。対象となるテキストの配置がすでに左揃えに設定されている場合、このコマンドはテキストの配置を既定の配置に戻します。
次のコード例では、選択したテキスト、およびそれに関連するすべてのテキストを左揃えに設定します。
|
JustifyRight |
選択したテキスト、および同じ親要素に所属するすべてのテキストを右揃えに設定します。対象となるテキストの配置がすでに右揃えに設定されている場合、このコマンドはテキストの配置を既定の配置に戻します。
次のコード例では、選択したテキスト、およびそれに関連するすべてのテキストを右揃えに設定します。
|
Outdent |
選択したテキスト、および同じ親要素に所属するすべてのテキストから BLOCKQUOTE 要素を 1 つずつ削除することによって、選択したテキストのインデントを 1 段ずつ減らします。対象箇所が BLOCKQUOTE 要素で囲まれていない場合、このコマンドでは何も行われません。
次のコード例では、選択したテキスト、およびそれに関連するすべてのテキストのインデントを 1 段ずつ減らします。
|
Paste |
現在の選択範囲をクリップボードの内容で上書きします。
次のコード例では、クリップボードの内容をドキュメントのカーソル位置に貼り付けるか、選択したテキストに上書きします。
|
RemoveFormat |
現在の選択範囲のフォントおよび書式設定を削除します。
次のコード例では、選択したテキストの書式設定をすべて削除します。
|
SelectAll |
ドキュメント全体を選択します。
次のコード例では、アクティブ ドキュメントの内容全体を選択します。
|
UnBookmark |
現在の選択範囲からすべてのブックマークを削除します。ブックマークのアンカーが設定されているテキストの一部分のみが選択されている場合は、ブックマークのアンカーはその選択部分の前で終了し、選択部分の後ろで再度開始されます。ブックマークのアンカーが設定されているテキスト全体が選択されている場合は、ブックマーク全体がドキュメントから削除されます。選択範囲に複数のブックマークが含まれている場合は、すべてのブックマークが選択範囲から削除されます。
次のコード例では、選択したテキストからすべてのブックマークを削除します。
|
Underline |
現在の選択範囲を下線付きにするかどうかを切り替えます。
次のコード例では、選択したテキストを下線付きにするかどうかを切り替えます。
|
Unlink |
現在の選択範囲からすべてのハイパーリンクを削除します。ハイパーリンクが設定されているテキストの一部分のみが選択されている場合は、ハイパーリンクはその選択部分の前で終了し、選択部分の後ろで再度開始されます。ハイパーリンクが設定されているテキスト全体が選択されている場合は、ハイパーリンク全体がドキュメントから削除されます。選択範囲に複数のハイパーリンクが含まれている場合は、すべてのハイパーリンクが選択範囲から削除されます。
次のコード例では、選択したテキストからすべてのハイパーリンクを削除します。
|
Unselect |
現在の選択範囲の選択を解除します。
次のコード例では、アクティブ ドキュメント内のテキストの選択を解除し、ドキュメントの先頭にカーソルを配置します。
|
showUI 省略可能です。True を指定すると、対応するダイアログ ボックスが存在する場合、そのコマンドに関連付けられているダイアログ ボックスを表示します。既定値は False です。
value 省略可能です。cmdID パラメータに関連付けられている追加の引数をバリアント型 (Variant) で指定します。たとえば、cmdID パラメータに BackColor コマンドが指定されている場合は、選択範囲に設定する背景色の色名を value パラメータに指定します。
解説
CmdID パラメータで指定されているコマンドが値を設定する場合、そのコマンドを完了させるためには value パラメータが必要です。
value パラメータに要素の id 属性の値を表す文字列が含まれていて、id 属性の値が同じ要素が既に存在している場合、execCommand メソッドは id 属性の値を増分します。たとえば、value パラメータに "newelement" と指定したときに、id 属性が "newelement" の要素が既に存在している場合、execCommand のパラメータで追加される値は "newelement0" となります。"newelement"、"newelement0"、"newelement1" など、同じ id 属性を持つ要素が複数存在する場合、新たに追加される要素の属性の文字列には、次に利用可能な値の数字が追加されます。この例の場合は "newelement2" となります。
execCommand メソッドで使用されるコマンドの多くでは、Microsoft Office FrontPage 2003 のページ ウィンドウでユーザーによるテキストの選択が必要です。コマンド側では選択されたテキストが必要であるにもかかわらず、テキストが選択されていない場合には、execCommand メソッドは失敗し、エラーが表示されます。