Classe Documents (Word VBA)

Uma coleção de todos os objetos Document que estão abertos no Word no momento. Para usar uma variável de classe Documents, ela primeiro precisa ser instanciada por exemplo

Dim docs as Documents
Set docs = Documents

For Each

Aqui está um exemplo de processamento dos itens Documents em uma coleção.

Dim doc As Document
For Each doc In Documents
	
Next doc

Add

Retorna um objeto Document que representa um documento novo e vazio adicionado à coleção de documentos abertos.

Add (Template, NewTemplate, DocumentType, Visible)

Documents.Add

Arguments

Optional arguments

Os seguintes argumentos são opcionais

Template (String) - O nome do modelo a ser usado para o novo documento. Se esse argumento for omitido, será usado o modelo Normal.

NewTemplate (Boolean) - True para abrir o documento como um modelo. O valor padrão é False.

DocumentType (WdNewDocumentType) - Pode ser uma das seguintes constantes WdNewDocumentType: wdNewBlankDocument, wdNewEmailMessage, wdNewFrameset ou wdNewWebPage. A constante padrão é wdNewBlankDocument.

Os valores possíveis são

Visible (Boolean) - True para abrir o documento em uma janela visível. Se esse valor for False, o Microsoft Word abre o documento, mas define a propriedade Visible da janela do documento como False. O valor padrão é True.

AddBlogDocument

Retorna um objeto Document que representa um novo documento do blog que o Microsoft Word publica para a conta descrita pelos primeiros três parâmetros.

Este método cria um novo documento, e também registra a conta de blog especificado com o Word se ele já não estiver registrado. Além disso, se o parâmetro PostID for especificado, o novo documento é preenchido com o conteúdo da postagem especificado pelo valor do parâmetro PostID, do site do provedor.

AddBlogDocument (ProviderID, PostURL, BlogName, PostID)

Dim strProviderID As String: strProviderID = 
Dim strPostURL As String: strPostURL = 
Dim strBlogName As String: strBlogName =  
Dim docAddBlogDocument As Document
Set docAddBlogDocument = Documents.AddBlogDocument(ProviderID:=strProviderID, PostURL:=strPostURL, BlogName:=strBlogName)

Arguments

O seguinte argumento é opcional

ProviderID (String) - Um GUID é o valor exclusivo usado pelos fornecedores quando se registram no Word.

PostURL (String) - A URL usada para adicionar postagens no blog.

BlogName (String) - Um nome para o blog que será usado no Word.

Optional arguments

The following argument is optional

PostID (String) - A identificação de uma postagem existente com a qual preencher o documento criado usando o método AddBlogDocument.

CanCheckOut

True se o Microsoft Word pude retirar um documento especificado de um servidor. Boolean de leitura/gravação.

Para usufruir vantagem dos recursos de colaboração internos do Word, os documentos precisam ser armazenados em um Microsoft SharePoint Portal Server.

CanCheckOut (FileName)

FileName: O nome e caminho do documento no servidor.

Sub CheckInOut(docCheckOut As String) 
 If Documents.CanCheckOut(docCheckOut) = True Then 
 Documents.CheckOut docCheckOut 
 Else 
 MsgBox "You are unable to check out this document at this time." 
 End If 
End Sub

CheckOut

Copia um documento especificado de um servidor para um computador local para edição.

Para usufruir vantagem dos recursos de colaboração internos do Word, os documentos precisam ser armazenados em um Microsoft SharePoint Portal Server.

CheckOut (FileName)

FileName: O nome do arquivo para ser retirado.

Sub CheckInOut(docCheckOut As String) 
 If Documents.CanCheckOut(docCheckOut) = True Then 
 Documents.CheckOut docCheckOut 
 Else 
 MsgBox "You are unable to check out this document at this time." 
 End If 
End Sub

Close

Fecha os documentos especificados.

Close (SaveChanges, OriginalFormat, RouteDocument)

Documents.Close

Arguments

Optional arguments

Os seguintes argumentos são opcionais

SaveChanges (WdSaveOptions) - Especifica o salvamento ação para o documento. Pode ser uma das seguintes constantes WdSaveOptions: wdDoNotSaveChanges, wdPromptToSaveChanges ou wdSaveChanges.

