Klasa CUserTool

Narzędzie użytkownika to element menu, który uruchamia aplikację zewnętrzną. Karta Narzędzia okna dialogowego Dostosowywanie ( CMFCToolBarsCustomizeDialog Class) umożliwia użytkownikowi dodawanie narzędzi użytkownika oraz określanie nazwy, polecenia, argumentów i katalogu początkowego dla każdego narzędzia użytkownika.

Składnia

class CUserTool : public CObject

Elementy członkowskie

Metody publiczne

Nazwa/nazwisko	opis
CUserTool::CopyIconToClipboard
CUserTool::D rawToolIcon	Rysuje ikonę narzędzia użytkownika w określonym prostokątze.
CUserTool::GetCommand	Zwraca ciąg zawierający tekst polecenia skojarzonego z narzędziem użytkownika.
CUserTool::GetCommandId	Zwraca identyfikator polecenia elementu menu narzędzia użytkownika.
CUserTool::Invoke	Wykonuje polecenie skojarzone z narzędziem użytkownika.
CUserTool::Serialize	Odczytuje lub zapisuje ten obiekt z lub do archiwum. (Przesłonięcia) CObject::Serialize.)
CUserTool::SetCommand	Ustawia polecenie skojarzone z narzędziem użytkownika.
CUserTool::SetToolIcon	Ładuje ikonę narzędzia użytkownika z aplikacji skojarzonej z narzędziem.

Metody chronione

Nazwa/nazwisko	opis
CUserTool::LoadDefaultIcon	Ładuje domyślną ikonę narzędzia użytkownika.

Składowe danych

Nazwa/nazwisko	opis
CUserTool::m_strArguments	Argumenty wiersza polecenia dla narzędzia użytkownika.
CUserTool::m_strInitialDirectory	Początkowy katalog narzędzia użytkownika.
CUserTool::m_strLabel	Nazwa narzędzia wyświetlana w elemencie menu narzędzia.

Uwagi

Aby uzyskać więcej informacji na temat włączania narzędzi użytkownika w aplikacji, zobacz Klasa CUserToolsManager.

Przykład

W poniższym przykładzie pokazano, jak utworzyć narzędzie na podstawie obiektu, ustawić m_strLabel zmienną składową CUserToolsManager i ustawić aplikację uruchamianą przez narzędzie użytkownika. Ten fragment kodu jest częścią przykładu pokazowego programu Visual Studio.

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

Hierarchia dziedziczenia

Obiekt CObject

CUserTool

Wymagania

Nagłówek: afxusertool.h

CUserTool::CopyIconToClipboard

Aby uzyskać więcej informacji, zobacz kod źródłowy znajdujący się w folderze VC\atlmfc\src\mfc instalacji programu Visual Studio.

BOOL CopyIconToClipboard();

Wartość zwracana

Uwagi

CUserTool::D rawToolIcon

Rysuje ikonę narzędzia użytkownika w środku określonego prostokąta.

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

Parametry

PDC
[in] Wskaźnik do kontekstu urządzenia.

rectImage
[in] Określa współrzędne obszaru, aby wyświetlić ikonę.

CUserTool::GetCommand

Zwraca ciąg zawierający tekst polecenia skojarzonego z narzędziem użytkownika.

const CString& GetCommand() const;

Wartość zwracana

Odwołanie do CString obiektu zawierającego tekst polecenia skojarzonego z narzędziem użytkownika.

CUserTool::GetCommandId

Zwraca identyfikator polecenia narzędzia użytkownika.

UINT GetCommandId() const;

Wartość zwracana

Identyfikator polecenia tego narzędzia użytkownika.

CUserTool::Invoke

Wykonuje polecenie skojarzone z narzędziem użytkownika.

virtual BOOL Invoke();

Wartość zwracana

Nonzero, jeśli polecenie zostało wykonane pomyślnie; w przeciwnym razie 0.

Uwagi

Wywołuje metodę ShellExecute , aby wykonać polecenie skojarzone z narzędziem użytkownika. Funkcja kończy się niepowodzeniem, jeśli polecenie jest puste lub jeśli polecenie ShellExecute zakończy się niepowodzeniem.

CUserTool::LoadDefaultIcon

Ładuje domyślną ikonę narzędzia użytkownika.

virtual HICON LoadDefaultIcon();

Wartość zwracana

Dojście do załadowanej ikony (HICON) lub NULL, jeśli nie można załadować ikony domyślnej.

Uwagi

Struktura wywołuje tę metodę, gdy nie może załadować ikony narzędzia zdefiniowanego przez użytkownika z pliku wykonywalnego narzędzia.

Zastąpi tę metodę, aby podać własną domyślną ikonę narzędzia.

CUserTool::m_strArguments

Argumenty wiersza polecenia dla narzędzia użytkownika.

CString m_strArguments;

Uwagi

Ten ciąg jest przekazywany do narzędzia podczas wywoływania narzędzia CUserTool::Invoke lub gdy użytkownik kliknie polecenie skojarzone z tym narzędziem.

CUserTool::m_strInitialDirectory

Określa katalog początkowy narzędzia użytkownika.

CString m_strInitialDirectory;

Uwagi

Ta zmienna określa katalog początkowy, w którym narzędzie jest wykonywane podczas wywoływania narzędzia CUserTool::Invoke lub gdy użytkownik kliknie polecenie skojarzone z tym narzędziem.

CUserTool::m_strLabel

Etykieta wyświetlana w elemencie menu narzędzia.

CString m_strLabel;

CUserTool::Serialize

Aby uzyskać więcej informacji, zobacz kod źródłowy znajdujący się w folderze VC\atlmfc\src\mfc instalacji programu Visual Studio.

virtual void Serialize(CArchive& ar);

Parametry

[in] Ar

Uwagi

CUserTool::SetCommand

Ustawia aplikację uruchamianą przez narzędzie użytkownika.

void SetCommand(LPCTSTR lpszCmd);

Parametry

lpszCmd
[in] Określa nową aplikację, która ma być skojarzona z narzędziem użytkownika.

Uwagi

Wywołaj tę metodę, aby ustawić nową aplikację uruchamianą przez narzędzie użytkownika. Metoda niszczy starą ikonę i ładuje nową ikonę z danej aplikacji. Jeśli nie może załadować ikony z aplikacji, ładuje ona domyślną ikonę narzędzia użytkownika przez wywołanie narzędzia CUserTool::LoadDefaultIcon.

CUserTool::SetToolIcon

Ładuje ikonę narzędzia użytkownika z aplikacji używanej przez narzędzie.

virtual HICON SetToolIcon();

Wartość zwracana

Dojście do załadowanej ikony.

Uwagi

Wywołaj tę metodę, aby załadować ikonę, która ma być wyświetlana w elemencie menu. Ta metoda wyszukuje ikonę w pliku wykonywalny używanym przez narzędzie. Jeśli nie ma ikony domyślnej, używana jest ikona dostarczona przez narzędzie CUserTool::LoadDefaultIcon .

Zobacz też

Wykres hierarchii
Klasy
Klasa CWinAppEx
Klasa CUserToolsManager