Classe CUserTool

Uno strumento utente è una voce di menu che esegue un'applicazione esterna. La scheda Strumenti della finestra di dialogo Personalizza ( CMFCToolBarsCustomizeDialog Class) consente all'utente di aggiungere strumenti utente e di specificare il nome, il comando, gli argomenti e la directory iniziale per ogni strumento utente.

Sintassi

class CUserTool : public CObject

Membri

Metodi pubblici

Metodi protetti

Membri dei dati

Osservazioni:

Per altre informazioni su come abilitare gli strumenti utente nell'applicazione, vedere Classe CUserToolsManager.

Esempio

Nell'esempio seguente viene illustrato come creare uno strumento da un CUserToolsManager oggetto, impostare la m_strLabel variabile membro e impostare l'applicazione eseguita dallo strumento utente. Questo frammento di codice fa parte dell'esempio demo di Visual Studio.

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

Gerarchia di ereditarietà

CObject

CUserTool

Requisiti

Intestazione: afxusertool.h

CUserTool::CopyIconToClipboard

Per altri dettagli, vedere il codice sorgente che si trova nella cartella VC\atlmfc\src\mfc dell'installazione di Visual Studio.

BOOL CopyIconToClipboard();

Valore restituito

Osservazioni:

CUserTool::D rawToolIcon

Disegna l'icona dello strumento utente al centro di un rettangolo specificato.

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

Parametri

pDC
[in] Puntatore a un contesto di dispositivo.

rectImage
[in] Specifica le coordinate dell'area per visualizzare l'icona.

CUserTool::GetCommand

Restituisce una stringa contenente il testo del comando associato allo strumento utente.

const CString& GetCommand() const;

Valore restituito

Riferimento all'oggetto CString che contiene il testo del comando associato allo strumento utente.

CUserTool::GetCommandId

Restituisce l'ID comando dello strumento utente.

UINT GetCommandId() const;

Valore restituito

ID comando di questo strumento utente.

CUserTool::Invoke

Esegue il comando associato allo strumento utente.

virtual BOOL Invoke();

Valore restituito

Diverso da zero se il comando è stato eseguito correttamente; in caso contrario, 0.

Osservazioni:

Chiama ShellExecute per eseguire un comando associato allo strumento utente. La funzione ha esito negativo se il comando è vuoto o se ShellExecute ha esito negativo .

CUserTool::LoadDefaultIcon

Carica l'icona predefinita per uno strumento utente.

virtual HICON LoadDefaultIcon();

Valore restituito

Handle per l'icona caricata (HICON) o NULL se non è possibile caricare l'icona predefinita.

Osservazioni:

Il framework chiama questo metodo quando non è in grado di caricare un'icona per uno strumento definito dall'utente dal file eseguibile dello strumento.

Eseguire l'override di questo metodo per specificare l'icona dello strumento predefinita.

CUserTool::m_strArguments

Argomenti della riga di comando per lo strumento utente.

CString m_strArguments;

Osservazioni:

Questa stringa viene passata allo strumento quando si chiama CUserTool::Invoke o quando un utente fa clic sul comando associato a questo strumento.

CUserTool::m_strInitialDirectory

Specifica la directory iniziale per lo strumento utente.

CString m_strInitialDirectory;

Osservazioni:

Questa variabile specifica la directory iniziale eseguita dallo strumento quando si chiama CUserTool::Invoke o quando un utente fa clic sul comando associato a questo strumento.

CUserTool::m_strLabel

Etichetta visualizzata nella voce di menu per lo strumento.

CString m_strLabel;

CUserTool::Serialize

Per altri dettagli, vedere il codice sorgente che si trova nella cartella VC\atlmfc\src\mfc dell'installazione di Visual Studio.

virtual void Serialize(CArchive& ar);

Parametri

[in] ar

Osservazioni:

CUserTool::SetCommand

Imposta l'applicazione eseguita dallo strumento utente.

void SetCommand(LPCTSTR lpszCmd);

Parametri

lpszCmd
[in] Specifica la nuova applicazione da associare allo strumento utente.

Osservazioni:

Chiamare questo metodo per impostare una nuova applicazione eseguita dallo strumento utente. Il metodo elimina definitivamente l'icona precedente e carica una nuova icona dall'applicazione specificata. Se non è in grado di caricare un'icona dall'applicazione, carica l'icona predefinita per uno strumento utente chiamando CUserTool::LoadDefaultIcon.

CUserTool::SetToolIcon

Carica l'icona per lo strumento utente dall'applicazione usata dallo strumento.

virtual HICON SetToolIcon();

Valore restituito

Handle per l'icona caricata.

Osservazioni:

Chiamare questo metodo per caricare l'icona da visualizzare nella voce di menu. Questo metodo cerca l'icona nel file eseguibile usato dallo strumento. Se non dispone di un'icona predefinita, viene invece usata l'icona fornita da CUserTool::LoadDefaultIcon .

Vedi anche

Grafico della gerarchia
Classi
Classe CWinAppEx
Classe CUserToolsManager