Os valores de retorno possíveis são wdDoNotSaveChanges - Não salva alterações pendentes, wdPromptToSaveChanges - Solicita ao usuário que salve as alterações pendentes, wdSaveChanges - Salva as alterações pendentes automaticamente sem solicitar ao usuário.

OriginalFormat (WdOriginalFormat) - Especifica a salvar formato para o documento. Pode ser uma das seguintes constantes WdOriginalFormat: wdOriginalDocumentFormat, wdPromptUser ou wdWordDocument.

Os valores de retorno possíveis são wdOriginalDocumentFormat - Formato do documento original, wdPromptUser - Solicita que o usuário selecione um formato de documento, wdWordDocument - Formato de documento do Microsoft Word.

RouteDocument (Boolean) - True para encaminhar o documento para o próximo destinatário. Se o documento não tiver uma lista de circulação anexada, este argumento será ignorado.

Count

Retorna um Long que representa o número de documentos na coleção. Somente leitura.

Dim lngCount As Long
lngCount = Documents.Count

Item

Retorna um objeto Document individual em uma coleção.

Item (Index)

Index: Um índice baseado em um do objeto a ser retornado (Long) ou o nome do objeto (String).

Sub DocumentItem() 
 If Documents.Count >= 1 Then 
 MsgBox Documents.Item(1).Name 
 End If 
End Sub

Open

Abre o documento especificado e o adiciona à coleção de documentos. Retorna um objeto de documento.

Open (FileName, ConfirmConversions, ReadOnly, AddToRecentFiles, PasswordDocument, PasswordTemplate, Revert, WritePasswordDocument, WritePasswordTemplate, Format, Encoding, Visible, OpenAndRepair, DocumentDirection, NoEncodingDialog, XMLTransform)

Sub OpenDoc() 
 Documents.Open FileName:="C:\MyFiles\MyDoc.doc", ReadOnly:=True 
End Sub

Arguments

O seguinte argumento é necessário

FileName (String) - O nome do documento (caminhos são aceitos).

Optional arguments

Os seguintes argumentos são opcionais

ConfirmConversions (Boolean) - True para exibir a caixa de diálogo Converter arquivo se o arquivo não estiver no formato do Microsoft Word.

ReadOnly (Boolean) - True para abrir o documento como somente leitura. Este argumento não substituir somente leitura configuração em um documento salvo recomendada. Por exemplo, se um documento foi salvo com somente leitura recomendado ativado, definindo o argumento de somente leitura para Falso não fará o arquivo ser aberto como somente leitura.

AddToRecentFiles (Boolean) - True para adicionar o nome de arquivo à lista de arquivos usados recentemente na parte inferior do menu arquivo.

PasswordDocument (String) - A senha para abertura do documento.

PasswordTemplate (String) - A senha para abertura do modelo.

Revert (Boolean) - Controla o que acontece se o nome do arquivo é o nome de um documento aberto. True para descartar as alterações não salvas no documento aberto e reabrir o arquivo. Falso para ativar o documento aberto.

WritePasswordDocument (String) - A senha para gravação de alterações no documento.

WritePasswordTemplate (String) - A senha para gravação de alterações no modelo.

Format (FileConverter) - O conversor de arquivo a ser usado para abrir o documento. Pode ser uma das seguintes constantes. O valor padrão é wdOpenFormatAuto. Para especificar um formato de arquivo externo, aplique a propriedade OpenFormat a um objeto FileConverter para determinar o valor a ser usado com esse argumento.

Encoding (String) - A codificação (conjunto de caracteres ou páginas de código) para ser usada pelo Microsoft Word quando você vê o documento salvo de documento. Pode ser qualquer constante MsoEncoding válida. Para a lista de constantes MsoEncoding válidas, consulte o Pesquisador de objetos no Editor do Visual Basic. O valor padrão é a página de código do sistema.

Visible (Boolean) - True se o documento é aberto em uma janela visível. O valor padrão é True.

OpenAndRepair (Boolean) - True para reparar o documento para evitar a corrupção de documento.

DocumentDirection (WdDocumentDirection) - Indica o fluxo horizontal do texto em um documento. O valor padrão é wdLeftToRight.

Os valores de retorno possíveis são wdLeftToRight - Da esquerda para a direita, wdRightToLeft - Da direita para a esquerda.

