Workbooks (Sammlung)

<< Click to Display Table of Contents >>

Workbooks (Sammlung)

Zugriffspfad: Application à Workbooks

 1  Beschreibung

Die Sammlung Workbooks enthält alle geöffneten Dokumente. Die einzelnen Elemente dieser Sammlung sind vom Typ Workbook.

 2  Zugriff auf die Sammlung

Es existiert während der gesamten Laufzeit von PlanMaker genau eine Instanz der Workbooks-Sammlung. Diese wird über Application.Workbooks angesprochen:

' Die Anzahl der offenen Dokumente anzeigen

MsgBox pm.Application.Workbooks.Count

 

' Den Namen des ersten geöffneten Dokuments anzeigen

MsgBox pm.Application.Workbooks(1).Name

 3  Eigenschaften, Objekte, Sammlungen und Methoden

Eigenschaften:

Count R/O

 

Objekte:

Item Workbook (Defaultobjekt)

Application Application

Parent Application

 

Methoden:

Add

Open

Close

Count (Eigenschaft, R/O)

Datentyp: Long

Liefert die Anzahl der Workbook-Objekte in der Sammlung, also die Zahl der momentan geöffneten Dokumente.

Item (Zeiger auf Objekt)

Datentyp: Object

Liefert ein einzelnes Workbook-Objekt, also ein einzelnes Dokument.

Welches Workbook-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 pm.Application.Workbooks.Item(1).FullName

 

' Den Namen des Dokuments "Test.pmdx" anzeigen (sofern gerade geöffnet)

MsgBox pm.Application.Workbooks.Item("Test.pmdx").FullName

 

' Sie können auch den kompletten Namen mit Pfadangabe verwenden

MsgBox pm.Application.Workbooks.Item("c:\Dokumente\Test.pmdx").FullName

Application (Zeiger auf Objekt)

Liefert das Application-Objekt.

Parent (Zeiger auf Objekt)

Liefert das übergeordnete Objekt, also Application.

Add (Methode)

Legt ein neues leeres Dokument an, wahlweise basierend auf der Standarddokumentvorlage Normal.pmvx 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.pmvx.
Lassen Sie den Pfad weg oder geben nur einen relativen Pfad an, wird automatisch der Standardvorlagenpfad von PlanMaker vorangestellt. Lassen Sie die Dateierweiterung .pmvx weg, wird sie automatisch angehängt.

Rückgabetyp:

Object (ein Workbook-Objekt, das das neue Dokument repräsentiert)

Beispiel:

Sub Beispiel()

 Dim pm as Object

 Dim newDoc as Object

 

 Set pm = CreateObject("PlanMaker.Application")

 pm.Visible = True

 Set newDoc = pm.Workbooks.Add

 MsgBox newDoc.Name

End Sub

Mit dem von Add zurückgegebenen Document 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 ActiveWorkbook holen.

Open (Methode)

Öffnet ein bestehendes Dokument.

Syntax:

 Open FileName, [ReadOnly], [Format], [Password], [WritePassword], [Delimiter], [TextMarker]

Parameter:

FileName (Typ: String): Pfad und Name 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.
Format (optional; Typ: Long bzw. PmSaveFormat): Dateiformat des zu öffnenden Dokuments. Mögliche Werte:

 pmFormatDocument         =  0 ' PlanMaker-Dokument

 pmFormatTemplate         =  1 ' PlanMaker-Dokumentvorlage

 pmFormatExcel97          =  2 ' Excel 97/2000/XP

 pmFormatExcel5           =  3 ' Excel 5.0/7.0

 pmFormatExcelTemplate    =  4 ' Excel-Dokumentvorlage

 pmFormatSYLK             =  6 ' Sylk

 pmFormatRTF              =  7 ' Rich Text Format

 pmFormatTextMaker        =  7 ' TextMaker (= RTF)

 pmFormatHTML             =  8 ' HTML-Dokument

 pmFormatdBaseDOS         =  9 ' dBASE-Datenbank mit DOS-Zeichensatz

 pmFormatdBaseAnsi        = 10 ' dBASE-Datenbank mit Windows-Zeichensatz

 pmFormatDIF              = 11 ' Textdatei mit Windows-Zeichensatz

 pmFormatPlainTextAnsi    = 12 ' Textdatei mit Windows-Zeichensatz

 pmFormatPlainTextDOS     = 13 ' Textdatei mit DOS-Zeichensatz

 pmFormatPlainTextUnix    = 14 ' Textdatei mit ANSI-Zeichensatz für UNIX, Linux und FreeBSD

 pmFormatPlainTextUnicode = 15 ' Textdatei mit Unicode-Zeichensatz

 pmFormatdBaseUnicode     = 18 ' dBASE-Datenbank mit Unicode-Zeichensatz

 pmFormatPlainTextUTF8    = 21 ' Textdatei mit UTF8-Zeichensatz

 pmFormatMSXML            = 23 ' Excel ab 2007

 pmFormatMSXMLTemplate    = 24 ' Excel-Dokumentvorlage ab 2007

 pmFormatPM2008           = 26 ' PlanMaker 2008-Dokument

 pmFormatPM2010           = 27 ' PlanMaker 2010-Dokument

 pmFormatPM2012           = 28 ' PlanMaker 2012-Dokument

 pmFormatPM2012Template   = 29 ' PlanMaker 2012-Dokumentvorlage

Wenn Sie diesen Parameter weglassen, wird pmFormatDocument angenommen.
Tipp: Unabhängig vom übergebenen Parameter FileFormat versucht PlanMaker stets, das Dateiformat selbst zu erkennen, und ignoriert offensichtlich falsche Angaben.
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.
Delimiter (optional; Typ: String): Gibt bei den Textdatei-Formaten das Trennzeichen an, zum Beispiel Komma oder Strichpunkt. Wenn Sie den Parameter weglassen, wird der Tabulator als Trennzeichen verwendet.
TextMarker (optional; Typ: Long bzw. PmImportTextMarker): Gibt bei den Textdatei-Formaten an, mit welchem Zeichen Textfelder umgeben sind. Mögliche Werte:

 pmImportTextMarkerNone          = 0 ' Text ist nicht speziell markiert

 pmImportTextMarkerApostrophe    = 1 ' Apostrophe

 pmImportTextMarkerQmark         = 2 ' Anführungszeichen

Rückgabetyp:

Object (ein Workbook-Objekt, das das geöffnete Dokument repräsentiert)

Beispiele:

' Ein Dokument öffnen

pm.Workbooks.Open "c:\doks\test.pmdx"

 

' Ein Dokument nur zum Lesen öffnen

pm.Documents.Open "c:\doks\Test.pmdx", 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 für SaveChanges:

 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

pm.Workbooks.Close smoDoNotSaveChanges