CUserTool-Klasse
Ein Benutzertool ist ein Menüelement, das eine externe Anwendung ausführt. Auf der Registerkarte "Extras " des Dialogfelds "Anpassen " ( CMFCToolBarsCustomizeDialog-Klasse) kann der Benutzer Benutzertools hinzufügen und den Namen, befehl, Argumente und anfangsverzeichnis für jedes Benutzertool angeben.
Syntax
class CUserTool : public CObject
Member
Öffentliche Methoden
| Name | Beschreibung |
|---|---|
| CUserTool::CopyIconToClipboard | |
| CUserTool::D rawToolIcon | Zeichnet das Benutzertoolsymbol in einem angegebenen Rechteck. |
| CUserTool::GetCommand | Gibt eine Zeichenfolge zurück, die den Text des Befehls enthält, der dem Benutzertool zugeordnet ist. |
| CUserTool::GetCommandId | Gibt die Befehls-ID des Menüelements des Benutzertools zurück. |
| CUserTool::Invoke | Führt den befehl aus, der dem Benutzertool zugeordnet ist. |
| CUserTool::Serialize | Liest oder schreibt dieses Objekt aus einem oder in ein Archiv. (Überschreibt CObject::Serialize.) |
| CUserTool::SetCommand | Legt den Befehl fest, der dem Benutzertool zugeordnet ist. |
| CUserTool::SetToolIcon | Lädt das Symbol für das Benutzertool aus der Anwendung, die dem Tool zugeordnet ist. |
Geschützte Methoden
| Name | Beschreibung |
|---|---|
| CUserTool::LoadDefaultIcon | Lädt das Standardsymbol für ein Benutzertool. |
Datenelemente
| Name | Beschreibung |
|---|---|
| CUserTool::m_strArguments | Die Befehlszeilenargumente für das Benutzertool. |
| CUserTool::m_strInitialDirectory | Das anfängliche Verzeichnis für das Benutzertool. |
| CUserTool::m_strLabel | Der Toolname, der im Menüelement für das Tool angezeigt wird. |
Hinweise
Weitere Informationen zum Aktivieren von Benutzertools in Ihrer Anwendung finden Sie unter CUserToolsManager Class.
Beispiel
Im folgenden Beispiel wird veranschaulicht, wie Sie ein Tool aus einem CUserToolsManager Objekt erstellen, die m_strLabel Membervariable festlegen und die Anwendung festlegen, die vom Benutzertool ausgeführt wird. Dieser Codeausschnitt ist Teil des Visual Studio Demo-Beispiels.
// CUserToolsManager* pUserToolsManager
CUserTool* pTool1 = pUserToolsManager->CreateNewTool();
pTool1->m_strLabel = _T("&Notepad");
pTool1->SetCommand(_T("notepad.exe"));
Vererbungshierarchie
Anforderungen
Header: afxusertool.h
CUserTool::CopyIconToClipboard
Ausführliche Informationen finden Sie im Quellcode des Ordners VC\atlmfc\src\mfc der Visual Studio-Installation.
BOOL CopyIconToClipboard();
Rückgabewert
Bemerkungen
CUserTool::D rawToolIcon
Zeichnet das Benutzertoolsymbol in der Mitte eines angegebenen Rechtecks.
void DrawToolIcon(
CDC* pDC,
const CRect& rectImage);
Parameter
pDC
[in] Ein Zeiger auf einen Gerätekontext.
rectImage
[in] Gibt die Koordinaten des Bereichs an, in dem das Symbol angezeigt werden soll.
CUserTool::GetCommand
Gibt eine Zeichenfolge zurück, die den Text des Befehls enthält, der dem Benutzertool zugeordnet ist.
const CString& GetCommand() const;
Rückgabewert
Ein Verweis auf CString ein Objekt, das den Text des Befehls enthält, der dem Benutzertool zugeordnet ist.
CUserTool::GetCommandId
Gibt die Befehls-ID des Benutzertools zurück.
UINT GetCommandId() const;
Rückgabewert
Die Befehls-ID dieses Benutzertools.
CUserTool::Invoke
Führt den befehl aus, der dem Benutzertool zugeordnet ist.
virtual BOOL Invoke();
Rückgabewert
Nonzero, wenn der Befehl erfolgreich ausgeführt wurde; andernfalls 0.
Hinweise
Ruft ShellExecute auf, um einen Befehl auszuführen, der dem Benutzertool zugeordnet ist. Die Funktion schlägt fehl, wenn der Befehl leer ist oder ShellExecute fehlschlägt.
CUserTool::LoadDefaultIcon
Lädt das Standardsymbol für ein Benutzertool.
virtual HICON LoadDefaultIcon();
Rückgabewert
Ein Handle zum geladenen Symbol (HICON) oder NULL, wenn das Standardsymbol nicht geladen werden kann.
Hinweise
Das Framework ruft diese Methode auf, wenn es nicht in der Lage ist, ein Symbol für ein benutzerdefiniertes Tool aus der ausführbaren Datei des Tools zu laden.
Überschreiben Sie diese Methode, um Ihr eigenes Standardtoolsymbol anzuzeigen.
CUserTool::m_strArguments
Die Befehlszeilenargumente für das Benutzertool.
CString m_strArguments;
Hinweise
Diese Zeichenfolge wird an das Tool übergeben, wenn Sie CUserTool::Invoke aufrufen oder wenn ein Benutzer auf den befehl klickt, der diesem Tool zugeordnet ist.
CUserTool::m_strInitialDirectory
Gibt das anfängliche Verzeichnis für das Benutzertool an.
CString m_strInitialDirectory;
Hinweise
Diese Variable gibt das anfängliche Verzeichnis an, in dem das Tool ausgeführt wird, wenn Sie CUserTool::Invoke aufrufen oder wenn ein Benutzer auf den befehl klickt, der diesem Tool zugeordnet ist.
CUserTool::m_strLabel
Die Beschriftung, die im Menüelement für das Tool angezeigt wird.
CString m_strLabel;
CUserTool::Serialize
Ausführliche Informationen finden Sie im Quellcode des Ordners VC\atlmfc\src\mfc der Visual Studio-Installation.
virtual void Serialize(CArchive& ar);
Parameter
[in] ar
Hinweise
CUserTool::SetCommand
Legt die Anwendung fest, die vom Benutzertool ausgeführt wird.
void SetCommand(LPCTSTR lpszCmd);
Parameter
lpszCmd
[in] Gibt die neue Anwendung an, die dem Benutzertool zugeordnet werden soll.
Hinweise
Rufen Sie diese Methode auf, um eine neue Anwendung festzulegen, die vom Benutzertool ausgeführt wird. Die Methode zerstört das alte Symbol und lädt ein neues Symbol aus der angegebenen Anwendung. Wenn ein Symbol nicht aus der Anwendung geladen werden kann, wird das Standardsymbol für ein Benutzertool durch Aufrufen von CUserTool::LoadDefaultIcon geladen.
CUserTool::SetToolIcon
Lädt das Symbol für das Benutzertool aus der Anwendung, die das Tool verwendet.
virtual HICON SetToolIcon();
Rückgabewert
Ein Handle zum geladenen Symbol.
Hinweise
Rufen Sie diese Methode auf, um das Symbol zu laden, das im Menüelement angezeigt werden soll. Diese Methode sucht nach dem Symbol in der ausführbaren Datei, die das Tool verwendet. Wenn es kein Standardsymbol enthält, wird stattdessen das von CUserTool::LoadDefaultIcon bereitgestellte Symbol verwendet.
Siehe auch
Hierarchiediagramm
Klassen
CWinAppEx-Klasse
CUserToolsManager-Klasse