<< Click to Display Table of Contents >> Document (Objekt)

Zugriffspfade:

▪Application à Documents à Item

▪Application à ActiveDocument

▪Application à Windows à Item à Document

▪Application à ActiveWindow à Document

 1  Beschreibung

Ein Document-Objekt repräsentiert ein einzelnes in TextMaker geöffnetes Dokument.

Für jedes Dokument existiert ein eigenes Document-Objekt. Öffnen oder schließen Sie Dokumente, werden die zugehörigen Document-Objekte dynamisch angelegt bzw. entfernt.

 2  Zugriff auf das Objekt

Die einzelnen Document-Objekte können auf folgenden Wegen angesprochen werden:

▪Alle geöffneten Dokumente werden in der Sammlung Application.Documents (Typ: Documents) verwaltet:

' Die Namen aller geöffneten Dokumente anzeigen

For i = 1 To tm.Application.Documents.Count

 MsgBox tm.Application.Documents.Item(i).Name

Next i

▪Das aktive Dokument erhalten Sie über Application.ActiveDocument:

' Den Namen des aktuellen Dokuments anzeigen

MsgBox tm.Application.ActiveDocument.Name

▪Document ist der Parent diverser Objekte, die daran angebunden sind, zum Beispiel BuiltInDocumentProperties oder Selection:

' Den Namen des aktuellen Dokuments über einen Umweg anzeigen

MsgBox tm.Application.ActiveDocument.BuiltInDocumentProperties.Parent.Name

▪Die Objekte Window und Selection enthalten Objektzeiger auf das ihnen zugehörige Dokument:

' Über das aktive Dokumentfenster an das aktive Dokument kommen

MsgBox tm.Application.ActiveWindow.Document.Name

 3  Eigenschaften, Objekte, Sammlungen und Methoden

Eigenschaften:

▪Name R/O

▪FullName R/O

▪Path R/O

▪PageCount R/O

▪Saved

▪ReadOnly

▪EnableCaretMovement

▪MergeFileName

▪MergeFileFormat

▪MergeFileHeader

▪MergeRecord

 

Objekte:

▪PageSetup → PageSetup

▪Selection → Selection

▪ActiveWindow → Window

▪Application → Application

▪Parent → Documents

 

Sammlungen:

▪BuiltInDocumentProperties → DocumentProperties

▪Paragraphs → Paragraphs

▪Tables → Tables

▪FormFields → FormFields

 

Methoden:

▪Activate

▪Close

▪Save

▪SaveAs

▪Select

▪MailMerge

▪PrintOut

▪MergePrintOut

Name (Eigenschaft, R/O)

Datentyp: String

Liefert den Namen des Dokuments (z.B. "Müller.tmdx").

FullName (Eigenschaft, R/O)

Datentyp: String

Liefert den Pfad und Namen des Dokuments (z.B. "c:\Briefe\Müller.tmdx").

Path (Eigenschaft, R/O)

Datentyp: String

Liefert den Pfad des Dokuments (z.B. "c:\Briefe").

PageCount (Eigenschaft, R/O)

Datentyp: Long

Liefert die Anzahl der Seiten im Dokument.

Saved (Eigenschaft)

Datentyp: Boolean

Liest oder setzt die Saved-Eigenschaft des Dokuments. Diese bezeichnet, ob ein Dokument nach seiner letzten Speicherung verändert wurde:

▪Wenn Saved auf True steht, wurde das Dokument seit dem letzten Speichern nicht mehr verändert.

▪Wenn Saved auf False steht, wurde das Dokument seit dem letzten Speichern verändert. Der Anwender wird beim Schließen des Dokuments gefragt, ob es gespeichert werden soll.

Hinweis: Sobald der Anwender an einem Dokument etwas ändert, wird Saved auf False gesetzt.

ReadOnly (Eigenschaft)

Datentyp: Boolean

Liest oder setzt die ReadOnly-Eigenschaft des Dokuments.

Wenn diese Eigenschaft True ist, ist das Dokument gegen Änderungen durch den Benutzer geschützt. Er kann dann nichts mehr editieren, löschen oder einfügen.

Setzen Sie diese Eigenschaft auf True, wird automatisch die Eigenschaft EnableCaretMovement (siehe dort) auf False gesetzt. Dadurch kann dann im Dokument die Schreibmarke nicht mehr versetzt werden. Sie können aber EnableCaretMovement auch wieder auf True setzen, sodass dieses wieder möglich ist.

EnableCaretMovement (Eigenschaft)

Datentyp: Boolean

Liest oder setzt die EnableCaretMovement-Eigenschaft des Dokuments. Diese Eigenschaft ist nur sinnvoll in Kombination mit der ReadOnly-Eigenschaft (siehe dort).

Wenn EnableCaretMovement True ist, kann die Schreibmarke im (schreibgeschützten) Dokument frei bewegt werden. Wird die Eigenschaft auf False gesetzt, ist das Versetzen der Schreibmarke nicht mehr möglich.

MergeFileName (Eigenschaft)

Datentyp: String

Liest oder setzt den Namen der Serienbriefdatenbank, die dem Dokument zugeordnet ist.

MergeFileFormat (Eigenschaft)

Datentyp: Long (TmMergeType)

Liest oder setzt das Dateiformat der Serienbriefdatenbank, die dem Dokument zugeordnet ist. Mögliche Werte:

tmMergeCSVAnsi        =  3

tmMergeDBaseAnsi      =  5

tmMergeCSVDos         = 64

tmMergeDBaseDos       = 66

tmMergeDBaseUnicode   = 69

MergeFileHeader (Eigenschaft)

Datentyp: Boolean

