SolidWorksMakroprogrammierung

Objekt · SldWorks

EnumDocuments2-Objekt

Eine Aufzählung aller offenen Dokumente (ModelDoc2), auch der nur als Referenz geladenen, die du mit Next Dokument für Dokument durchgehst.

Deklaration Dim x As SldWorks.EnumDocuments2 · in der englischen .NET-Hilfe: IEnumDocuments2

Beschreibung

EnumDocuments2 gibt Zugriff auf eine Aufzählung von Dokumenten (ModelDoc2). Eine Aufzählung gibt dir die Elemente nicht als Array, sondern eins nach dem anderen. Die Befehle gibt es seit SOLIDWORKS 2001Plus.

EnumDocuments2 ist nur für In-Process-DLLs gedacht. In VBA-Makros nimmst du meist besser SldWorks.GetDocuments, das gleich ein Array liefert, oder die Schleife mit SldWorks.GetFirstDocument.

Alle Dokumente holen: Du rufst EnumDocuments2.Next in einer Schleife mit 1 auf. Vor jedem Aufruf setzt du die Variable für das Element auf Nothing. Ist sie danach noch Nothing, ist die Aufzählung zu Ende. Mit EnumDocuments2.Reset fängst du wieder von vorn an.

Zugriff

Beispiel

' Gibt alle offenen Dokumente aus und ob sie ein eigenes Fenster haben.
' Vorbedingung: SOLIDWORKS läuft, Dokumente sind offen.
' Ergebnis:     Titel und Sichtbarkeit stehen im Direktfenster.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swEnum As SldWorks.EnumDocuments2
    Dim swModel As SldWorks.ModelDoc2
    Dim nGeholt As Long

    Set swApp = Application.SldWorks
    Set swEnum = swApp.EnumDocuments2
    If swEnum Is Nothing Then Exit Sub
    swEnum.Reset

    Do
        Set swModel = Nothing
        swEnum.Next 1, swModel, nGeholt
        If swModel Is Nothing Then Exit Do
        Debug.Print swModel.GetTitle & ": " & IIf(swModel.Visible, "sichtbar", "nur geladen")
    Loop
End Sub

Bemerkungen

Next in VBA: Next gibt in Rgelt ein Array mit Celt Elementen zurück. Die VBA-Syntax deklariert Rgelt aber als einzelnes ModelDoc2, deshalb holst du vermutlich immer genau 1 Element. PceltFetched ist kleiner als Celt, wenn weniger Dokumente übrig sind, oder NULL, wenn keine mehr da sind. Welchen Wert die Variable dann in VBA hat, sagt die Hilfe nicht. Die Schleife prüft deshalb das Element selbst.

Rückgabe: In VBA sind alle vier Befehle Funktionen mit einem HResult. Was der Wert bedeutet, sagt die Hilfe nicht. Du rufst sie ohne Klammern auf und lässt den Wert weg.

Auch Referenzen: Die Aufzählung enthält alle offenen Dokumente, auch die, die nur als Referenz einer Baugruppe oder Zeichnung geladen sind. Ob ein Dokument ein eigenes Fenster hat und sichtbar ist, prüfst du mit ModelDoc2.Visible.

Hilfebeispiele: „Get List of Open Documents (C++)“ und „Traverse All Open Documents (C++)“ gehen die Dokumente so durch. Das erste ruft vorher EnumDocuments2.Reset auf und setzt die Variable vor jedem Next zurück, wie das Beispiel oben.

Eigenschaften und Methoden

Methoden 4, davon 4 beschrieben

NameBeschreibung
CloneErstellt eine Kopie der Aufzählung der Dokumente.
NextHolt das nächste Dokument aus der Aufzählung.
ResetSetzt die Aufzählung an den Anfang zurück, sodass Next wieder das erste Dokument liefert.
SkipÜberspringt die angegebene Zahl von Dokumenten in der Aufzählung.

Siehe auch

Englisches Original: IEnumDocuments2 in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)

Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.