Método ApplicationFactory.GetVstoObject (_Workbook)

Artigo
01/09/2014

Retorna um item de host de Microsoft.Office.Tools.Excel.Workbook que estende a funcionalidade do objeto nativo especificado de pasta de trabalho.

Namespace: Microsoft.Office.Tools.Excel
Assemblies: Microsoft.Office.Tools.Excel (em Microsoft.Office.Tools.Excel.dll)
Microsoft.Office.Tools.Excel.v4.0.Utilities (em Microsoft.Office.Tools.Excel.v4.0.Utilities.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 nativo de pasta de trabalho para que recuperar o objeto estendido.Embora esse parâmetro é do tipo Microsoft.Office.Interop.Excel._Workbook, você normalmente passa um objeto de Microsoft.Office.Interop.Excel.Workbook para este método.

Valor de retorno

Tipo: Microsoft.Office.Tools.Excel.Workbook
O item host que estendem a funcionalidade do objeto nativo de pasta de trabalho.

Comentários

Chamar este método em um suplemento ao nível para personalizar qualquer pasta de trabalho que é aberto no excel. Este método gera um novo objeto de Microsoft.Office.Tools.Excel.Workbook se nenhum tal objeto já foi gerado. Chamadas subsequentes para esse método retornar a instância em cache do objeto existente de Microsoft.Office.Tools.Excel.Workbook . Para obter mais informações, consulte Estendendo documentos do Word e pastas de trabalho do Excel em suplementos no nível do aplicativo em tempo de execução.

Dica

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

Exemplos

O exemplo de código a seguir cria um item de host de Microsoft.Office.Tools.Excel.Workbook para a pasta de trabalho do Excel ativo. Para usar este código, ele execução da classe de ThisAddIn em um projeto do suplemento do excel que tem como alvo .NET Framework 4 ou .NET Framework 4.5.

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ável.