ApplicationFactory.GetVstoObject, méthode (_Workbook)

Article
01/06/2014

Retourne un élément hôte Microsoft.Office.Tools.Excel.Workbook qui étend les fonctionnalités de l'objet de classeur natif spécifié.

Espace de noms : Microsoft.Office.Tools.Excel
Assemblys : Microsoft.Office.Tools.Excel (dans Microsoft.Office.Tools.Excel.dll)
Microsoft.Office.Tools.Excel.v4.0.Utilities (dans Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Syntaxe

'Déclaration
Function GetVstoObject ( _
    workbook As _Workbook _
) As Workbook

Workbook GetVstoObject(
    _Workbook workbook
)

Paramètres

workbook
Type : Microsoft.Office.Interop.Excel._Workbook
Objet de classeur natif pour lequel l'objet étendu doit être récupéré.Bien que ce paramètre soit de type Microsoft.Office.Interop.Excel._Workbook, vous passez généralement un objet Microsoft.Office.Interop.Excel.Workbook à cette méthode.

Valeur de retour

Type : Microsoft.Office.Tools.Excel.Workbook
Élément hôte qui étend les fonctionnalités de l'objet de classeur natif.

Notes

Appelez cette méthode dans un complément d'application pour personnaliser tous les classeurs ouverts dans Excel. Cette méthode génère un nouvel objet Microsoft.Office.Tools.Excel.Workbook si aucun objet de ce type n'a déjà été généré. Les appels suivants à cette méthode retournent l'instance mise en cache de l'objet Microsoft.Office.Tools.Excel.Workbook existant. Pour plus d'informations, consultez Extension de documents Word et de classeurs Excel dans des compléments d'application au moment de l'exécution..

Notes

Le paramètre workbook est de type Microsoft.Office.Interop.Excel._Workbook, qui correspond à l'interface parente de Microsoft.Office.Interop.Excel.Workbook.Par conséquent, cette méthode peut accepter des objets de deux types: Microsoft.Office.Interop.Excel._Workbook et Microsoft.Office.Interop.Excel.Workbook.En général, lorsque vous référencez un classeur Excel, vous utilisez Microsoft.Office.Interop.Excel.Workbook.

Exemples

L'exemple de code suivant crée un élément hôte Microsoft.Office.Tools.Excel.Workbook pour le classeur Excel actif. Pour utiliser ce code, exécutez-le depuis la classe ThisAddIn dans un projet de complément Excel qui cible le .NET Framework 4 ou le .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);
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.