Classe Variable (Word VBA)

La classe Variable représente une variable stockée en tant que partie d’un document.

Set

Pour utiliser une variable de classe Variable, elle doit d'abord être instanciée, par exemple

Dim vrb as Variable
Set vrb = ActiveDocument.Variables(Index:=1)

Les procédures suivantes peuvent être utilisés pour définir des variables de la classe Variable : Variables.Add, Variables.Item et Document.Variables

For Each

Voici un exemple de traitement des éléments Variable dans une collection

Dim vrb As Variable
For Each vrb In ActiveDocument.Variables
	
Next vrb

Delete

Supprime la variable spécifiée.

ActiveDocument.Variables(1).Delete

Index

Renvoie un type long qui représente la position ordinale d’une variable avec dans la collection de variables.

Set myVar = ActiveDocument.Variables.Add(Name:="Name", _ 
 Value:="Joe") 
num = myVar.Index

Name

Renvoie le nom de l'objet spécifié.

Dim strName As String
strName = ActiveDocument.Variables(1).Name

Parent

Renvoie un type de données Object qui représente l'objet parent de l'objet Variable spécifié.

Dim objParent As Object
Set objParent = ActiveDocument.Variables(1).Parent

Value

Cette propriété renvoie ou définit la valeur d'une variable de document.

ActiveDocument.Variables.Add Name:="Temp2", Value:="10" 
MsgBox ActiveDocument.Variables("Temp2").Value

Variables.Add

Renvoie un objet variable qui représente une variable ajoutée à un document.

Les variables de document sont invisibles pour l'utilisateur, sauf si un champ DOCVARIABLE est inséré avec le nom de la variable approprié.

Syntaxe : expression.Add (Name, Value)

With ActiveDocument 
 .Variables.Add Name:="Temp", Value:="12" 
 .Fields.Add Range:=Selection.Range, _ 
 Type:=wdFieldDocVariable, Text:="Temp" 
End With 
ActiveDocument.ActiveWindow.View.ShowFieldCodes = False

Arguments

Un argument nommé

Name (String) - Nom de la variable.

Les arguments suivants sont facultatifs

Value (Variant) - Valeur de la variable.

Variables.Count

Renvoie un type long qui représente le nombre de variables dans la collection.

Dim lngCount As Long
lngCount = ActiveDocument.Variables.Count

Variables.Item

Renvoie un objet variable spécifique appartenant à une collection.

Syntaxe : expression.Item (Index)

Index: Objet spécifique qui doit être renvoyé.

Dim vrb As Variable
Set vrb = ActiveDocument.Variables(Index:=1)

Variables.Parent

Renvoie un Object qui représente l'objet parent de l'objet Variables spécifié.

Dim objParent As Object
Set objParent = ActiveDocument.Variables.Parent