Visão geral sobre painéis de tarefas personalizado

Artigo
08/08/2011

Painéis são os painéis de interface do usuário que normalmente são encaixados em um dos lados de uma janela em um aplicativo de Microsoft Office. Painéis de tarefas personalizados oferecem uma maneira de criar seu próprio painel de tarefas e forneça aos usuários uma interface familiar para acessar os recursos da solução. Por exemplo, a interface pode conter controles que execute o código para modificar documentos ou exibir dados de uma fonte de dados.

Aplicável a: As informações neste tópico se aplicam a projetos de nível de documento e projetos de nível de aplicativo para os seguintes aplicativos: Excel 2007 e Excel 2010; InfoPath 2007 e InfoPath 2010; Outlook 2007 e Outlook 2010; PowerPoint 2007 e PowerPoint 2010; Word 2007 e Word 2010. Para obter mais informações, consulte Recursos disponíveis pelo aplicativo do Office e o tipo de projeto.

Observação
O painel de tarefas personalizado difere do painel de ações. O painel de ações é parte de personalizações em nível de documento para Microsoft Office o Word e Excel de Microsoft Office. For more information, see Visão geral painel Ações.

Benefícios dos painéis de tarefas personalizados

Painéis de tarefas personalizados permitem integrar seus recursos uma interface de usuário familiar. Você pode criar um painel de tarefas personalizado rapidamente usando ferramentas de Visual Studio.

Interface de usuário familiar

Os usuários de aplicativos no sistema de Microsoft Office já estiverem familiarizados com usando painéis de tarefas, como o estilos e formatação o painel de tarefas no Word. Painéis de tarefas personalizados se comportam como outros painéis de tarefas, no sistema de Microsoft Office. Os usuários podem encaixar os painéis de tarefas personalizados para diferentes lados da janela do aplicativo, ou arraste painéis de tarefas personalizados em qualquer local na janela. Você pode criar um suplemento que exibe vários painéis de tarefas personalizado ao mesmo tempo e os usuários podem controlar individualmente cada painel de tarefas.

Windows Forms Support

A interface do usuário de um painel de tarefas personalizado que você criar usando as ferramentas de desenvolvimento do Office em Visual Studio baseia-se nos controles Windows Forms. Você pode usar o Windows Forms Designer familiar para projetar a interface de usuário para um painel de tarefas personalizado. Você também pode usar o suporte à vinculação de dados no Windows Forms para vincular a uma fonte de dados a controles no painel de tarefas.

Criando um painel de tarefas personalizado

Você pode criar um painel de tarefas personalizado de básico em duas etapas:

Criar uma interface de usuário para o painel de tarefas personalizado, adicionando controles do Windows Forms para um UserControl objeto.
Instanciar o painel de tarefas personalizado, passando o controle de usuário para o CustomTaskPaneCollection o objeto no seu add-in. Esta coleção retorna uma nova CustomTaskPane o objeto que você pode usar para modificar a aparência do painel de tarefas e responder a eventos do usuário.

Para um procedimento passo a passo, consulte Como: Adicionar um painel de tarefas personalizado a um aplicativo.

Criando a Interface do usuário

Todos os painéis de tarefas personalizados são criados usando as ferramentas de desenvolvimento do Office em Visual Studio contêm um UserControl objeto. O controle de usuário fornece a interface do usuário do painel de tarefas. Você pode criar o controle de usuário em tempo de design ou em tempo de execução. Se você criar o controle de usuário em tempo de design, você pode usar o Windows Forms Designer para construir a interface do usuário do seu painel de tarefas.

Instanciar o painel de tarefas personalizado

Depois de criar um controle de usuário que contém a interface do usuário do painel de tarefas personalizado, você precisa instanciar um CustomTaskPane. Para fazer isso, passar o controle de usuário para o CustomTaskPaneCollection no seu suplemento, chamando um da Add métodos. Essa coleção é exposta como o CustomTaskPanes campo de ThisAddIn classe. O exemplo de código a seguir se destina a ser executado a partir de ThisAddIn classe.

myUserControl1 = New MyUserControl
myCustomTaskPane = Me.CustomTaskPanes.Add(myUserControl1, "My Task Pane")
myCustomTaskPane.Visible = True

myUserControl1 = new MyUserControl();
myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1, "My Task Pane");
myCustomTaskPane.Visible = true;

O Add métodos retornam uma nova CustomTaskPane objeto. Você pode usar esse objeto para modificar a aparência do painel de tarefas e para responder a eventos do usuário.

Controlando o painel de tarefas em várias janelas

Painéis de tarefas personalizados são associados uma janela de quadro do documento, apresenta um modo de exibição de um documento ou item para o usuário. O painel de tarefas é visível somente quando a janela associada está visível.

Para determinar qual janela exibe o painel de tarefas personalizado, use o Add a sobrecarga de método ao criar o painel de tarefas:

Para associar o painel de tarefas da janela ativa, use o CustomTaskPaneCollection.Add(UserControl, String) método.
Para associar a um documento que é hospedado por uma janela especificada do painel de tarefas, use o CustomTaskPaneCollection.Add(UserControl, String, Object) método.

