Objets (Modèle de complément Visual Basic)

AddIn

L'objet AddIn fournit des informations sur un complément à d'autres compléments.

Syntaxe

objet . AddIn

Remarques

Un objet AddIn est créé pour chaque complément qui apparaît dans le Gestionnaire de compléments.

CodeModule

Représente le code sous-jacent d’un composant, tel qu’un formulaire, une classe ou un document.

Remarques

Vous utilisez l’objet CodeModule pour modifier (ajouter, supprimer ou modifier) le code associé à un composant. Chaque composant est associé à un objet CodeModule. Toutefois, un objet CodeModule peut être associé à plusieurs volets de code.

Les méthodes associées à l’objet CodeModule vous permettent de manipuler et de renvoyer des informations sur le texte du code, ligne après ligne. Par exemple, vous pouvez utiliser la méthode AddFromString pour ajouter du texte au module. AddFromString place le texte juste au-dessus de la première procédure du module ou place le texte à la fin du module, s’il n’y a pas de procédures.

Utilisez la propriété Parent pour renvoyer l’objet VBComponent associé à un module de code.

CodePane

Représente un volet de code.

Remarques

Utilisez l’objet CodePane pour manipuler la position du texte visible ou de la sélection de texte affichée dans le volet de code.

Utilisez la méthode Show pour rendre visible le volet de code que vous spécifiez.

Utilisez la méthode SetSelection pour définir la sélection dans un volet de code.

Utilisez la méthode GetSelection pour renvoyer l’emplacement de la sélection dans un volet de code.

Barre de commandes

L’objet CommandBar contient d’autres objets CommandBar, qui se comportent comme des boutons ou des commandes de menu.

Syntaxe

CommandBar

CommandBarEvents

Retourné par la propriété CommandBarEvents . L'objet CommandBarEvents déclenche un événement lorsque vous cliquez sur un contrôle dans la barre de commandes

Remarques

L’objet CommandBarEvents est retourné par la propriété CommandBarEvents de l’objet Events.

L’objet retourné a un événement dans son interface, l’événement Click . Vous pouvez gérer cet événement à l’aide de la déclaration de l’objet WithEvents .

Événements

Fournit des propriétés qui permettent à des compléments de se connecter à tous les événements dans Visual Basic pour Applications.

Remarques

L'objet Events transmet des propriétés qui renvoient des objets source d'événements. Utilisez les propriétés pour renvoyer des objets source d'événement qui vous signalent les modifications apportées à l'environnement Visual Basic pour Applications.

Les propriétés de l'objet Events renvoient des objets du même type que le nom de la propriété. Par exemple, la propriétéCommandBarEvents renvoie l’objetCommandBarEvents.

Propriété

Représente les propriétés d’un objet, visibles dans la fenêtre Propriétés associée à un composant donné.

Remarques

Utilisez la propriété Value de l’objet Property pour renvoyer ou définir la valeur d’une propriété d’un composant.

Au minimum, tous les composants ont une propriété Name . La propriété Value renvoie un Variant du type approprié. Si la valeur retournée est un objet, la propriété Value renvoie la collection Properties qui contient des objets Property représentant les propriétés individuelles de l’objet. Vous pouvez accéder à chacun des objets Property à l’aide de la méthode Item sur la collection Properties retournée.

Si la valeur renvoyée par l’objet Property est un objet, vous pouvez utiliser la propriété Object pour définir l’objet Property sur un nouvel objet.

Référence

Représente une référence à une bibliothèque de types ou à un projet.

Remarques

Utilisez l’objet Reference pour vérifier si une référence est toujours valide.

La propriété IsBroken renvoie la valeur True si la référence ne pointe plus vers une référence valide.

La propriété BuiltIn renvoie la valeur True si la référence est une référence par défaut qui ne peut pas être déplacée ou supprimée.

Utilisez la propriété Name pour déterminer si la référence que vous souhaitez ajouter ou supprimer est correcte.

Consultez également les propriétés Description et Type .

ReferencesEvents

Retourné par la propriété ReferencesEvents .

Remarques

L’objet ReferencesEvents est la source des événements se produisant lors de l’ajout ou de la suppression d’une référence à un projet.

L’événement ItemAdded est déclenché après l’ajout d’une référence à un projet.

L’événement ItemRemoved est déclenché après la suppression d’une référence d’un projet.

VBComponent

