Objets, propriétés et méthodes

Les objets sont les blocs de construction fondamentaux de Microsoft Visual Basic; presque tout ce que vous faites dans Visual Basic implique la modification d’objets. Chaque élément de Microsoft Word( documents, tableaux, paragraphes, signets et champs) peut être représenté par un objet en Visual Basic.

Que sont les objets et les collections ?

Un objet représente un élément de Word, tel qu'un document, un paragraphe, un signet ou un seul caractère. Une collection est un objet qui contient plusieurs autres objets, en général du même type : par exemple, tous les signets d'un document sont contenus dans une seule collection d'objets. En utilisant des propriétés et des méthodes, vous pouvez modifier un objet unique ou une collection entière d’objets.

Qu’est-ce qu’une propriété ?

Une propriété est un attribut d'un objet ou un aspect de son comportement. Par exemple, les propriétés d'un document sont notamment son nom, son contenu, son état d'enregistrement et l'activation ou non du suivi des modifications. Pour modifier les caractéristiques d'un objet, vous changez les valeurs de ses propriétés.

Pour affecter une valeur à une propriété, faites suivre la référence à un objet d'un point, du nom de la propriété, d'un signe égal et de la nouvelle valeur de la propriété. L'exemple ci-dessous montre comment activer le suivi des modifications dans le document nommé « MyDoc.doc ».

Sub TrackChanges() 
    Documents("Sales.doc").TrackRevisions = True 
End Sub

Dans cet exemple, Documents fait référence à la collection de documents ouverts, et le nom « Sales.doc » identifie un seul document dans la collection. Une valeur est affectée à la propriété TrackRevisions pour ce document.

Certaines propriétés ne peuvent pas être définies. La rubrique d'aide relative à chaque propriété indique si vous pouvez affecter une valeur à cette propriété (propriété en lecture/écriture), ou si elle peut uniquement être lue (propriété en lecture seule).

Vous pouvez renvoyer des informations sur un objet en renvoyant la valeur de l'une de ses propriétés. Cet exemple montre comment renvoyer le nom du document actif :

Sub GetDocumentName() 
    Dim strDocName As String 
    strDocName = ActiveDocument.Name 
    MsgBox strDocName 
End Sub

Dans cet exemple, ActiveDocument fait référence au document dans la fenêtre active de Word. Le nom de ce document affecté à la variable fait référence au document dans la fenêtre active dans Word. Le nom de ce document est affecté à la variable strDocName.

Remarques

La rubrique d'aide de chaque propriété indique si vous pouvez affecter une valeur à cette propriété (propriété en lecture/écriture), la lire uniquement (propriété en lecture seule), ou l'écrire uniquement (propriété en écriture seule). En outre, l'Explorateur d'objets de Visual Basic Editor affiche l'état de la propriété en bas de la fenêtre de l'Explorateur lorsque la propriété est sélectionnée.

Qu’est-ce qu’une méthode ?

Une méthode est une action qu’un objet peut effectuer. Par exemple, un document pouvant être imprimé, l'objet Document dispose d'une méthode PrintOut. Les méthodes sont souvent associés à des arguments qui qualifient le mode d'exécution de l'action. L'exemple ci-dessous montre comment imprimer les trois premières pages du document actif.

Sub PrintThreePages() 
    ActiveDocument.PrintOut Range:=wdPrintRangeOfPages, Pages:="1-3" 
End Sub

Dans la plupart des cas, les méthodes sont des actions et les propriétés sont des qualités. L'utilisation d'une méthode génère une opération sur un objet, alors que l'utilisation d'une propriété renvoie des informations sur l'objet ou entraîne la modification de l'une de ses qualités.

Renvoi d'un objet

La plupart des objets sont obtenus en renvoyant un seul objet d'une collection. Par exemple, la collection Documents contient les documents Word ouverts. Vous utilisez la propriété Documents de l'objet Application (objet situé au sommet de la hiérarchie des objets Word) pour renvoyer la collection Documents.

Une fois que vous avez accédé à la collection, vous pouvez renvoyer un seul de ses objets en indiquant une valeur d'index entre parenthèses (cette procédure est similaire à celle utilisée avec les tableaux). La valeur d'index est en général un nombre ou un nom. Pour plus d'informations, voir Renvoi d'un objet à partir d'une collection.

