SolidWorksMakroprogrammierung

Objekt · SldWorks

UserProgressBar-Objekt

Eine eigene Fortschrittsanzeige in der Statusleiste von SOLIDWORKS: starten, weiterzählen, Titel ändern, beenden.

Deklaration Dim x As SldWorks.UserProgressBar · in der englischen .NET-Hilfe: IUserProgressBar

Beschreibung

UserProgressBar gibt Zugriff auf eine Fortschrittsanzeige, die zeigt, wie lange ein Vorgang noch dauert. Sie erscheint in der Statusleiste von SOLIDWORKS. Ein Makro oder Add-in kann damit den Fortschritt eigener, langer Abläufe anzeigen. Drückt der Benutzer Esc, meldet das UserProgressBar.UpdateProgress. Die Befehle gibt es seit SOLIDWORKS 2007.

Zugriff

Beispiel

' Geht alle offenen Dokumente durch, zeigt dabei den Fortschritt in der Statusleiste
' und bricht ab, wenn der Benutzer Esc drückt.
' Vorbedingung: Mindestens ein Dokument ist offen.
' Ergebnis:     Die Namen stehen im Direktfenster, die Anzeige verschwindet am Ende.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swFortschritt As SldWorks.UserProgressBar
    Dim vDokumente As Variant
    Dim swModel As SldWorks.ModelDoc2
    Dim i As Long

    Set swApp = Application.SldWorks
    If False = swApp.GetUserProgressBar(swFortschritt) Then Exit Sub
    vDokumente = swApp.GetDocuments
    If Not IsArray(vDokumente) Then Exit Sub

    swFortschritt.Start 0, UBound(vDokumente) + 1, "Dokumente prüfen"
    For i = 0 To UBound(vDokumente)
        Set swModel = vDokumente(i)
        swFortschritt.UpdateTitle "Prüfe " & swModel.GetTitle
        Debug.Print swModel.GetPathName
        If swFortschritt.UpdateProgress(i + 1) = swUpdateProgressError_UserCancel Then
            Debug.Print "Abgebrochen mit Esc"
            Exit For
        End If
    Next i
    swFortschritt.End
End Sub

Bemerkungen

Hilfebeispiel: Das Beispiel „Start, Update, and Stop Progress Indicator“ steuert die Anzeige aus einem UserForm mit Knöpfen: Start mit dem Bereich 0 bis 160, Weiterzählen in Zehnerschritten, neuer Titel aus einem Textfeld und Stopp. Bricht der Benutzer mit Esc ab, liefert UpdateProgress den Wert 2 (swUpdateProgressError_UserCancel), und das Beispiel ruft End auf.

Entfernen: UserProgressBar.End entfernt die Anzeige nicht sofort. Windows verarbeitet erst eine Fenstermeldung, danach verschwindet die Anzeige aus der Statusleiste.

Eigenschaften und Methoden

Methoden 4, davon 4 beschrieben

NameBeschreibung
EndEntfernt die Fortschrittsanzeige aus der Statusleiste.
StartLegt Bereich und Titel der Fortschrittsanzeige fest und blendet sie in der Statusleiste ein.
UpdateProgressSetzt den Stand der Fortschrittsanzeige und meldet, ob der Benutzer mit Esc abgebrochen hat.
UpdateTitleÄndert den Titel der Fortschrittsanzeige.

Siehe auch

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

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