Classe CUserTool

Uma ferramenta de utilizador é um item de menu que executa uma aplicação externa. O separador Ferramentas da caixa de diálogo Personalizar ( CMFCToolBarsCustomizeDialog Class) permite ao utilizador adicionar ferramentas de utilizador e especificar o nome, comando, argumentos e diretório inicial de cada ferramenta de utilizador.

Sintaxe

class CUserTool : public CObject

Membros

Métodos Públicos

Métodos Protegidos

Membros de Dados

Observações

Para mais informações sobre como ativar ferramentas de utilizador na sua aplicação, consulte a Classe CUserToolsManager.

Example

O exemplo seguinte demonstra como criar uma ferramenta a partir de um CUserToolsManager objeto, definir a m_strLabel variável membro e definir a aplicação que a ferramenta de utilizador executa. Este excerto de código faz parte do exemplo de demonstração do Visual Studio.

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

Hierarquia de herança

CObject

CUserTool

Requerimentos

Cabeçalho: afxusertool.h

CUserTool::CopyIconToClipboard

Para mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da sua instalação no Visual Studio.

BOOL CopyIconToClipboard();

Valor de retorno

Observações

CUserTool::D rawToolIcon

Desenha o ícone da ferramenta do utilizador no centro de um retângulo especificado.

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

Parâmetros

pDC
[dentro] Um apontador para o contexto de um dispositivo.

rectImage
[dentro] Especifica as coordenadas da área a mostrar o ícone.

CUserTool::GetCommand

Devolve uma cadeia que contém o texto do comando associado à ferramenta de utilizador.

const CString& GetCommand() const;

Valor de retorno

Uma referência a CString um objeto que contém o texto do comando associado à ferramenta de utilizador.

CUserTool::GetCommandId

Devolve o ID do comando da ferramenta de utilizador.

UINT GetCommandId() const;

Valor de retorno

O ID do comando desta ferramenta de utilizador.

CUserTool::Invoke

Executa o comando associado à ferramenta de utilizador.

virtual BOOL Invoke();

Valor de retorno

Não nulo se o comando fosse executado com sucesso; caso contrário, 0.

Observações

Chama o ShellExecute para executar um comando associado à ferramenta do utilizador. A função falha se o comando estiver vazio ou se o ShellExecute falhar.

CUserTool::LoadDefaultIcon

Carrega o ícone padrão de uma ferramenta de utilizador.

virtual HICON LoadDefaultIcon();

Valor de retorno

Um handle para o ícone carregado (HICON), ou NULL se o ícone padrão não puder ser carregado.

Observações

O framework chama este método quando não consegue carregar um ícone para uma ferramenta definida pelo utilizador a partir do ficheiro executável da ferramenta.

Substitua este método para fornecer o seu próprio ícone de ferramenta predefinido.

CUserTool::m_strArguments

Os argumentos da linha de comandos para a ferramenta do utilizador.

CString m_strArguments;

Observações

Esta cadeia é passada para a ferramenta quando chama o CUserTool::Invoke ou quando um utilizador clica no comando associado a esta ferramenta.

CUserTool::m_strInitialDirectory

Especifica o diretório inicial da ferramenta de utilizador.

CString m_strInitialDirectory;

Observações

Esta variável especifica o diretório inicial onde a ferramenta é executada quando chama o CUserTool::Invoke ou quando um utilizador clica no comando associado a esta ferramenta.

CUserTool::m_strLabel

A etiqueta que aparece no item do menu da ferramenta.

CString m_strLabel;

CUserTool::Serialize

Para mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da sua instalação no Visual Studio.

virtual void Serialize(CArchive& ar);

Parâmetros

[dentro] ar

Observações

CUserTool::SetCommand

Define a aplicação que a ferramenta de utilizador executa.

void SetCommand(LPCTSTR lpszCmd);

Parâmetros

lpszCmd
[dentro] Especifica a nova aplicação a ser associada à ferramenta de utilizador.

Observações

Chame este método para definir uma nova aplicação que a ferramenta de utilizador executa. O método destrói o ícone antigo e carrega um novo ícone da aplicação dada. Se não conseguir carregar um ícone a partir da aplicação, carrega o ícone predefinido de uma ferramenta de utilizador chamando CUserTool::LoadDefaultIcon.

CUserTool::SetToolIcon

Carrega o ícone da ferramenta de utilizador a partir da aplicação que a ferramenta utiliza.

virtual HICON SetToolIcon();

Valor de retorno

Uma alça para o ícone carregado.

Observações

Chame este método para carregar o ícone a ser exibido no item do menu. Este método procura o ícone no ficheiro executável que a ferramenta utiliza. Se não tiver um ícone predefinido, o ícone fornecido pelo CUserTool::LoadDefaultIcon é usado em vez disso.

Consulte também

Gráfico de Hierarquia
Classes
CWinAppEx Classe
CUserToolsManager Classe