Klasse Documents (Word VBA)

Eine Auflistung aller Document -Objekte, die derzeit in Word geöffnet sind.

Um eine Documents -Klassenvariable zu verwenden, muss sie zuerst instanziert werden, beispielsweise

Dim docs as Documents
Set docs = Documents

Klassen Variablen vom Typ Documents können mit der Prozedur Application.Documents festgelegt werden

For Each

Hier ist ein Beispiel für die Verarbeitung der Documents -Elemente in einer Sammlung

Dim doc As Document
For Each doc In Documents
	
Next doc

Add

Gibt ein Objekt Document zurück, das ein neues leeres Dokument repräsentiert, das der Sammlung an offenen Dokumenten hinzugefügt wurde.

Add (Template, NewTemplate, DocumentType, Visible)

Documents.Add

Arguments

Optional arguments

Die folgenden Argumente sind optional

Template (Template) - Der Name der Vorlage, die für das neue Dokument verwendet werden soll.

NewTemplate (Boolean) - Bei dem Wert True wird das Dokument als eine Vorlage geöffnet.

DocumentType (WdNewDocumentType) - Kann eine der folgenden WdNewDocumentType-Konstanten sein: wdNewBlankDocument, wdNewEmailMessage, wdNewFrameset oder wdNewWebPage.


Möglichen Werte sind

wdNewBlankDocument Leeres Dokument.
wdNewEmailMessage E-Mail-Nachricht.
wdNewFrameset Frameset.
wdNewWebPage Webseite.
wdNewXMLDocument XML-Dokument.

Visible (Boolean) - Bei dem Wert True wird das Dokument in einem sichtbaren Fenster geöffnet.

AddBlogDocument

Gibt ein Document-Objekt zurück, das ein neues Blogdokument darstellt, das Microsoft Word für das durch die ersten drei Parameter beschriebenen Konto veröffentlicht.

Mithilfe dieser Methode wird ein Dokument erstellt und auch der angegebene Blog bei Word registriert, wenn er noch nicht registriert ist.

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

Hier sind die benannte Argumente :

ProviderID (String) - Eine GUID, bei der es sich um den eindeutigen Wert handelt, den ein Anbieter verwendet, wenn er sich selbst bei Word registriert.

PostURL (String) - Die URL, die beim Hinzufügen von Beiträgen zum Blog verwendet wird.

BlogName (String) - Ein Anzeigename für den Blog zur Verwendung in Word.

Optional arguments

Das folgendes Argument ist optional

PostID (String) - Die Kennung für einen vorhandenen Beitrag, mit dem das mithilfe der AddBlogDocument-Methode erstellte Dokument ausgefüllt wird.

CanCheckOut

True, wenn Microsoft Word ein angegebenes Dokument auf einem Server auschecken kann.

Damit die Vorteile der in Word integrierten Zusammenarbeitsfunktionen genutzt werden können, müssen Dokumente auf einem Microsoft SharePoint-Portalserver gespeichert werden.

CanCheckOut (FileName)

FileName: Serverpfad und Name des Dokuments.

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

Kopiert ein angegebenes Dokument zur Bearbeitung von einem Server auf einen lokalen Computer.

Damit die Vorteile der in Word integrierten Zusammenarbeitsfunktionen genutzt werden können, müssen Dokumente auf einem Microsoft SharePoint-Portalserver gespeichert werden.

CheckOut (FileName)

FileName: Der Name der auszucheckenden Datei.

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

Schließt die angegebenen Dokumente.

Close (SaveChanges, OriginalFormat, RouteDocument)

Documents.Close

Arguments

Optional arguments

Die folgenden Argumente sind optional

SaveChanges (WdSaveOptions) - Gibt die Speichern-Aktion für das Dokument an.

Mögliche Rückgabewerte sind wdDoNotSaveChanges - Anstehende Änderungen werden nicht gespeichert, wdPromptToSaveChanges - Der Benutzer wird aufgefordert, anstehende Änderungen zu speichern, wdSaveChanges - Anstehende Änderungen werden automatisch gespeichert.

OriginalFormat (WdOriginalFormat) - Gibt das Speicherformat für das Dokument an.

Mögliche Rückgabewerte sind wdOriginalDocumentFormat, wdPromptUser - Der Benutzer wird aufgefordert, ein Dokumentformat auszuwählen, wdWordDocument - Microsoft Word-Dokument.

RouteDocument (Boolean) - True, wenn das Dokument an den nächsten Empfänger weitergeleitet werden soll.

Count

Gibt einen Wert vom Typ Long zurück, der die Anzahl der Dokumente in der Auflistung darstellt.

Dim lngCount As Long
lngCount = Documents.Count

Item

Gibt ein einzelnes Document-Objekt in einer Auflistung zurück.

Item (Index)

Index: Ein 1-basierter Index des zurückzugebenden Objekts (Long) oder der Name des Objekts (Zeichenfolge).

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

Open

Öffnet das angegebene Dokument und fügt es der Documents-Auflistung hinzu.

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