NoEncodingDialog (Boolean) - Verdadeiro para ignorar a exibição na caixa de diálogo de codificação que o Word exibe se a codificação de texto não pode ser reconhecida. O valor padrão é False.

XMLTransform - String

OpenNoRepairDialog

Abre o documento especificado e o adiciona à coleção de documentos.

OpenNoRepairDialog (FileName, ConfirmConversions, ReadOnly, AddToRecentFiles, PasswordDocument, PasswordTemplate, Revert, WritePasswordDocument, WritePasswordTemplate, Format, Encoding, Visible, OpenAndRepair, DocumentDirection, NoEncodingDialog, XMLTransform)

Sub OpenDoc() 
 Documents.OpenNoRepairDialog FileName:="C:\MyFiles\MyDoc.doc", ReadOnly:=True 
End Sub

Arguments

O seguinte argumento é necessário

FileName (String) - O nome do documento (caminhos são aceitos).

Optional arguments

Os seguintes argumentos são opcionais

ConfirmConversions (Boolean) - True para exibir a caixa de diálogo Converter Arquivo se o arquivo não estiver no formato do Microsoft Word.

ReadOnly (Boolean) - True para abrir o documento como somente leitura. Esse argumento não anula a configuração somente leitura recomendada de um documento salvo. Por exemplo, se um documento foi salvo com somente leitura recomendado ativado, definindo o argumento de somente leitura para Falso não fará o arquivo ser aberto como somente leitura.

AddToRecentFiles (Boolean) - True para adicionar o nome de arquivo à lista de arquivos usados recentemente na parte inferior do menu arquivo.

PasswordDocument (String) - A senha para abertura do documento.

PasswordTemplate (String) - A senha para abertura do modelo.

Revert (Boolean) - Controla o que acontece se o nome do arquivo é o nome de um documento aberto. True para descartar as alterações não salvas no documento aberto e reabrir o arquivo. Falso para ativar o documento aberto.

WritePasswordDocument (String) - A senha para gravação de alterações no documento.

WritePasswordTemplate (String) - A senha para gravação de alterações no modelo.

Format (WdOpenFormat) - O conversor de arquivo a ser usado para abrir o documento. Pode ser uma das constantes WdOpenFormat . O padrão é wdOpenFormatAuto.

Aqui você pode encontrar os valores possíveis para WdOpenFormat

Encoding (String) - A codificação do documento (página de código ou conjunto de caracteres) a ser usada pelo Word quando você visualizar o documento salvo. Pode ser qualquer constante MsoEncoding válida. Para a lista de constantes MsoEncoding válidas, consulte o Pesquisador de objetos no Editor do Visual Basic. O padrão é a página de código do sistema.

Visible (Boolean) - True se o documento é aberto em uma janela visível. O padrão é True.

OpenAndRepair (Boolean) - True para reparar o documento para evitar a corrupção de documento.

DocumentDirection (WdDocumentDirection) - Indica o fluxo horizontal do texto em um documento. Pode ser qualquer constante WdDocumentDirection válida. O padrão é wdLeftToRight.

Os valores de retorno possíveis são wdLeftToRight - Da esquerda para a direita, wdRightToLeft - Da direita para a esquerda.

NoEncodingDialog (Boolean) - True para ignorar a exibição da caixa de diálogo de codificação que o Word exibe se a codificação de texto não puder ser reconhecida. O padrão é False.

XMLTransform (String) - Especifica uma transformação a ser usada.

Save

Salva todos os documentos na coleção Documents.

Se um documento não tiver sido salvo antes, a caixa de diálogo Salvar como pedirá ao usuário um nome de arquivo.

Save (NoPrompt, OriginalFormat)

Documents.Save

Arguments

Optional arguments

Os seguintes argumentos são opcionais

NoPrompt (Boolean) - True para que o Word automaticamente salvar todos os documentos. False para que o Word peça o usuário salve cada documento que tenha sido alterado desde que foi salvo pela última vez.

OriginalFormat (WdOriginalFormat) - Especifica a maneira como os documentos são salvos. Pode ser uma das constantes WdOriginalFormat.

Os valores de retorno possíveis são wdOriginalDocumentFormat - Formato do documento original, wdPromptUser - Solicita que o usuário selecione um formato de documento, wdWordDocument - Formato de documento do Microsoft Word.