Liest oder setzt die Option Feldnamen aus dem 1. Datensatz holen. (Bei TextMaker finden Sie diese Option im Dialogfenster des Ribbonbefehls Sendungen | Gruppe Empfänger | Datenbank auswählen | Vorhandene Datenbank verwenden.)

Diese Eigenschaft ist nur sinnvoll einsetzbar bei CSV-Dateien (tmMergeCSVAnsi, tmMergeCSVDos).

MergeRecord (Eigenschaft)

Datentyp: Long

Liest oder setzt bei einem Serienbriefdokument die Nummer des angezeigten Datensatzes. Entspricht der Einstellung Datensatz anzeigen auf der Karteikarte Ansicht im Dialogfenster des Ribbonbefehls Datei | Eigenschaften.

PageSetup (Zeiger auf Objekt)

Datentyp: Object

Liefert das PageSetup-Objekt, das Sie auf die Seitenformatierung (Papierformat, Ränder etc.) des Dokuments zugreifen lässt.

Selection (Zeiger auf Objekt)

Datentyp: Object

Liefert das Selection-Objekt, das Sie auf den gerade selektierten (markierten) Text des Dokuments zugreifen lässt. Wenn nichts markiert ist, liefert das Objekt die aktuelle Schreibmarke.

ActiveWindow (Zeiger auf Objekt)

Datentyp: Object

Liefert das Window-Objekt, das die Fenstereinstellungen (zum Beispiel Höhe und Breite auf dem Bildschirm) des Dokuments enthält.

Application (Zeiger auf Objekt)

Datentyp: Object

Liefert das Application-Objekt.

Parent (Zeiger auf Objekt)

Datentyp: Object

Liefert das übergeordnete Objekt, also Documents.

BuiltInDocumentProperties (Zeiger auf Sammlung)

Datentyp: Object

Liefert die DocumentProperties-Sammlung, die Sie auf die Dokumentinfos (Titel, Thema, Autor etc.) des Dokuments zugreifen lässt.

Paragraphs (Zeiger auf Sammlung)

Datentyp: Object

Liefert die Paragraphs-Sammlung, eine Sammlung aller Absätze des Dokuments.

Tables (Zeiger auf Sammlung)

Datentyp: Object

Liefert die Tables-Sammlung, eine Sammlung aller Tabellen des Dokuments.

FormFields (Zeiger auf Sammlung)

Datentyp: Object

Liefert die FormFields-Sammlung, eine Sammlung aller Formularobjekte des Dokuments.

Activate (Methode)

Bringt das Dokumentfenster in den Vordergrund (sofern Visible für das Dokument True ist) und setzt den Fokus auf das Dokumentfenster.

Syntax:

 Activate

Parameter:

Rückgabetyp:

Beispiel:

' Das erste Dokument der Documents-Sammlung in den Vordergrund bringen

tm.Documents(1).Activate

Close (Methode)

Schließt das Dokument.

Syntax:

 Close [SaveChanges]

Parameter:

 smoDoNotSaveChanges = 0      ' Nicht fragen, nicht speichern

 smoPromptToSaveChanges = 1   ' Den Benutzer fragen

 smoSaveChanges = 2           ' Ohne Rückfrage speichern

Rückgabetyp:

Beispiel:

' Das aktive Dokument schließen, ohne es zu speichern

tm.ActiveDocument.Close smoDoNotSaveChanges

Save (Methode)

Speichert das Dokument.

Syntax:

 Save

Parameter:

Rückgabetyp:

Beispiel:

' Das aktive Dokument speichern

tm.ActiveDocument.Save

SaveAs (Methode)

Speichert das Dokument unter einem anderen Namen und/oder in einem anderen Pfad.

Syntax:

 SaveAs FileName, [FileFormat]

Parameter:

 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

Rückgabetyp:

Beispiel:

' Das aktuelle Dokument unter dem angegebenen Namen im RTF-Format speichern

tm.ActiveDocument.SaveAs "c:\doks\test.rtf", tmFormatRTF

Select (Methode)

Selektiert (markiert) das gesamte Dokument.

Syntax:

 Select

Parameter:

Rückgabetyp:

Beispiel:

' Das aktuelle Dokument selektieren

tm.ActiveDocument.Select

Sie können dann über das Selection-Objekt beispielsweise die Textformatierung ändern oder den markierten Text in die Zwischenablage übertragen.

PrintOut (Methode)

Druckt das Dokument auf dem aktuell gewählten Drucker aus.

Syntax:

 PrintOut [From], [To]

Parameter:

Rückgabetyp:

Beispiel:

' Seiten 2-5 des aktuellen Dokuments ausdrucken

tm.ActiveDocument.PrintOut 2, 5

MailMerge (Methode)

Überträgt aus der einem Dokument zugeordneten Datenbank die Datenfelder des mithilfe des Ribbonbefehls Datei | Eigenschaften eingestellten Datensatzes in das Dokument.

Syntax:

 MailMerge Options, [ReplaceFields]

Parameter:

 tmSingleFax       = 1

 tmSingleAddress   = 2

 tmMultipleFax     = 3

 tmMultipleAddress = 4

Rückgabetyp:

Beispiel:

' In das Dokument den Datensatz 5 aus der zugeordneten Datenbank einfügen

tm.ActiveDocument.MergeRecord = 5

tm.ActiveDocument.MailMerge tmSingleAddress, True

MergePrintOut (Methode)

Druckt das Dokument auf dem aktuell gewählten Drucker als Serienbrief aus.

Syntax:

 MergePrintOut [From], [To]

Parameter:

Rückgabetyp:

Beispiel:

' Das aktuelle Serienbriefdokument mit Datensätzen 99-105 drucken

tm.ActiveDocument.MergePrintOut 99, 105