Ein benanntes Argument

FileName (String) - Der Name des Dokuments (Pfade werden akzeptiert).

Optional arguments

Die folgenden Argumente sind optional

ConfirmConversions (Boolean) - True, um das Dialogfeld Datei konvertieren anzuzeigen, wenn die Datei nicht im Microsoft Word-Format vorliegt.

ReadOnly (Boolean) - True zum Öffnen des Dokuments im schreibgeschützten Modus.

AddToRecentFiles (Boolean) - True, wenn der Dateiname in die Liste der zuletzt verwendeten Dateien im unteren Teil des Menüs Datei aufgenommen werden soll.

PasswordDocument (String) - Das Kennwort zum Öffnen des Dokuments.

PasswordTemplate (String) - Das Kennwort zum Öffnen der Vorlage.

Revert (Boolean) - Legt fest, wie verfahren wird, wenn FileName der Dateiname eines geöffneten Dokuments ist.

WritePasswordDocument (String) - Das zum Speichern von Änderungen am Dokument erforderliche Kennwort.

WritePasswordTemplate (String) - Das Kennwort zum Speichern von Änderungen an der Vorlage.

Format (FileConverter) - Das zum Öffnen des Dokuments zu verwendende Dateikonvertierungsprogramm.

Encoding - String

Visible (Boolean) - True, wenn das Dokument in einem sichtbaren Fenster geöffnet wird.

OpenAndRepair (Boolean) - True, um das Dokument zu reparieren und so dessen Beschädigung zu vermeiden.

DocumentDirection (WdDocumentDirection) - Bestimmt den horizontalen Textfluss in einem Dokument.

Mögliche Rückgabewerte sind wdLeftToRight - Links nach Rechts, wdRightToLeft - Rechts nach Links.

NoEncodingDialog (Boolean) - True, um die Anzeige des Dialogfelds "Codierung" zu übergehen, das in Word angezeigt wird, wenn die Textcodierung nicht erkannt wird.

XMLTransform - String

OpenNoRepairDialog

Öffnet das angegebene Dokument und fügt es der Documents-Auflistung hinzu.

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

Ein benanntes Argument

FileName (String) - Der Name des Dokuments (Pfade werden akzeptiert).

Optional arguments

Die folgenden Argumente sind optional

ConfirmConversions (Boolean) - True, wenn das Dialogfeld Datei konvertieren angezeigt werden soll, wenn die Datei nicht im Microsoft Word-Format vorliegt.

ReadOnly (Boolean) - True zum Öffnen des Dokuments im schreibgeschützten Modus.

AddToRecentFiles (Boolean) - True, wenn der Dateiname in die Liste der zuletzt verwendeten Dateien im unteren Teil des Menüs Datei aufgenommen werden soll.

PasswordDocument (String) - Das Kennwort zum Öffnen des Dokuments.

PasswordTemplate (String) - Das Kennwort zum Öffnen der Vorlage.

Revert (Boolean) - Legt fest, wie verfahren wird, wenn FileName der Dateiname eines geöffneten Dokuments ist.

WritePasswordDocument (String) - Das zum Speichern von Änderungen am Dokument erforderliche Kennwort.

WritePasswordTemplate (String) - Das Kennwort zum Speichern von Änderungen an der Vorlage.

Format (WdOpenFormat) - Das zum Öffnen des Dokuments zu verwendende Dateikonvertierungsprogramm.


Dies sind mögliche Werte für

WdOpenFormat

Encoding - String

Visible (Boolean) - True, wenn das Dokument in einem sichtbaren Fenster geöffnet wird.

OpenAndRepair (Boolean) - True, um das Dokument zu reparieren und so dessen Beschädigung zu vermeiden.

DocumentDirection (WdDocumentDirection) - Bestimmt den horizontalen Textfluss in einem Dokument.

Mögliche Rückgabewerte sind wdLeftToRight - Links nach Rechts, wdRightToLeft - Rechts nach Links.

NoEncodingDialog (Boolean) - True , um das Anzeigen des Dialogfelds Codierung zu überspringen, das von Word angezeigt wird, wenn die Textcodierung nicht erkannt werden kann.

XMLTransform (String) - Gibt die zu verwendende Transformierung an.

Save

Speichert alle Dokumente in der Documents-Auflistung.

Wenn ein Dokument noch nicht gespeichert wurde, wird der Benutzer im Dialogfeld Speichern unter aufgefordert, einen Dateinamen einzugeben.

Save (NoPrompt, OriginalFormat)

Documents.Save

Arguments

Optional arguments

Die folgenden Argumente sind optional

NoPrompt (Boolean) - True, wenn alle Dokumente automatisch in Word gespeichert werden sollen.

OriginalFormat (WdOriginalFormat) - Gibt an, wie die Dokumente gespeichert werden.

Mögliche Rückgabewerte sind wdOriginalDocumentFormat, wdPromptUser - Der Benutzer wird aufgefordert, ein Dokumentformat auszuwählen, wdWordDocument - Microsoft Word-Dokument.