Método ApplicationFactory.GetVstoObject (_Workbook)

Artigo
08/01/2011

Retorna um Microsoft.Office.Tools.Excel.Workbook o item de host que estende a funcionalidade do objeto de pasta de trabalho especificada nativa.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (em Microsoft.Office.Tools.Excel.dll)

Sintaxe

'Declaração
Function GetVstoObject ( _
    workbook As _Workbook _
) As Workbook

Workbook GetVstoObject(
    _Workbook workbook
)

Parâmetros

workbook
Tipo: Microsoft.Office.Interop.Excel._Workbook
O objeto de pasta de trabalho nativa para o qual deseja recuperar o objeto estendido.Embora esse parâmetro é do tipo Microsoft.Office.Interop.Excel._Workbook, você normalmente passar um Microsoft.Office.Interop.Excel.Workbook o objeto a este método.

Valor de retorno

Tipo: Microsoft.Office.Tools.Excel.Workbook
O item de host que estende a funcionalidade do objeto workbook nativo.

Comentários

Chame esse método em um suplemento do nível do aplicativo para personalizar qualquer pasta de trabalho é aberta no Excel. Esse método gera um novo Microsoft.Office.Tools.Excel.Workbook se não há tal objeto já foi gerado de objeto. As chamadas subseqüentes a esse método retornam a instância em cache do existente Microsoft.Office.Tools.Excel.Workbook objeto. For more information, see Estendendo os documentos do Word e pastas de trabalho do Excel em suplementos de nível de aplicativo em tempo de execução.

Observação
O workbook parâmetro é do tipo Microsoft.Office.Interop.Excel._Workbook, que é a interface do pai do Microsoft.Office.Interop.Excel.Workbook. Portanto, esse método pode aceitar objetos dos dois tipos: Microsoft.Office.Interop.Excel._Workbook and Microsoft.Office.Interop.Excel.Workbook. Normalmente, quando você faz referência a uma pasta de trabalho do Excel, você usa um Microsoft.Office.Interop.Excel.Workbook.

O workbook parâmetro é do tipo Microsoft.Office.Interop.Excel._Workbook, que é a interface do pai do Microsoft.Office.Interop.Excel.Workbook. Portanto, esse método pode aceitar objetos dos dois tipos: Microsoft.Office.Interop.Excel._Workbook and Microsoft.Office.Interop.Excel.Workbook. Normalmente, quando você faz referência a uma pasta de trabalho do Excel, você usa um Microsoft.Office.Interop.Excel.Workbook.

Exemplos

O exemplo de código a seguir cria um Microsoft.Office.Tools.Excel.Workbook o item de host para a pasta de trabalho ativa do Excel. Para usar esse código, executá-lo na ThisAddIn que os destinos do projeto de classe em um suplemento do Excel a .NET Framework 4.

Dim vstoWorkbook As Workbook = _
    Globals.Factory.GetVstoObject(Me.Application.ActiveWorkbook)

For Each st As SmartTag In vstoWorkbook.VstoSmartTags
    System.Windows.Forms.MessageBox.Show(st.Caption)
Next

Workbook vstoWorkbook =
    Globals.Factory.GetVstoObject(this.Application.ActiveWorkbook);

foreach (SmartTag st in vstoWorkbook.VstoSmartTags)
{
    System.Windows.Forms.MessageBox.Show(st.Caption);
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.