SolidWorksMakroprogrammierung

Objekt · SldWorks

CustomPropertyManager-Objekt

Liest, schreibt und löscht die Dateieigenschaften eines Dokuments, für die ganze Datei oder für eine einzelne Konfiguration.

Deklaration Dim x As SldWorks.CustomPropertyManager · in der englischen .NET-Hilfe: ICustomPropertyManager

Beschreibung

Die Dateieigenschaften aus Datei › Eigenschaften stehen an zwei Stellen: auf der Registerkarte „Benutzerdefiniert“ für die ganze Datei und auf der Registerkarte „Konfigurationsspezifisch“ für jede Konfiguration einzeln. Für jede dieser Stellen gibt es einen eigenen CustomPropertyManager.

Zugriff

Beispiel

' Schreibt "Benennung" in die Dateieigenschaften und "Länge" in die
' Eigenschaften der aktiven Konfiguration.
' Vorbedingung: Ein Teil ist geöffnet.
' Ergebnis:     Beide Eigenschaften stehen unter Datei › Eigenschaften.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swDatei As SldWorks.CustomPropertyManager
    Dim swKonf As SldWorks.CustomPropertyManager
    Dim sKonfig As String

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    If swModel.GetType <> swDocPART Then Exit Sub

    Set swDatei = swModel.Extension.CustomPropertyManager("")
    swDatei.Add3 "Benennung", swCustomInfoText, "Welle", swCustomPropertyReplaceValue

    sKonfig = swModel.ConfigurationManager.ActiveConfiguration.Name
    Set swKonf = swModel.Extension.CustomPropertyManager(sKonfig)
    swKonf.Add3 "Länge", swCustomInfoText, "250 mm", swCustomPropertyReplaceValue

    swModel.SetSaveFlag
End Sub

Bemerkungen

Welche der beiden Stellen eine Zeichnung, ein Schriftfeld oder eine Stückliste anzeigt, hängt von deren Einstellungen ab. Ein Makro muss wissen, wo eine Eigenschaft steht, sonst liest es ins Leere oder schreibt an die falsche Stelle.

Die Befehle liefern fast alle einen Ergebniscode zurück, etwa „Eigenschaft gibt es nicht“ oder „Typ passt nicht“. Werte ihn aus, wenn das Makro sich auf das Ergebnis verlassen muss.

Ältere Makros benutzen oft die Befehle direkt auf ModelDoc2, etwa AddCustomInfo3 oder CustomInfo2. Diese sind veraltet. Ebenso die älteren Fassungen hier, etwa Add2, Get5 oder Set.

Eigenschaften und Methoden

Eigenschaften 3, davon 3 beschrieben

NameBeschreibung
CountLiefert die Anzahl der Dateieigenschaften.
LinkAllVerknüpft alle Eigenschaften mit dem übergeordneten Teil oder löst die Verknüpfung.
OwnerLiefert, wem die Eigenschaften gehören: einem Körper oder einem Feature.

Methoden 21, davon 9 beschrieben, 12 veraltet

NameBeschreibung
Addveraltet ersetzt durch CustomPropertyManager.Add3
Add2veraltet ersetzt durch CustomPropertyManager.Add3
Add3Legt eine Dateieigenschaft an, oder überschreibt eine vorhandene, je nach Option.
Deleteveraltet ersetzt durch CustomPropertyManager.Delete2
Delete2Löscht eine Dateieigenschaft.
Getveraltet ersetzt durch CustomPropertyManager.Get6
Get2veraltet ersetzt durch CustomPropertyManager.Get6
Get3veraltet ersetzt durch CustomPropertyManager.Get6
Get4veraltet ersetzt durch CustomPropertyManager.Get6
Get5veraltet ersetzt durch CustomPropertyManager.Get6
Get6Liest eine Dateieigenschaft: den eingetragenen Text und den ausgewerteten Wert, etwa bei Verknüpfungen auf die Masse.
GetAllveraltet ersetzt durch CustomPropertyManager.GetAll3
GetAll2veraltet ersetzt durch CustomPropertyManager.GetAll3
GetAll3Liefert alle Dateieigenschaften in einem Aufruf: Namen, Typen, ausgewertete Werte und mehr, jeweils als Array.
GetNamesLiefert die Namen aller Dateieigenschaften als Array, oder Empty, wenn es keine gibt.
GetTypeveraltet ersetzt durch CustomPropertyManager.GetType2
GetType2Liefert den Typ einer Dateieigenschaft: Text, Datum, Zahl, Ja/Nein und so weiter.
IsCustomPropertyEditableLiefert, ob eine Eigenschaft in einer Konfiguration geändert werden kann.
LinkPropertyVerknüpft eine Eigenschaft mit dem übergeordneten Teil oder löst die Verknüpfung.
Setveraltet ersetzt durch CustomPropertyManager.Set2
Set2Ändert den Wert einer vorhandenen Dateieigenschaft.

Nicht aufgeführt sind 2 C++-Varianten (Namen mit I davor, zum Beispiel IGetAll). In VBA nimmst du immer den Befehl ohne I.

Siehe auch

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

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