Klasse CUserTool

Opmerking

De Microsoft Foundation Classes-bibliotheek (MFC) wordt nog steeds ondersteund. We voegen echter geen functies meer toe of werken de documentatie bij.

Een gebruikershulpprogramma is een menu-item waarmee een externe toepassing wordt uitgevoerd. Op het tabblad Extra van het dialoogvenster Aanpassen ( CMFCToolBarsCustomizeDialog Class) kan de gebruiker gebruikershulpprogramma's toevoegen en de naam, opdracht, argumenten en initiële map voor elk gebruikershulpprogramma opgeven.

Syntaxis

class CUserTool : public CObject

Leden

Openbare methoden

Naam	Description
CUserTool::CopyIconToClipboard
CUserTool::D rawToolIcon	Hiermee tekent u het pictogram voor het hulpprogramma van de gebruiker in een opgegeven rechthoek.
CUserTool::GetCommand	Retourneert een tekenreeks die de tekst bevat van de opdracht die is gekoppeld aan het gebruikershulpprogramma.
CUserTool::GetCommandId	Retourneert de opdracht-id van het menu-item van het gebruikershulpprogramma.
CUserTool::Invoke	Hiermee wordt de opdracht uitgevoerd die is gekoppeld aan het gebruikershulpprogramma.
CUserTool::Serialize	Leest of schrijft dit object van of naar een archief. (Overschrijft CObject::Serialize.)
CUserTool::SetCommand	Hiermee stelt u de opdracht in die is gekoppeld aan het gebruikershulpprogramma.
CUserTool::SetToolIcon	Laadt het pictogram voor het gebruikershulpprogramma uit de toepassing die is gekoppeld aan het hulpprogramma.

Beveiligde methoden

Naam	Description
CUserTool::LoadDefaultIcon	Laadt het standaardpictogram voor een gebruikershulpprogramma.

Gegevensleden

Naam	Description
CUserTool::m_strArguments	De opdrachtregelargumenten voor het gebruikershulpprogramma.
CUserTool::m_strInitialDirectory	De eerste map voor het gebruikershulpprogramma.
CUserTool::m_strLabel	De naam van het hulpprogramma die wordt weergegeven in de menuopdracht voor het hulpprogramma.

Opmerkingen

Zie CUserToolsManager Class voor meer informatie over het inschakelen van gebruikershulpprogramma's in uw toepassing.

Example

In het volgende voorbeeld ziet u hoe u een hulpprogramma maakt op basis van een CUserToolsManager object, de m_strLabel lidvariabele instelt en de toepassing instelt die door het gebruikershulpprogramma wordt uitgevoerd. Dit codefragment maakt deel uit van het Visual Studio Demo-voorbeeld.

// CUserToolsManager* pUserToolsManager
CUserTool* pTool1 = pUserToolsManager->CreateNewTool();
pTool1->m_strLabel = _T("&Notepad");
pTool1->SetCommand(_T("notepad.exe"));

Overnamehiërarchie

CObject

CUserTool

Requirements

Koptekst: afxusertool.h

CUserTool::CopyIconToClipboard

Zie de broncode in de map VC\atlmfc\src\mfc van uw Visual Studio-installatie voor meer informatie.

BOOL CopyIconToClipboard();

Retourwaarde

Opmerkingen

CUserTool::D rawToolIcon

Hiermee tekent u het pictogram van het gebruikershulpmiddel in het midden van een opgegeven rechthoek.

void DrawToolIcon(
    CDC* pDC,
    const CRect& rectImage);

Parameterwaarden

Pdc
[in] Een aanwijzer naar een apparaatcontext.

rectImage
[in] Hiermee geeft u de coördinaten van het gebied om het pictogram weer te geven.

CUserTool::GetCommand

Retourneert een tekenreeks die de tekst bevat van de opdracht die is gekoppeld aan het gebruikershulpprogramma.

const CString& GetCommand() const;

Retourwaarde

Een verwijzing naar CString het object dat de tekst bevat van de opdracht die is gekoppeld aan het gebruikershulpprogramma.

