Accès global aux objets dans les projets Visual Studio Tools pour Office

Article
04/28/2010

Mise à jour : novembre 2007

Vous pouvez utiliser la classe Globals pour accéder à plusieurs éléments de projet différents de tout code dans le projet.

Comment utiliser Globals

Globals est une classe statique qui conserve des références aux éléments dans votre projet. En utilisant la classe Globals, vous pouvez référencer les éléments suivants à partir de n'importe quel code du projet :

Workbook ou tout élément hôte Worksheet dans un classeur ou un projet de modèle Excel. Vous accédez à ces éléments hôtes en utilisant les propriétés de la classe Globals qui font référence à chaque élément hôte dans votre projet. Par défaut, les éléments hôtes portent les noms suivants : ThisWorkbook, Sheet1, Sheet2 et Sheet3.
L'élément hôte Document dans un document ou un projet de modèle Word. Le nom par défaut pour cette propriété d'élément hôte est Globals.ThisDocument.
L'élément hôte AddIn dans un projet au niveau de l'application. Le nom par défaut pour cette propriété d'élément hôte est Globals.ThisAddIn.
Tous les rubans de votre projet que vous avez personnalisé en utilisant le Concepteur de ruban. Vous pouvez accéder aux rubans en utilisant la propriété Globals.Ribbons.
Toutes les régions de formulaire Outlook dans un projet de complément Outlook. Vous pouvez accéder aux régions de formulaire à l'aide de la propriété Globals.FormRegions.

Par exemple, vous pouvez écrire du code pour insérer du texte dans un contrôle NamedRange sur Sheet1 lorsqu'un utilisateur clique sur un bouton dans le volet Actions, comme le montre l'exemple suivant.

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _
    Handles Button1.Click

    If Globals.Sheet1 IsNot Nothing Then
        Globals.Sheet1.NamedRange1.Value2 = Me.TextBox1.Text
    End If

End Sub

        private void button1_Click(object sender, EventArgs e)
        {
        if (Globals.Sheet1 != null)
            {
                Globals.Sheet1.namedRange1.Value2 = this.textBox1.Text;
            }
        }

Initialisation de la classe Globals

Code qui tente d'utiliser la classe Globals avant la fin de l'initialisation du document ou du complément peut lever une exception au moment de l'exécution. Par exemple, l'utilisation de Globals lors de la déclaration d'une variable au niveau de la classe peut échouer car la classe Globals peut ne pas être initialisée avec des références à tous les éléments hôtes avant l'instanciation de l'objet déclaré.

Remarque :
La classe Globals n'est jamais initialisée au moment du design, mais des instances de contrôle sont créées par le concepteur. Autrement dit, si vous créez un contrôle utilisateur qui appelle des méthodes de la classe Globals, vous devez écrire du code vérifiant si la méthode retourne la valeur null avant d'essayer d'y accéder.