|
<< Click to Display Table of Contents >> Documents (Sammlung) |
Zugriffspfad: Application à Documents
1 Beschreibung
Die Sammlung Documents enthält alle geöffneten Dokumente. Die einzelnen Elemente dieser Sammlung sind vom Typ Document.
2 Zugriff auf die Sammlung
Es existiert während der gesamten Laufzeit von TextMaker genau eine Instanz der Documents-Sammlung. Diese wird über Application.Documents angesprochen:
' Die Anzahl der offenen Dokumente anzeigen
MsgBox tm.Application.Documents.Count
' Den Namen des ersten geöffneten Dokuments anzeigen
MsgBox tm.Application.Documents(1).Name
3 Eigenschaften, Objekte, Sammlungen und Methoden
Eigenschaften:
▪Count R/O
Objekte:
▪Item → Document (Defaultobjekt)
▪Application → Application
▪Parent → Application
Methoden:
▪Add
▪Open
▪Close
Count (Eigenschaft, R/O)
Datentyp: Long
Liefert die Anzahl der Document-Objekte in der Sammlung, also die Zahl der momentan geöffneten Dokumente.
Item (Zeiger auf Objekt)
Datentyp: Object
Liefert ein einzelnes Document-Objekt, also ein einzelnes geöffnetes Dokument.
Welches Document-Objekt Sie erhalten, hängt von dem Parameter ab, den Sie an Item übergeben. Dies kann entweder der numerische Index oder der Dateiname des gewünschten Dokuments sein. Beispiele:
' Den Namen des ersten Dokuments anzeigen
MsgBox tm.Application.Documents.Item(1).FullName
' Den Namen des Dokuments "Test.tmdx" anzeigen (sofern gerade geöffnet)
MsgBox tm.Application.Documents.Item("Test.tmdx").FullName
' Sie können auch den kompletten Pfad angeben
MsgBox tm.Application.Documents.Item("c:\Dokumente\Test.tmdx").FullName
Application (Zeiger auf Objekt)
Datentyp: Object
Liefert das Application-Objekt.
Parent (Zeiger auf Objekt)
Datentyp: Object
Liefert das übergeordnete Objekt, also Application.
Add (Methode)
Legt ein neues leeres Dokument an, wahlweise basierend auf der Standarddokumentvorlage Normal.tmvx oder einer anderen von Ihnen gewählten Dokumentvorlage.
Syntax:
Add [Template]
Parameter:
| Template (optional; Typ: String): Der Pfad und Dateiname der Dokumentvorlage, auf der das Dokument basieren soll. Wird dieser Parameter nicht angegeben, basiert das Dokument auf der Standardvorlage Normal.tmvx. |
| Lassen Sie den Pfad weg oder geben nur einen relativen Pfad an, wird automatisch der Standardvorlagenpfad von TextMaker vorangestellt. Lassen Sie die Dateierweiterung .tmvx weg, wird sie automatisch angehängt. |
Rückgabetyp:
| Object (ein Document-Objekt, das das neue Dokument repräsentiert) |
Beispiel:
Sub Beispiel()
Dim tm as Object
Dim newDoc as Object
Set tm = CreateObject("TextMaker.Application")
tm.Visible = True
Set newDoc = tm.Documents.Add
MsgBox newDoc.Name
End Sub
Mit dem von Add zurückgegebenen Document-Objekt können Sie arbeiten wie mit jedem anderen Dokument. Sie können aber auch den Rückgabewert von Add ignorieren und sich das neue Dokument über ActiveDocument holen.
Open (Methode)
Öffnet ein bestehendes Dokument.
Syntax:
Open FileName, [ReadOnly], [Password], [WritePassword], [Format]
Parameter:
| FileName (Typ: String): Pfad und Dateiname des zu öffnenden Dokuments beziehungsweise der zu öffnenden Dokumentvorlage |
| ReadOnly (optional; Typ: Boolean): Gibt an, ob das Dokument nur zum Lesen geöffnet werden soll. |
| Password (optional; Typ: String): Gibt bei kennwortgeschützten Dokumenten das Lesekennwort an. Lassen Sie diesen Parameter bei einem kennwortgeschützten Dokument weg, wird der Benutzer nach dem Lesekennwort gefragt. |
| WritePassword (optional; Typ: String): Gibt bei kennwortgeschützten Dokumenten das Schreibkennwort an. Lassen Sie diesen Parameter bei einem kennwortgeschützten Dokument weg, wird der Benutzer nach dem Schreibkennwort gefragt. |
| Format (optional; Typ: Long bzw. TmSaveFormat): Dateiformat des zu öffnenden Dokuments. Mögliche Werte: |
tmFormatDocument = 0 ' TextMaker-Dokument
tmFormatTemplate = 1 ' TextMaker-Dokumentvorlage
tmFormatWinWord97 = 2 ' Microsoft Word 97 und 2000
tmFormatOpenDocument = 3 ' OpenDocument, OpenOffice.org, StarOffice
tmFormatRTF = 4 ' Rich Text Format
tmFormatPocketWordPPC = 5 ' Pocket Word für Pocket PCs
tmFormatPocketWordHPC = 6 ' Pocket Word für Handheld PCs (Windows CE)
tmFormatPlainTextAnsi = 7 ' Textdatei mit Windows-Zeichensatz (ANSI)
tmFormatPlainTextDOS = 8 ' Textdatei mit DOS-Zeichensatz
tmFormatPlainTextUnicode = 9 ' Textdatei mit Unicode-Zeichensatz
tmFormatPlainTextUTF8 = 10 ' Textdatei mit UTF8-Zeichensatz
tmFormatHTML = 12 ' HTML-Dokument
tmFormatWinWord6 = 13 ' Microsoft Word 6.0
tmFormatPlainTextUnix = 14 ' Textdatei für UNIX, Linux, FreeBSD
tmFormatWinWordXP = 15 ' Microsoft Word XP und 2003
tmFormatTM2006 = 16 ' TextMaker 2006-Dokument
tmFormatOpenXML = 17 ' Microsoft Word ab 2007
tmFormatTM2008 = 18 ' TextMaker 2008-Dokument
tmFormatOpenXMLTemplate = 22 ' Microsoft Word Dokumentvorlage ab 2007
tmFormatWinWordXPTemplate = 23 ' Microsoft Word Dokumentvorlage XP und 2003
tmFormatTM2012 = 27 ' TextMaker 2012-Dokument
tmFormatTM2016 = 28 ' TextMaker 2016-Dokument
tmFormatTM2016Template = 29 ' TextMaker 2016-Dokumentvorlage
| Wenn Sie diesen Parameter weglassen, wird tmFormatDocument angenommen. |
| Tipp: Unabhängig vom übergebenen Parameter FileFormat versucht TextMaker stets, das Dateiformat selbst zu erkennen, und ignoriert offensichtlich falsche Angaben. |
Rückgabetyp:
| Object (ein Document-Objekt, das das geöffnete Dokument repräsentiert) |
Beispiele:
' Ein Dokument öffnen
tm.Documents.Open "c:\doks\test.tmdx"
' Ein Dokument nur zum Lesen öffnen
tm.Documents.Open "c:\doks\Test.tmdx", True
Close (Methode)
Schließt alle momentan geöffneten Dokumente.
Syntax:
Close [SaveChanges]
Parameter:
| SaveChanges (optional; Typ: Long bzw. SmoSaveOptions) gibt an, ob die seit dem letzten Speichern veränderten Dokumente gespeichert werden sollen oder nicht. Lassen Sie den Parameter weg, wird stattdessen gegebenenfalls der Benutzer gefragt. Mögliche Werte: |
smoDoNotSaveChanges = 0 ' Nicht fragen, nicht speichern
smoPromptToSaveChanges = 1 ' Den Benutzer fragen
smoSaveChanges = 2 ' Ohne Rückfrage speichern
Rückgabetyp:
| keiner |
Beispiel:
' Alle offenen Dokumente schließen, ohne sie zu speichern
tm.Documents.Close smoDoNotSaveChanges