L'exemple ci-dessous montre comment utiliser la propriété Documents pour accéder à la collection Documents. La valeur d'index est utilisée pour renvoyer le premier document de la collection Documents. La méthode Close est ensuite appliquée à l'objet Document pour fermer le premier document de la collection Documents.

Sub CloseDocument() 
    Documents(1).Close 
End Sub

L'exemple ci-dessous montre comment utiliser un nom (indiqué sous la forme d'une chaîne) pour identifier un objet Document au sein de la collection Documents.

Sub CloseSalesDoc() 
    Documents("Sales.doc").Close 
End Sub

Les objets de collection ont souvent des méthodes et des propriétés que vous pouvez utiliser pour modifier l’ensemble de la collection d’objets. L'objet Documents dispose ainsi d'une méthode Save qui enregistre tous les documents de la collection. L'exemple ci-dessous montre comment enregistrer les documents ouverts en appliquant la méthode Save.

Sub SaveAllOpenDocuments() 
    Documents.Save 
End Sub

L’objet Document possède également une méthode Save qui est disponible pour l’enregistrement d’un seul document. Cet exemple montre comment enregistrer le document nommé Sales.doc :

Sub SaveSalesDoc() 
    Documents("Sales.doc").Save 
End Sub

Pour renvoyer un objet situé plus bas dans la hiérarchie des objets Word, vous devez atteindre cet objet en passant par ses antécédents successifs dans la hiérarchie d'objets à l'aide des propriétés et des méthodes.

To see how this is done, open the Visual Basic Editor and click Object Browser on the View menu. Click Application in the Classes list on the left. Then click ActiveDocument from the list of members on the right. The text at the bottom of the Object Browser indicates that ActiveDocument is a read-only property that returns a Document object. Click Document at the bottom of the Object Browser; the Document object is automatically selected in the Classes list, and the Members list displays the members of the Document object. Scroll through the list of members until you find Close. Click the Close method. The text at the bottom of the Object Browser window shows the syntax for the method. For more information about the method, press F1 or click the Help button to jump to the Close method Help topic.

Une fois la syntaxe clarifiée, vous pouvez écrire l'instruction suivante pour fermer le document actif :

Sub CloseDocSaveChanges() 
    ActiveDocument.Close SaveChanges:=wdSaveChanges 
End Sub

Cet exemple montre comment agrandir la fenêtre du document actif :

Sub MaximizeDocumentWindow() 
    ActiveDocument.ActiveWindow.WindowState = wdWindowStateMaximize 
End Sub

La propriété ActiveWindow renvoie un objet Window qui représente la fenêtre active. La constante d'agrandissement (wdWindowStateMaximize) est affectée à la propriété WindowState.

L’exemple suivant crée un document et affiche la boîte de dialogue Enregistrer sous afin qu’un nom puisse être fourni pour le document.

Sub CreateSaveNewDocument() 
    Documents.Add.Save 
End Sub

La propriété Documents renvoie la collection Documents. La méthode Add crée un document et renvoie un objet Document. La méthode Save est ensuite appliquée à l'objet Document.

Comme vous pouvez le voir, vous utilisez des méthodes ou des propriétés pour explorer un objet. Autrement dit, vous retournez un objet en appliquant une méthode ou une propriété à un objet situé au-dessus de celui-ci dans la hiérarchie d’objets. Après avoir retourné l’objet souhaité, vous pouvez appliquer les méthodes et contrôler les propriétés de cet objet.

Obtention d'aide sur les objets, les méthodes et les propriétés

Jusqu’à ce que vous vous familiarisiez avec le modèle objet Word, vous pouvez utiliser des outils pour vous aider à explorer la hiérarchie.

• Microsoft IntelliSense. Lorsque vous tapez un point (.) après un objet dans Visual Basic Editor, la liste des propriétés et méthodes disponibles s'affiche. Par exemple, si vous tapez Application., une liste déroulante des méthodes et des propriétés de l'objet Application apparaît.

• Aide. Vous pouvez aussi utiliser l'aide pour déterminer quelles propriétés et méthodes peuvent être utilisées avec un objet. Chacune des rubriques consacrées aux objets dispose d'un renvoi intitulé Voir aussi qui affiche la liste des propriétés et méthodes disponibles pour l'objet. Appuyez sur F1 dans l’Explorateur d’objets ou dans un module pour accéder à la rubrique d’aide appropriée.

• Explorateur d'objets. L'Explorateur d'objets de Visual Basic Editor affiche les membres (propriétés et méthodes) des objets Word.

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.