CUserTool – třída

Uživatelský nástroj je položka nabídky, která spouští externí aplikaci. Karta Nástroje dialogového okna Přizpůsobit ( CMFCToolBarsCustomizeDialog Třída) umožňuje uživateli přidat uživatelské nástroje a zadat název, příkaz, argumenty a počáteční adresář pro každý uživatelský nástroj.

Syntaxe

class CUserTool : public CObject

Členové

Veřejné metody

Jméno	popis
CUserTool::CopyIconToClipboard
CUserTool::D rawToolIcon	Nakreslí ikonu nástroje uživatele v zadaném obdélníku.
CUserTool::GetCommand	Vrátí řetězec, který obsahuje text příkazu přidruženého k nástroji uživatele.
CUserTool::GetCommandId	Vrátí ID příkazu položky nabídky uživatelského nástroje.
CUserTool::Invoke	Spustí příkaz přidružený k uživatelskému nástroji.
CUserTool::Serializace	Čte nebo zapisuje tento objekt z archivu nebo do archivu. (Přepsání CObject::Serialize.)
CUserTool::SetCommand	Nastaví příkaz přidružený k uživatelskému nástroji.
CUserTool::SetToolIcon	Načte ikonu nástroje uživatele z aplikace přidružené k nástroji.

Chráněné metody

Jméno	popis
CUserTool::LoadDefaultIcon	Načte výchozí ikonu pro uživatelský nástroj.

Datové členy

Jméno	popis
CUserTool::m_strArguments	Argumenty příkazového řádku pro uživatelský nástroj.
CUserTool::m_strInitialDirectory	Počáteční adresář pro uživatelský nástroj.
CUserTool::m_strLabel	Název nástroje, který se zobrazí v položce nabídky nástroje.

Poznámky

Další informace o povolení uživatelských nástrojů ve vaší aplikaci naleznete v tématu CUserToolsManager – třída.

Příklad

Následující příklad ukazuje, jak vytvořit nástroj z objektu CUserToolsManager , nastavit m_strLabel členské proměnné a nastavit aplikaci, kterou uživatelský nástroj spouští. Tento fragment kódu je součástí ukázky sady Visual Studio Demo.

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

Hierarchie dědičnosti

Objekt CObject

CUserTool

Požadavky

Hlavička: afxusertool.h

CUserTool::CopyIconToClipboard

Další podrobnosti najdete ve zdrojovém kódu ve složce VC\atlmfc\src\mfc instalace sady Visual Studio.

BOOL CopyIconToClipboard();

Vrácená hodnota

Poznámky

CUserTool::D rawToolIcon

Nakreslí ikonu uživatelského nástroje na střed zadaného obdélníku.

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

Parametry

Pdc
[v] Ukazatel na kontext zařízení.

rectImage
[v] Určuje souřadnice oblasti pro zobrazení ikony.

CUserTool::GetCommand

Vrátí řetězec, který obsahuje text příkazu přidruženého k nástroji uživatele.

const CString& GetCommand() const;

Vrácená hodnota

Odkaz na CString objekt, který obsahuje text příkazu přidruženého k nástroji uživatele.

CUserTool::GetCommandId

Vrátí ID příkazu uživatelského nástroje.

UINT GetCommandId() const;

Vrácená hodnota

ID příkazu tohoto uživatelského nástroje.

CUserTool::Invoke

Spustí příkaz přidružený k uživatelskému nástroji.

virtual BOOL Invoke();

Vrácená hodnota

Nenulové, pokud byl příkaz úspěšně proveden; jinak 0.

Poznámky

Volá ShellExecute ke spuštění příkazu přidruženého k uživatelskému nástroji. Funkce selže, pokud je příkaz prázdný nebo pokud ShellExecute selže.

CUserTool::LoadDefaultIcon

Načte výchozí ikonu pro uživatelský nástroj.

virtual HICON LoadDefaultIcon();

Vrácená hodnota

Popisovač načtené ikony (HICON) nebo NULL, pokud nelze načíst výchozí ikonu.

Poznámky

Architektura volá tuto metodu, pokud nemůže načíst ikonu pro nástroj definovaný uživatelem ze spustitelného souboru nástroje.

Tuto metodu přepište, pokud chcete zadat vlastní výchozí ikonu nástroje.

CUserTool::m_strArguments

Argumenty příkazového řádku pro uživatelský nástroj.

CString m_strArguments;

Poznámky

Tento řetězec se předá nástroji při volání CUserTool::Invoke nebo když uživatel klikne na příkaz přidružený k tomuto nástroji.

CUserTool::m_strInitialDirectory

Určuje počáteční adresář pro nástroj uživatele.

CString m_strInitialDirectory;

Poznámky

Tato proměnná určuje počáteční adresář, ve který se nástroj spustí při volání CUserTool::Invoke nebo když uživatel klikne na příkaz přidružený k tomuto nástroji.

CUserTool::m_strLabel

Popisek zobrazený v položce nabídky nástroje.

CString m_strLabel;

CUserTool::Serializace

Další podrobnosti najdete ve zdrojovém kódu ve složce VC\atlmfc\src\mfc instalace sady Visual Studio.

virtual void Serialize(CArchive& ar);

Parametry

[v] ar

Poznámky

CUserTool::SetCommand

Nastaví aplikaci, na které běží uživatelský nástroj.

void SetCommand(LPCTSTR lpszCmd);

Parametry

lpszCmd
[v] Určuje novou aplikaci, která se má přidružit k uživatelskému nástroji.

Poznámky

Voláním této metody nastavíte novou aplikaci, která se spustí v uživatelském nástroji. Metoda zničí starou ikonu a načte novou ikonu z dané aplikace. Pokud nemůže načíst ikonu z aplikace, načte výchozí ikonu pro nástroj uživatele voláním CUserTool::LoadDefaultIcon.

CUserTool::SetToolIcon

Načte ikonu pro nástroj uživatele z aplikace, kterou nástroj používá.

virtual HICON SetToolIcon();

Vrácená hodnota

Popisovač načtené ikony.

Poznámky

Voláním této metody načtěte ikonu, která se zobrazí v položce nabídky. Tato metoda vyhledá ikonu ve spustitelném souboru, který nástroj používá. Pokud nemá výchozí ikonu, použije se místo ní ikona poskytovaná CUserTool::LoadDefaultIcon .

Viz také

Graf hierarchie
Třídy
CWinAppEx – třída
CUserToolsManager – třída