Compartilhar via


Item de hospedagem da planilha

O Worksheet item do host é um tipo que estende o tipo do Worksheet do assembly de interoperabilidade primário para o Excel. O Worksheet item de host fornece todas as mesmas propriedades, métodos e eventos como um Worksheet objeto, mas também expõe eventos adicionais e atua como um contêiner para controles de host e controles do Windows Forms.

Aplica-se a: As informações neste tópico se aplicam a projetos de nível de documento e projetos de suplemento VSTO para Excel. Para obter mais informações, consulte Os recursos disponíveis pelo aplicativo do Office e pelo tipo de projeto.

Em projetos de nível de documento, você pode adicionar Worksheet itens de host ao seu projeto em tempo de design. Em projetos de complemento VSTO, você pode gerar Worksheet itens de host em tempo de execução.

Compreender itens de host de planilhas em projetos ao nível do documento

Quando você cria um projeto no nível do documento para o Excel, o Visual Studio cria automaticamente três Worksheet itens de host no projeto. Os nomes padrão das planilhas são Sheet1, Sheet2e Sheet3. Se você criar um projeto com base em uma pasta de trabalho existente, o número de itens de host dependerá do número de planilhas na pasta de trabalho.

Essas classes de planilha fornecem acesso aos membros do Worksheet item host para executar tarefas básicas em sua personalização, como modificar o conteúdo de uma planilha. Você também pode usar essas classes para adicionar controles a planilhas. Combinando diferentes conjuntos de controles e escrevendo código, você pode associar os controles aos dados, coletar informações do usuário e responder às ações do usuário. Para obter mais informações, consulte Personalizações no nível do documento do programa.

As classes de planilha fornecem um local no qual você pode começar a escrever código em seu projeto. Como a classe fornece todas as mesmas propriedades, métodos e eventos que o Worksheet objeto no assembly de interoperabilidade primário do Excel, você também pode usar essas classes para acessar o modelo de objeto do Excel. Para obter mais informações, consulte a visão geral do modelo de objeto do Excel.

Em projetos de nível de documento, você pode adicionar itens de host adicionais Worksheet ao projeto em tempo de desenvolvimento adicionando uma nova planilha à pasta de trabalho usando o designer.

Renomear planilhas

Em um projeto no nível do documento, você pode renomear as planilhas no designer do Visual Studio, mas isso só altera o nome de exibição da planilha. O nome programático ainda é o nome padrão da planilha. Se você renomear a planilha na janela Propriedades , somente o nome programático será alterado.

Limitações do item hospedeiro da planilha em projetos em nível de documento

Não é possível criar novos Worksheet itens de host em tempo de execução em um projeto em nível de documento. Se você criar uma nova planilha do Excel em tempo de execução, ela será do tipo Worksheet. Como não é um item de host, ele não pode conter controles de host ou controles do Windows Forms. Para obter mais informações sobre como criar documentos em tempo de execução, consulte Como adicionar programaticamente novas planilhas às pastas de trabalho.

Compreender os itens de host da planilha de trabalho em projetos de Add-in do VSTO

Nos projetos em nível de aplicativo, você pode gerar um Worksheet item de host durante a execução para qualquer planilha aberta no Excel. Você pode usar o item de Worksheet host para adicionar controles à planilha associada ou para manipular eventos que não estão disponíveis em Worksheet objetos.

Para gerar um item de host Worksheet, use o método GetVstoObject. Para mais informações, consulte Estender documentos do Word e pastas de trabalho do Excel em complementos VSTO em tempo de execução.