CUserTool クラス
ユーザー ツールは、外部アプリケーションを実行するメニュー項目です。 Customize ダイアログ ボックスの Tools タブ (CMFCToolBarsCustomizeDialog クラス) を使用すると、ユーザーはユーザー ツールを追加したり、各ユーザー ツールの名前、コマンド、引数、初期ディレクトリを指定したりできます。
構文
class CUserTool : public CObject
メンバー
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CUserTool::CopyIconToClipboard | |
| CUserTool::D rawToolIcon | 指定した四角形にユーザー ツール アイコンを描画します。 |
| CUserTool::GetCommand | ユーザー ツールに関連付けられているコマンドのテキストを含む文字列を返します。 |
| CUserTool::GetCommandId | ユーザー ツールのメニュー項目のコマンド ID を返します。 |
| CUserTool::Invoke | ユーザー ツールに関連付けられているコマンドを実行します。 |
| CUserTool::Serialize | アーカイブに対して、このオブジェクトの読み取りまたは書き込みを行います。 ( CObject::Serializeをオーバーライドします)。 |
| CUserTool::SetCommand | ユーザー ツールに関連付けられているコマンドを設定します。 |
| CUserTool::SetToolIcon | ツールに関連付けられているアプリケーションからユーザー ツールのアイコンを読み込みます。 |
保護メソッド
| 名前 | 説明 |
|---|---|
| CUserTool::LoadDefaultIcon | ユーザー ツールの既定のアイコンを読み込みます。 |
データ メンバー
| 名前 | 説明 |
|---|---|
| CUserTool::m_strArguments | ユーザー ツールのコマンド ライン引数。 |
| CUserTool::m_strInitialDirectory | ユーザー ツールの初期ディレクトリ。 |
| CUserTool::m_strLabel | ツールのメニュー項目に表示されるツール名。 |
解説
アプリケーションでユーザー ツールを有効にする方法の詳細については、「 CUserToolsManager クラスを参照してください。
例
次の例では、 CUserToolsManager オブジェクトからツールを作成し、 m_strLabel メンバー変数を設定し、ユーザー ツールが実行するアプリケーションを設定する方法を示します。 このコード スニペットは、Visual Studio デモ サンプルの一部です。
// CUserToolsManager* pUserToolsManager
CUserTool* pTool1 = pUserToolsManager->CreateNewTool();
pTool1->m_strLabel = _T("&Notepad");
pTool1->SetCommand(_T("notepad.exe"));
継承階層
要件
Header: afxusertool.h
CUserTool::CopyIconToClipboard
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
BOOL CopyIconToClipboard();
戻り値
解説
CUserTool::D rawToolIcon
指定した四角形の中心にユーザー ツール アイコンを描画します。
void DrawToolIcon(
CDC* pDC,
const CRect& rectImage);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
rectImage
[in]アイコンを表示する領域の座標を指定します。
CUserTool::GetCommand
ユーザー ツールに関連付けられているコマンドのテキストを含む文字列を返します。
const CString& GetCommand() const;
戻り値
ユーザー ツール CString 関連付けられたコマンドのテキストを含むオブジェクトへの参照。
CUserTool::GetCommandId
ユーザー ツールのコマンド ID を返します。
UINT GetCommandId() const;
戻り値
このユーザー ツールのコマンド ID。
CUserTool::Invoke
ユーザー ツールに関連付けられているコマンドを実行します。
virtual BOOL Invoke();
戻り値
コマンドが正常に実行された場合は 0 以外。それ以外の場合は 0。
解説
ShellExecute を呼び出して、ユーザー ツールに関連付けられているコマンドを実行します。 コマンドが空の場合、または ShellExecute が失敗した場合、関数は失敗します。
CUserTool::LoadDefaultIcon
ユーザー ツールの既定のアイコンを読み込みます。
virtual HICON LoadDefaultIcon();
戻り値
読み込まれたアイコン (HICON) のハンドル。既定のアイコンを読み込めない場合は NULL。
解説
フレームワークは、ツールの実行可能ファイルからユーザー定義ツールのアイコンを読み込むことができない場合に、このメソッドを呼び出します。
独自の既定のツール アイコンを指定するには、このメソッドをオーバーライドします。
CUserTool::m_strArguments
ユーザー ツールのコマンド ライン引数。
CString m_strArguments;
解説
この文字列は、 CUserTool::Invoke を呼び出すとき、またはユーザーがこのツールに関連付けられているコマンドをクリックしたときにツールに渡されます。
CUserTool::m_strInitialDirectory
ユーザー ツールの初期ディレクトリを指定します。
CString m_strInitialDirectory;
解説
この変数は、 CUserTool::Invoke を呼び出すとき、またはユーザーがこのツールに関連付けられているコマンドをクリックしたときに、ツールが実行する初期ディレクトリを指定します。
CUserTool::m_strLabel
ツールのメニュー項目に表示されるラベル。
CString m_strLabel;
CUserTool::Serialize
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
virtual void Serialize(CArchive& ar);
パラメーター
[in] ar
解説
CUserTool::SetCommand
ユーザー ツールが実行するアプリケーションを設定します。
void SetCommand(LPCTSTR lpszCmd);
パラメーター
lpszCmd
[in]ユーザー ツールに関連付ける新しいアプリケーションを指定します。
解説
このメソッドを呼び出して、ユーザー ツールが実行する新しいアプリケーションを設定します。 このメソッドは、古いアイコンを破棄し、指定されたアプリケーションから新しいアイコンを読み込みます。 アプリケーションからアイコンを読み込めない場合は、 CUserTool::LoadDefaultIcon を呼び出して、ユーザー ツールの既定のアイコンを読み込みます。
CUserTool::SetToolIcon
ツールが使用するアプリケーションからユーザー ツールのアイコンを読み込みます。
virtual HICON SetToolIcon();
戻り値
読み込まれたアイコンへのハンドル。
解説
メニュー項目に表示するアイコンを読み込むには、このメソッドを呼び出します。 このメソッドは、ツールが使用する実行可能ファイル内のアイコンを検索します。 既定のアイコンがない場合は、代わりに CUserTool::LoadDefaultIcon によって提供されるアイコンが使用されます。