CUserTool::GetCommandId

Retourneert de opdracht-id van het gebruikershulpprogramma.

UINT GetCommandId() const;

Retourwaarde

De opdracht-id van dit gebruikershulpprogramma.

CUserTool::Invoke

Hiermee wordt de opdracht uitgevoerd die is gekoppeld aan het gebruikershulpprogramma.

virtual BOOL Invoke();

Retourwaarde

Niet-nul als de opdracht is uitgevoerd; anders 0.

Opmerkingen

Roept ShellExecute aan om een opdracht uit te voeren die is gekoppeld aan het gebruikershulpprogramma. De functie mislukt als de opdracht leeg is of als ShellExecute mislukt.

CUserTool::LoadDefaultIcon

Laadt het standaardpictogram voor een gebruikershulpprogramma.

virtual HICON LoadDefaultIcon();

Retourwaarde

Een ingang naar het geladen pictogram (HICON) of NULL als het standaardpictogram niet kan worden geladen.

Opmerkingen

Dit framework roept deze methode aan wanneer er geen pictogram kan worden geladen voor een door de gebruiker gedefinieerd hulpprogramma uit het uitvoerbare bestand van het hulpprogramma.

Overschrijf deze methode om uw eigen standaardhulpprogrammapictogram op te geven.

CUserTool::m_strArguments

De opdrachtregelargumenten voor het gebruikershulpprogramma.

CString m_strArguments;

Opmerkingen

Deze tekenreeks wordt doorgegeven aan het hulpprogramma wanneer u CUserTool aanroept::Aanroepen of wanneer een gebruiker op de opdracht klikt die aan dit hulpprogramma is gekoppeld.

CUserTool::m_strInitialDirectory

Hiermee geeft u de eerste map voor het gebruikershulpprogramma.

CString m_strInitialDirectory;

Opmerkingen

Met deze variabele geeft u de eerste map op waarin het hulpprogramma wordt uitgevoerd wanneer u CUserTool aanroept::Aanroepen of wanneer een gebruiker op de opdracht klikt die aan dit hulpprogramma is gekoppeld.

CUserTool::m_strLabel

Het label dat wordt weergegeven in de menuopdracht voor het hulpprogramma.

CString m_strLabel;

CUserTool::Serialize

Zie de broncode in de map VC\atlmfc\src\mfc van uw Visual Studio-installatie voor meer informatie.

virtual void Serialize(CArchive& ar);

Parameterwaarden

[in] Ar

Opmerkingen

CUserTool::SetCommand

Hiermee stelt u de toepassing in die door het gebruikershulpprogramma wordt uitgevoerd.

void SetCommand(LPCTSTR lpszCmd);

Parameterwaarden

lpszCmd
[in] Hiermee geeft u de nieuwe toepassing die moet worden gekoppeld aan het gebruikershulpprogramma.

Opmerkingen

Roep deze methode aan om een nieuwe toepassing in te stellen die door het gebruikershulpprogramma wordt uitgevoerd. De methode vernietigt het oude pictogram en laadt een nieuw pictogram uit de opgegeven toepassing. Als het pictogram niet vanuit de toepassing kan worden geladen, wordt het standaardpictogram voor een gebruikershulpprogramma geladen door CUserTool::LoadDefaultIcon aan te roepen.

CUserTool::SetToolIcon

Laadt het pictogram voor het gebruikershulpprogramma uit de toepassing die door het hulpprogramma wordt gebruikt.

virtual HICON SetToolIcon();

Retourwaarde

Een ingang naar het geladen pictogram.

Opmerkingen

Roep deze methode aan om het pictogram te laden dat moet worden weergegeven in het menu-item. Met deze methode wordt gezocht naar het pictogram in het uitvoerbare bestand dat door het hulpprogramma wordt gebruikt. Als het geen standaardpictogram heeft, wordt in plaats daarvan het pictogram van CUserTool::LoadDefaultIcon gebruikt.

Zie ook

Hiërarchiegrafiek
Klassen
CWinAppEx-klasse
Klasse CUserToolsManager