Clase Documents (Word VBA)

Colección de todos los objetos Document actualmente abiertos en Word. Para usar una variable de clase Documents, primero debe ser instanciado, por ejemplo


Dim docs as Documents
Set docs = Documents

For Each

A continuación, se muestra un ejemplo de cómo procesar los elementos Documents en una colección.


Dim doc As Document
For Each doc In Documents
	
Next doc

Add

Devuelve un objeto Document que representa un documento nuevo y vacío agregado a la colección de documentos abiertos.

Add (Template, NewTemplate, DocumentType, Visible)


Documents.Add

Arguments

Optional arguments

Los siguientes argumentos son opcionales

Template (String) - El nombre de la plantilla que se usará para el documento nuevo.

NewTemplate (Boolean) - True para abrir el documento como plantilla.

DocumentType (WdNewDocumentType) - Puede ser una de las siguientes constantes de WdNewDocumentType: wdNewBlankDocument, wdNewEmailMessage, wdNewFrameset, o wdNewWebPage.

Valores posibles son

wdNewBlankDocument	Documento en blanco.
wdNewEmailMessage	Mensaje de correo electrónico.
wdNewFrameset	Conjunto de marcos.
wdNewWebPage	Página Web.
wdNewXMLDocument	Documento XML.

Visible (Boolean) - True para abrir el documento en una ventana visible.

AddBlogDocument

Devuelve un objeto Document que representa el documento de un nuevo blog que publica Microsoft Word en la cuenta descrita por los tres primeros parámetros.

Este método crea un nuevo documento y también registra la cuenta de blog especificada con Word si ya no está registrado.

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

Estos son los argumentos con nombre :

ProviderID (String) - GUID que es el único valor que usa el proveedor al registrarse con Word.

PostURL - String

BlogName (String) - Nombre para mostrar del blog que se usará en Word.

Optional arguments

Los siguientes argumentos son opcionales

PostID - String

CanCheckOut

True si Microsoft Word puede desproteger un documento especificado desde un servidor.

Para beneficiarse de las funciones de colaboración integradas en Word, los documentos deben almacenarse en Microsoft SharePoint Portal Server.

CanCheckOut (FileName)

FileName: Ruta de acceso al servidor y el nombre del documento.


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 un documento específico desde un servidor a un equipo local para modificarlo.

Para beneficiarse de las funciones de colaboración integradas en Word, los documentos deben almacenarse en Microsoft SharePoint Portal Server.

CheckOut (FileName)

FileName: Nombre del archivo que se va a desproteger.


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

Cierra los documentos especificados.

Close (SaveChanges, OriginalFormat, RouteDocument)


Documents.Close

Arguments

Optional arguments

Los siguientes argumentos son opcionales

SaveChanges (WdSaveOptions) - Especifica la operación de guardar la acción para el documento.

Posibles valores de retorno son wdDoNotSaveChanges - No guardar los cambios pendientes, wdPromptToSaveChanges - Solicitar al usuario que guarde los cambios pendientes, wdSaveChanges - Guardar automáticamente los cambios pendientes sin preguntar al usuario.

OriginalFormat (WdOriginalFormat) - Especifica la operación de guardar formato para el documento.

Posibles valores de retorno son wdOriginalDocumentFormat - Formato de documento original, wdPromptUser - Solicitar al usuario que seleccione un formato de documento, wdWordDocument - Formato de documento de Microsoft Word.

RouteDocument (Boolean) - True para distribuir el documento al siguiente destinatario.

Count

Devuelve un Long que representa el número de documentos de la colección.


Dim lngCount As Long
lngCount = Documents.Count

Item

Devuelve un objeto Document individual de una colección.

Item (Index)

Index: Índice basado en uno del objeto que se va a devolver (Long) o el nombre del objeto (String).


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

Open

Abre el documento especificado y lo agrega a la colección Documents.

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

Un argumento con nombre

FileName (String) - Nombre del documento (se aceptan rutas de acceso).

Optional arguments

Los siguientes argumentos son opcionales

ConfirmConversions (Boolean) - True para mostrar el cuadro de diálogo Convertir archivo si el archivo no está en formato de Microsoft Word.

ReadOnly (Boolean) - True para abrir el documento como sólo lectura.

AddToRecentFiles (Boolean) - True para agregar el nombre de archivo a la lista de archivos usados recientemente en la parte inferior del menú Archivo.

PasswordDocument (String) - Contraseña para poder abrir el documento.

PasswordTemplate (String) - Contraseña para poder abrir la plantilla.

Revert (Boolean) - Controla lo que ocurre si FileName es el nombre de un documento abierto.

WritePasswordDocument (String) - Contraseña para guardar los cambios del documento.

WritePasswordTemplate (String) - Contraseña para guardar los cambios de la plantilla.

Format (FileConverter) - Convertidor de archivos que se debe usar para abrir el documento.

Encoding (String) - Codificación de documentos (página de códigos o juego de caracteres) que debe usar Microsoft Word para mostrar el documento guardado.

Visible (Boolean) - True si el documento se abre en una ventana visible.

OpenAndRepair (Boolean) - True para reparar el documento y evitar que se dañe.

DocumentDirection (WdDocumentDirection) - Indica el flujo de texto horizontal en un documento.

Posibles valores de retorno son wdLeftToRight - De izquierda a derecha, wdRightToLeft - De derecha a izquierda.

NoEncodingDialog (Boolean) - True para no mostrar el cuadro de diálogo Codificación que abre Word cuando no reconoce el texto.

XMLTransform - String

OpenNoRepairDialog

Abre el documento especificado y lo agrega a la colección Documents.

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