Classe Documents (Word VBA)
Collection de tous les objets document actuellement ouverts dans Word. Pour utiliser une variable de classe Documents, elle doit d'abord être instanciée, par exemple
Dim docs as Documents
Set docs = Documents
For Each
Voici un exemple de traitement des éléments Documents dans une collection
Dim doc As Document
For Each doc In Documents
Next doc
Add
Renvoie un objet Document qui représente un nouveau document vide ajouté à la collection de documents en cours.
Add (Template, NewTemplate, DocumentType, Visible)
Documents.Add
Arguments
Optional arguments
Les arguments suivants sont facultatifs
Template (String) - Nom du modèle à utiliser pour le nouveau document.
NewTemplate (Boolean) - True pour ouvrir le document comme modèle.
DocumentType (WdNewDocumentType) - Il peut s'agir de l'une des constantes WdNewDocumentType suivantes : wdNewBlankDocument, wdNewEmailMessage, wdNewFrameset ou wdNewWebPage.
Valeurs possibles sont
| wdNewBlankDocument | Document vide. |
| wdNewEmailMessage | Message électronique. |
| wdNewFrameset | Jeu de cadres. |
| wdNewWebPage | Page Web. |
| wdNewXMLDocument | Documents XML. |
Visible (Boolean) - True pour ouvrir le document dans une fenêtre visible.
AddBlogDocument
Renvoie un objet Document qui représente un nouveau document de blog que Microsoft Word publie sur le compte décrit par les trois premiers paramètres.
Cette méthode crée un nouveau document et enregistre également le compte de blog spécifié avec Word s'il n'est pas déjà enregistré.
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
Les arguments nommés :
ProviderID (String) - GUID qui est la valeur unique qu'un fournisseur utilise lorsqu'il s'enregistre auprès de Word.
PostURL - String
BlogName (String) - Nom complet du blog qui sera utilisé dans Word.
Optional arguments
Les arguments suivants sont facultatifs
PostID (String) - ID d'une publication existante à utiliser pour remplir le document créé au moyen de la méthode AddBlogDocument.
CanCheckOut
True : Microsoft Word peut extraire un document donné d'un serveur.
Vous ne pouvez tirer profit des outils de travail collaboratif intégrés dans Microsoft Word que si vos documents sont stockés sur un serveur Microsoft SharePoint Portal Server.
CanCheckOut (FileName)
FileName: Représente le chemin d'accès au serveur et le nom du document.
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
Copie le document spécifié depuis un serveur sur un ordinateur local à des fins d'édition.
Vous ne pouvez tirer profit des outils de travail collaboratif intégrés dans Microsoft Word que si vos documents sont stockés sur un serveur Microsoft SharePoint Portal Server.
CheckOut (FileName)
FileName: Représente le nom du fichier à extraire.
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
Ferme les documents spécifiés.
Close (SaveChanges, OriginalFormat, RouteDocument)
Documents.Close
Arguments
Optional arguments
Les arguments suivants sont facultatifs
SaveChanges (WdSaveOptions) - Spécifie l'enregistrement action pour le document.
Les valeurs de retour possibles sont wdDoNotSaveChanges - Ne pas enregistrer les modifications en attente, wdPromptToSaveChanges - Demander à l'utilisateur s'il faut enregistrer les modifications en attente, wdSaveChanges - Enregistrer les modifications en attente sans la confirmation de l'utilisateur.
OriginalFormat (WdOriginalFormat) - Spécifie l'enregistrement format pour le document.
Les valeurs de retour possibles sont wdOriginalDocumentFormat - Format du document d'origine, wdPromptUser - Format du document demandé à l'utilisateur, wdWordDocument - Format de document Microsoft Word.
RouteDocument (Boolean) - True pour distribuer le document au destinataire suivant.
Count
Renvoie un type Long qui représente le nombre de documents dans la collection.
Dim lngCount As Long
lngCount = Documents.Count
Item
Renvoie un objet Document spécifique appartenant à une collection.
Item (Index)
Index: Index de base 1 de l’objet à renvoyer (long) ou nom de l’objet (String).
Sub DocumentItem()
If Documents.Count >= 1 Then
MsgBox Documents.Item(1).Name
End If
End Sub
Open
Ouvre le document spécifié et l’ajoute à la collection 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 argument nommé
FileName (String) - Nom du document (les chemins d'accès sont acceptés).
Optional arguments
Les arguments suivants sont facultatifs
ConfirmConversions (Boolean) - True pour afficher la boîte de dialogue Convertir un fichier si le fichier n'est pas au format Microsoft Word.
ReadOnly (Boolean) - True: pour ouvrir le document en lecture seule.
AddToRecentFiles (Boolean) - True pour ajouter le nom de fichier à la liste des fichiers récemment utilisés en bas du menu Fichier.
PasswordDocument (String) - Mot de passe nécessaire pour ouvrir le document.
PasswordTemplate (String) - Mot de passe nécessaire pour ouvrir le modèle.
Revert (Boolean) - Contrôle ce qu’il se passe si le nom de fichier est le nom d’un document ouvert.
WritePasswordDocument (String) - Mot de passe nécessaire à l'enregistrement des modifications apportées au document.
WritePasswordTemplate (String) - Mot de passe nécessaire à l'enregistrement des modifications apportées au modèle.
Format (FileConverter) - Convertisseur de fichier à utiliser pour ouvrir le document.
Encoding (String) - Codage du document (page de codes ou jeu de caractères) qui doit être utilisé par Microsoft Word lors de l'affichage du document enregistré.
Visible (Boolean) - True si le document est ouvert dans une fenêtre visible.
OpenAndRepair (Boolean) - True: pour réparer le document afin d'éviter toute altération.
DocumentDirection (WdDocumentDirection) - Indique la direction horizontale de l'enchaînement du texte dans un document.
Les valeurs de retour possibles sont wdLeftToRight - De gauche à droite, wdRightToLeft - De droite à gauche.
NoEncodingDialog (Boolean) - True: pour ne plus afficher la boîte de dialogue Codage que Word affiche lorsque le codage de texte n'est pas reconnu.
XMLTransform - String
OpenNoRepairDialog
Ouvre le document spécifié et l’ajoute à la collection 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
Arguments
Un argument nommé
FileName (String) - Nom du document (les chemins d'accès sont acceptés).
Optional arguments
Les arguments suivants sont facultatifs
ConfirmConversions (Boolean) - True: pour afficher la boîte de dialogue Convertir si le fichier n'est pas au format Microsoft Word.
ReadOnly (Boolean) - True: pour ouvrir le document en lecture seule.
AddToRecentFiles (Boolean) - True pour ajouter le nom de fichier à la liste des fichiers récemment utilisés en bas du menu Fichier.
PasswordDocument (String) - Mot de passe nécessaire pour ouvrir le document.
PasswordTemplate (String) - Mot de passe nécessaire pour ouvrir le modèle.
Revert (Boolean) - Contrôle ce qu’il se passe si le nom de fichier est le nom d’un document ouvert.
WritePasswordDocument (String) - Mot de passe nécessaire à l'enregistrement des modifications apportées au document.
WritePasswordTemplate (String) - Mot de passe nécessaire à l'enregistrement des modifications apportées au modèle.
Format (WdOpenFormat) - Convertisseur de fichier à utiliser pour ouvrir le document.
Ici on trouve valeurs possible pour
Encoding (String) - Codage du document (page de codes ou jeu de caractères) qui doit être utilisé par Microsoft Word lors de l’affichage du document enregistré.
Visible (Boolean) - True si le document est ouvert dans une fenêtre visible.
OpenAndRepair (Boolean) - True: pour réparer le document afin d'éviter toute altération.
DocumentDirection (WdDocumentDirection) - Indique la direction horizontale de l'enchaînement du texte dans un document.
Les valeurs de retour possibles sont wdLeftToRight - De gauche à droite, wdRightToLeft - De droite à gauche.
NoEncodingDialog (Boolean) - True pour ignorer l’affichage de la boîte de dialogue codage que Word affiche si le codage de texte ne peut pas être reconnu.
XMLTransform (String) - Spécifie la transformation à utiliser.
Save
Enregistre tous les documents de la collection Documents.
Si un document n'a pas encore été enregistré, la boîte de dialogue Enregistrer sous invite l'utilisateur à indiquer un nom de fichier.
Save (NoPrompt, OriginalFormat)
Documents.Save
Arguments
Optional arguments
Les arguments suivants sont facultatifs
NoPrompt (Boolean) - True pour que Word mette automatiquement enregistrer tous les documents.
OriginalFormat (WdOriginalFormat) - Spécifie la façon dont les documents sont enregistrés.
Les valeurs de retour possibles sont wdOriginalDocumentFormat - Format du document d'origine, wdPromptUser - Format du document demandé à l'utilisateur, wdWordDocument - Format de document Microsoft Word.