Ler em inglês

Compartilhar via


Objeto variável (Word)

Representa uma variável armazenada como parte de um documento. As variáveis de documento são usadas para preservar as configurações de macro, de uma sessão de macro para outra. O objeto Variable é um membro da coleção Variables . A coleção Variables inclui todas as variáveis de documento de um modelo ou de um documento.

Comentários

Use variáveis (Index), onde Index é o nome da variável de documento ou número de índice, para retornar um único objeto da variável. O exemplo a seguir exibe o valor da variável de documento Temp do documento ativo.

MsgBox ActiveDocument.Variables("Temp").Value

O número de índice representa a posição da variável de documento na coleção Variables. A última variável adicionada à coleção Variables recebe o número de índice 1; a penúltima variável adicionada à coleção recebe o número de índice 2 e assim por diante. O exemplo a seguir exibe o nome da primeira variável de documento no documento ativo.

MsgBox ActiveDocument.Variables(1).Name

Use o método Add da coleção Variables para adicionar uma variável a um documento. O exemplo a seguir adiciona uma variável de documento chamada "Temp" com um valor de 12 ao documento ativo.

ActiveDocument.Variables.Add Name:="Temp", Value:="12"

Se você tentar adicionar uma variável de documento com um nome que já existe na coleção Variables, ocorrerá um erro. Para evitar esse erro, você pode enumerar a coleção antes de adicionar quaisquer variáveis novas. Se a variável de documento Blue já existir no documento ativo, o exemplo a seguir definirá seu valor para 6. Se essa variável ainda não existir, o exemplo a adicionará ao documento e a definirá como 6.

For Each aVar In ActiveDocument.Variables 
 If aVar.Name = "Blue" Then num = aVar.Index 
Next aVar 
If num = 0 Then 
 ActiveDocument.Variables.Add Name:="Blue", Value:=6 
Else 
 ActiveDocument.Variables(num).Value = 6 
End If

As variáveis de documento são invisíveis para o usuário, a menos que o campo DOCVARIABLE seja inserido com o nome de variável adequado. O exemplo a seguir adiciona a variável de documento "Temp" ao documento ativo e, em seguida, insere um campo DOCVARIABLE para exibir o valor na variável.

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

Para adicionar uma variável de documento a um modelo, abra o modelo como um documento usando o método OpenAsDocument . O exemplo a seguir armazena o nome de usuário (da caixa de diálogo Opções ) no modelo anexado ao documento ativo.

ScreenUpdating = False 
With ActiveDocument.AttachedTemplate.OpenAsDocument 
 .Variables.Add Name:="UserName", Value:=Application.UserName 
 .Close SaveChanges:=wdSaveChanges 
End With

Confira também

Referência do modelo de objeto do Word

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.