Alguns aplicativos do Office requerem instruções explícitas sobre quando criar ou exibir o painel de tarefas quando mais de uma janela é aberta. Isso torna importante considerar onde instanciar o painel de tarefas personalizado no seu código para garantir que o painel de tarefas aparece com o apropriado documentos ou itens no aplicativo. For more information, see Gerenciando os painéis de tarefas personalizados em várias janelas de aplicativo.

Acessando o aplicativo do painel de tarefas

Se você deseja automatizar a aplicação do controle do usuário, você pode acessar diretamente o modelo de objeto usando Globals.ThisAddIn.Application em seu código. Estática Globals classe fornece acesso para o ThisAddIn objeto. O Application campo deste objeto é o ponto de entrada no modelo de objeto do aplicativo.

Para obter mais informações sobre o Application campo de ThisAddIn de objeto, consulte Os suplementos de nível de aplicativo de programação.. Para uma explicação passo a passo que demonstra como automatizar um aplicativo a partir de um painel de tarefas personalizado, consulte Demonstra Passo a passo: A automatização de um aplicativo a partir de um painel de tarefas personalizado. For more information about the Globals class, see Acesso global a objetos em projetos do Office.

Gerenciando a Interface do usuário do painel de tarefas

Depois de criar o painel de tarefas, você pode usar propriedades e eventos do CustomTaskPane o objeto para controlar a interface do usuário do painel de tarefas e responder quando o usuário altera o painel de tarefas.

Tornar visível o painel de tarefas personalizado

Por padrão, o painel de tarefas não estiver visível. Para tornar o painel de tarefas visível, você deve definir o Visible propriedade para true.

Os usuários podem fechar o painel de tarefas a qualquer momento clicando no Fechar o botão (X) no canto do painel de tarefas. No entanto, não há nenhuma maneira padrão abrir o painel de tarefas personalizado. Se um usuário fecha um painel de tarefas personalizado, o que o usuário não pode exibir o painel de tarefas personalizado novamente, a menos que você fornecer uma maneira para exibi-la.

Se você criar um painel de tarefas personalizado no seu suplemento, você também deve criar um elemento de interface do usuário, como, por exemplo, um botão, o que os usuários podem clicar para exibir ou ocultar o painel de tarefas personalizado. Se você criar um painel de tarefas personalizado em um aplicativo de Microsoft Office que suporta a personalização da faixa de opções, você pode adicionar um grupo de controle da faixa de opções com um botão que exibe ou oculta o painel de tarefas personalizado. Para uma explicação passo a passo que demonstra como fazer isso, consulte Demonstra Passo a passo: Sincronizando um painel de tarefas personalizado com um botão da faixa de opções.

Se você criar um painel de tarefas personalizado em um aplicativo de Microsoft Office não oferece suporte a personalização da faixa de opções, você pode adicionar um CommandBarButton que exibe ou oculta o painel de tarefas personalizado.

Modificação da aparência do painel de tarefas

Você pode controlar o tamanho e a localização de um painel de tarefas personalizado usando as propriedades de CustomTaskPane objeto. Você pode fazer outras alterações para a aparência de um painel de tarefas personalizado usando as propriedades da UserControl objeto que está contido no painel de tarefas personalizado. Por exemplo, você pode especificar uma imagem de plano de fundo para o painel de tarefas personalizado usando o BackgroundImage a propriedade do controle de usuário.

A tabela a seguir lista as alterações que você pode fazer um painel de tarefas personalizado usando CustomTaskPane Propriedades.

Task	Property
Para alterar o tamanho do painel de tarefas	Height Width
Para alterar o local do painel de tarefas	DockPosition
Para ocultar o painel de tarefas ou torná-lo visível	Visible
Para impedir que o usuário altere o local do painel de tarefas	DockPositionRestrict

Programação de eventos de painel de tarefas personalizado

Convém o add-in para responder quando o usuário modifica o painel de tarefas personalizado. Por exemplo, se o usuário altera a orientação do painel de vertical para horizontal, você talvez queira reposicionar controles.

A tabela a seguir lista os eventos que você pode manipular para responder às alterações feitas pelo usuário para o painel de tarefas personalizado.

Task	Event
Para responder quando o usuário altera o local do painel de tarefas.	DockPositionChanged
Para responder quando o usuário oculta o painel de tarefas ou se torna visível.	VisibleChanged

Limpeza de recursos usados pelo painel de tarefas

Depois de criar um painel de tarefas personalizado, o CustomTaskPane objeto permanece na memória, contanto que seu suplemento estiver em execução. O objeto permanece na memória, mesmo depois que o usuário clica o Fechar o botão (X) no canto do painel de tarefas.

Para limpar recursos utilizados pelo painel de tarefas, enquanto o add-in ainda está em execução, use o Remove ou RemoveAt métodos. Esses métodos remover especificado CustomTaskPane de objeto da CustomTaskPanes coleção e chame o Dispose() o método do objeto.

O Visual Studio Tools for Office runtime limpa automaticamente os recursos usados pelo painel de tarefas personalizado quando o suplemento é descarregado. Não chamar o Remove ou RemoveAt métodos de ThisAddIn_Shutdown manipulador de eventos em seu projeto. Esses métodos lançará um ObjectDisposedException, porque o Visual Studio Tools for Office runtime limpa os recursos usados pela CustomTaskPane objeto antes de ThisAddIn_Shutdown é chamado. For more information about ThisAddIn_Shutdown, see Eventos em projetos do Office.