Objekt · SldWorks
RenamedDocumentReferences-Objekt
Der Dialog zum Umbenennen von Dokumenten als Objekt: nicht geöffnete Dokumente suchen, die eine umbenannte Datei referenzieren, und ihre Referenzen aktualisieren.
Beschreibung
Mit RenamedDocumentReferences aktualisierst du die Referenzen auf eine umbenannte Datei in Dokumenten, die nicht geöffnet sind. Das Objekt entspricht dem Dialog „Dokumente umbenennen“ (Rename Documents) der Oberfläche. Du bekommst es im Ereignis RenamedDocumentNotify, wenn du ein Dokument speicherst, in dem du eine Komponente mit ModelDocExtension.RenameDocument umbenannt hast. Die Befehle gibt es seit SOLIDWORKS 2016.
Zugriff
AssemblyDoc.RenamedDocumentNotify: das Ereignis übergibt das Objekt als Parameter- Auch das Ereignis RenamedDocumentNotify von PartDoc
Beispiel
' Benennt die ausgewählte Komponente um und speichert die Baugruppe. Beim Speichern
' kommt das Ereignis RenamedDocumentNotify, das Klassenmodul behandelt es.
' Vorbedingung: Eine Baugruppe ist offen, eine Komponente ist ausgewählt. Im Makro
' gibt es das Klassenmodul Klasse1 (Code darunter).
' Ergebnis: Die Komponente heißt "NeuerName", die Baugruppe ist gespeichert, die
' gefundenen Referenzen stehen im Direktfenster.
Option Explicit
Dim oEreignisse As Klasse1 ' auf Modulebene, damit es bestehen bleibt
Sub main()
Dim swApp As SldWorks.SldWorks
Dim swModel As SldWorks.ModelDoc2
Dim nFehler As Long, nWarnungen As Long
Set swApp = Application.SldWorks
Set swModel = swApp.ActiveDoc
If swModel Is Nothing Then Exit Sub
If swModel.GetType <> swDocASSEMBLY Then Exit Sub
Set oEreignisse = New Klasse1
Set oEreignisse.swAssy = swModel
nFehler = swModel.Extension.RenameDocument("NeuerName") ' swRenameDocumentError_e
If nFehler <> swRenameDocumentError_None Then Exit Sub
swModel.Extension.Rebuild swRebuildAll
swModel.Save3 swSaveAsOptions_Silent + swSaveAsOptions_SaveReferenced, nFehler, nWarnungen
End SubOption Explicit
Public WithEvents swAssy As SldWorks.AssemblyDoc
Private Function swAssy_RenamedDocumentNotify(ByRef swObj As Object) As Long
Dim swRefs As SldWorks.RenamedDocumentReferences
Dim vListe As Variant
Dim i As Long
Set swRefs = swObj
swRefs.UpdateWhereUsedReferences = True
swRefs.IncludeFileLocations = True
vListe = swRefs.GetSearchPath
If IsArray(vListe) Then
For i = 0 To UBound(vListe)
Debug.Print "Suchordner: " & vListe(i)
Next i
End If
swRefs.Search
vListe = swRefs.ReferencesArray
If IsArray(vListe) Then
For i = 0 To UBound(vListe)
Debug.Print "Referenz: " & vListe(i)
Next i
End If
swRefs.CompletionAction = swRenamedDocumentFinalAction_Ok
End FunctionBemerkungen
Ablauf: Setze RenamedDocumentReferences.UpdateWhereUsedReferences auf True, lege mit RenamedDocumentReferences.IncludeFileLocations, RenamedDocumentReferences.AddSearchFolder und RenamedDocumentReferences.RemoveSearchFolder die Suchordner fest, suche mit RenamedDocumentReferences.Search und lies die Funde mit RenamedDocumentReferences.ReferencesArray. Dokumente, deren Referenzen bleiben sollen, nimmst du mit RenamedDocumentReferences.RemoveReference heraus. Zum Schluss setzt du RenamedDocumentReferences.CompletionAction auf swRenamedDocumentFinalAction_Ok.
Vorbild: Das Beispiel folgt dem Hilfebeispiel „Rename Component and Update References“. Dort heißt die Komponente center-1 aus dem Tutorial „claw-mechanism“ und wird mit ModelDoc2.Save3 gespeichert.
Dateien: Die Hilfe sagt nicht, wann die Referenzen in den gefundenen Dokumenten tatsächlich geändert werden, beim Abschluss mit swRenamedDocumentFinalAction_Ok: Im Test verwies die zweite Baugruppe nach dem Speichern nur dann auf die umbenannte Datei.
Eigenschaften und Methoden
Eigenschaften 3, davon 3 beschrieben
| Name | Beschreibung |
|---|---|
| CompletionAction | Liest oder setzt, wie der Dialog zum Umbenennen abgeschlossen wird, also ob die Referenzen in nicht geöffneten Dokumenten aktualisiert werden. |
| IncludeFileLocations | Liest oder setzt, ob auch in den Ordnern gesucht wird, die in den Systemoptionen unter Dateipfade für referenzierte Dokumente stehen. |
| UpdateWhereUsedReferences | Liest oder setzt, ob die Referenzen auf den neuen Dateinamen umgestellt werden. |
Methoden 6, davon 6 beschrieben
| Name | Beschreibung |
|---|---|
| AddSearchFolder | Fügt einen Ordner hinzu, in dem nach Dokumenten mit Referenzen auf die umbenannte Datei gesucht wird. |
| GetSearchPath | Liefert die Ordner, in denen gesucht wird. |
| ReferencesArray | Liefert die Pfade der Dokumente, die die umbenannte Datei referenzieren. |
| RemoveReference | Nimmt ein Dokument aus der Liste der Referenzen, die aktualisiert werden. |
| RemoveSearchFolder | Nimmt einen Ordner aus der Suche nach Dokumenten mit Referenzen auf die umbenannte Datei. |
| Search | Sucht die Dokumente, deren Referenzen auf die umbenannte Datei aktualisiert werden sollen. |
Siehe auch
Englisches Original: IRenamedDocumentReferences in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)
Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.