Représente un composant, par exemple un module de classe ou un module standard, contenu dans un projet.

Remarques

Utilisez l’objet VBComponent pour accéder à l’objet CodeModule associé à un composant ou pour modifier les paramètres de propriété d’un composant.

Utilisez la propriété Type pour déterminer le type de composant auquel l’objet VBComponent fait référence.

Utilisez la propriété Collection pour connaître la collection dans laquelle se trouve le composant.

VBE

Objet racine qui contient tous les autres objets et collections représentés dans Visual Basic pour Applications.

Remarques

Utilisez les collections suivantes pour accéder aux objets contenus dans l’objet VBE :

• Utilisez la collection VBProjects pour accéder à la collection de projets.

• Utilisez la collection AddIns pour accéder à la collection de compléments.

• Utilisez la collection Windows pour accéder à la collection de fenêtres.

• Utilisez la collection CodePanes pour accéder la collection de volets Code.

• Utilisez la collection CommandBars pour accéder à la collection de barres de commandes.

Utilisez l’objet Events pour accéder aux propriétés qui permettent aux compléments de se connecter à tous les événements dans Visual Basic pour Applications. Les propriétés de l'objet Events renvoient des objets du même type que le nom de la propriété. Par exemple, la propriétéCommandBarEvents renvoie l’objetCommandBarEvents.

Utilisez la propriété SelectedVBComponent pour renvoyer le composant actif. Le composant actif est celui qui fait l'objet d'un suivi dans la fenêtre de projet. Si l’élément sélectionné dans la fenêtre Projet n’est pas un composant, SelectedVBComponent renvoie Nothing.

Remarque

Tous les objets de ce modèle objet ont une propriété VBE qui pointe vers l’objet VBE .

VBProject

Représente un projet.

Remarques

Utilisez l’objet VBProject pour définir les propriétés du projet et accéder aux collections VBComponents et References .

Fenêtre

Représente une fenêtre dans l’environnement de développement.

Remarques

Utilisez l’objet Window pour afficher, masquer ou positionner des fenêtres.

Importante

Les objets, propriétés et méthodes pour le contrôle des fenêtres liées, des cadres de fenêtres liées et des fenêtres ancrées sont fournis sur Macintosh à des fins de compatibilité avec le code écrit dans Windows. Cependant, ces éléments de langage génèrent des erreurs d’exécution lorsqu’ils sont exécutés sur Macintosh.

Utilisez la méthode Close pour fermer une fenêtre dans la collection Windows . La méthode Close affecte différents types de fenêtres comme suit :

Fenêtre	Résultat de la méthode Close
Fenêtre Code	Supprime la fenêtre de la collection Windows.
Designer	Supprime la fenêtre de la collection Windows.
Objets Window de type cadre de fenêtres liées	Les fenêtres deviennent des fenêtres séparées et non liées.

Remarque

L’utilisation de la méthode Close avec des fenêtres Code et des fenêtres de conception a pour effet de fermer la fenêtre. La définition de la propriété Visible sur False masque la fenêtre, mais ne la ferme pas. L’application de la méthode Close à des fenêtres d’environnement de développement, comme la fenêtre Projet ou la fenêtre Propriétés, équivaut à attribuer la valeur False à la propriété Visible.

Utilisez la méthode SetFocus pour déplacer le focus vers une fenêtre.

Utilisez la propriété Visible pour renvoyer ou définir la visibilité d’une fenêtre.

Pour déterminer le type de fenêtre que vous utilisez, vous pouvez utiliser la propriété Type . Si vous avez plusieurs fenêtres d’un type, par exemple plusieurs concepteurs, vous pouvez utiliser la propriété Caption pour déterminer la fenêtre avec laquelle vous travaillez.

Vous pouvez également trouver la fenêtre que vous souhaitez utiliser à l’aide de la propriété DesignerWindow de l’objet VBComponent ou de la propriété Window de l’objet CodePane .

Voir aussi

• Objets (Microsoft Forms)
• Objets et collections (Visual Basic pour Applications)
• Informations de référence sur le modèle de complément Visual Basic
• Référence du langage Visual Basic
• Référence de développement de client Office

Assistance et commentaires

Avez-vous des questions ou des commentaires sur Office VBA ou sur cette documentation ? Consultez la rubrique concernant l’assistance pour Office VBA et l’envoi de commentaires afin d’obtenir des instructions pour recevoir une assistance et envoyer vos commentaires.