Scripting

Mit Hilfe des Scripting Moduls kann speedyPDM ereignisorientiert angepasst werden.
Um das Scripting Modul nutzen zu können muss die Programmbibliothek modScript7.dll im speedy/Admin unter Anwendungsmodule hinzugefügt werden.
Sie haben die Wahl die Ereignisbehandlungsroutinen entweder in VBScript oder JScript zu schreiben. Die Ereignisbehandlungsroutinen werden in einer Textdatei definiert. Das Scripting-Modul lädt die Script-Datei „speedy.vbs“ bzw. „speedy.js“ aus dem Unterverzeichnis „.\script“. Desweiteren werden aus dem selben Ordner noch die Script-Dateien „document.*“,„container.*“,„swxSpeedy.*“ und „aisSpeedy.*“ aufgerufen. Beispielcodes befinden sich im Verzeichnis .\script\example\.

Script-DateiBemerkung
speedy.* Hier werden allgemeine Funktionen des Speedy Explorers aufgerufen
document.* Wird beim Neu-Dialog und beim Eigenschaften-Dialog des Dokuments aufgerufen
container.* Wird beim Neu-Dialog und beim Eigenschaften-Dialog des Containers aufgerufen
swxSpeedy.* Wird bei Aktionen innerhalb von Solidworks aufgerufen
aisSpeedy.* Wird bei Aktionen innerhalb von Autodesk Inventor aufgerufen

Ereignisroutinen

Die Ereignisroutinen haben, wenn nicht anders beschrieben, immer die gleichen Aufrufparameter.

Event_Function_Name(timing, handling, dictionary)
Parameter Type Description
timing EventTimingEnum Gibt den Zeitpunkt des Ereignisses an.
handling HandlingCodeEnum Rückgabewert, ob die Ereignisroutine das Ereignis behandelt hat und damit evtl. keine weitere Arbeit durch das System zu erfolgen hat.
dictionary Dictionary - Object Scripting.Dictionary aus der Scripting Runtime Library. Der Ihalt des Dictionaries kann variieren.


Konstanten

Der Parameter timing gibt an zu welcher Zeit das Ereignis ausgeführt wird.

' enum EventTimingEnum; Parameter := timing
Const kUpdateUI  = 0
Const kBefore    = 1
Const kAfter     = 2
Const kAbort     = 3
Const kFailed    = 4

Der Parameter handling gibt eine Information wie das Ereignis behandelt wurde zurück. Standart-Wert = 1

' enum HandlingCodeEnum; Parameter := handling
Const kEventHandled    = 0
Const kEventNotHandled = 1
Const kEventCanceled   = 2


Allgemeine Eigenschaften des Dictionary Objekts

Eigenschaft Beschreibung
event.function Name der Ereignisfunktion
event.timing Zeitpunkt der Ereignisfunktion (siehe EventTimingEnum)
session.database ADO-Datenbankobjekt der Session Datenbank
session.user Aktueller Speedy User
session.apptype Applikationstyp:
1 := Service-Modul
4 := speedy-Admin
8 := speedy-Explorer
16 := speedy-Viewer
128 := Solidworks-Addin
256 := Inventor-Addin
vault.database ADO-Datenbankobjekt der Vault Datenbank
vault.name Name des Vault-Objekts
obj_id Objekt-Id als Zeichenkette in der Form „{0-1-2-3-4-5}„
obj_id.id Die eigentliche Objekt-Id
obj_id.type Der Objekttyp
obj_name Name des Objekts. Bei Ordner wird hier der Ordnername angegeben.
obj_desc Beschreibung des Objekts. Bei Ordner wird hier die Ordnerbeschreibung angegeben.
obj_description
obj_class Klassenname des Objekts (z.B. CZvContainer für Ordner).
Die beiden Eigenschaften session.database und vault.database liefern kein Ergebnis, wenn mit dem Datenbank-Direkttreiber „MYSQL“ gearbeitet wird.

Globale Funktionen

Application - Objekt

In den Scriptfunkktionen steht das globale Object Application mit folgenden Funktionen zur Verfügung:

Application.GetSessionDb

Gibt das ADODB.Connection Objekt der Session Datenbank zurück.

Diese Funktion liefert kein Ergebnis, wenn mit dem Datenbank-Direkttreiber „MYSQL“ gearbeitet wird.

Application.GetRootPath

Gibt den Root Path, wie in der dwKernel.ini eingestellt, zurück.

Application.GetVaultCount

Gibt die Anzahl der Vault datenbank zurück.

Application.GetVaultDbAt(iIndex)

Gibt das ADODB.Connection Object der entsprechenden Vault Datenbank zurück.

Application.GetVaultNameAt(iIndex)

Gibt den Namen der Vault Datenbank zurück.

Application.GetTempFileName

Gibt einen temporären Dateinamen im aktuellen Temp-Verzeichnis zurück.

Application.GetTempPath

Gibt das aktuelle Temp-Verzeichnis zurück.

Application.GetAppPath

Gibt das Installationsverzeichnis der Anwendung zurück.

Application.ProgressStart(lMin, lMax, sTitle, sMessage)

Beginnt einen Dialog mit Fortschrittsanzeige.

Application.ProgressStop

Stoppt die Fortschrittsanzeige.

Application.ProgressText(sText)

Setzt den Text in der Fortschrittsanzeige.

Application.ProgressStep

Führt einen Schritt in der Fortschrittsanzeige aus.

Application.Log(lSeverity, sMessage)

Protokolliert einen Text in der aktuellen Log-Datei.

Application.InvokeCommand(sCallBack, wParam, lParam)

Ruft einen speedy Zusatzbefehl auf.

Application.HasCommand(sCallBack)

Überprüft, ob der Zusatzbefehl vorhanden ist.

Application.ConsoleExecute(sCmd, sDirectory, lWait)

Führt ein Programm/Aufruf auf der Konsole aus.

ParameterBeschreibung
sCmd Befehlszeile
sDirectory Verzeichnis in dem der Befehl ausgeführt werden soll.
lWait Soll auf das Ende der Befehlsausführung gewartet werden.


Application.DlgLookup(ByRef Result, DataName, Connection, DataSource, InitialValue, Option)

Öffnet einen Lookup-Dialog zur Auswahl.
Die Funktion gibt True bei erfolgreicher Auswahl zurück und False bei Abbruch durch den User.

ParameterBeschreibung
Result[String] Ergebnis der Auswahl, Wert der 1. Spalte der gewählten Zeile in der Auswahltabelle.
DataName[String] a) Name des Eigenschafttenformats. Im Eigenschaftenformat wird die Datenbankverbindung und das SQL Statement definiert. Die Werte für Connection und DataSource bleiben leer.
b) Name der Datenbankverbindung
Connection[String] ConnectionString zum Aufbau der Datenbankverbindung.
DataSource[String] SQL Statement zur Ermittlung der Auswahltabelle. Die 1. Spalte ergibt das Ergebnis des Lookup.
InitialValue[String] Vorab gewählter Wert.
Option[long] Wird zur zeit nicht unterstützt.


Application.EditObject(sItemId)

Bearbeitet das durch ItemId definierte Element mit dessen nativem Eigenschaften-Dialog.

Application.EditProperties(sItemId, Properties, bShowInvisible, sTitle, sDescription, sProfile)

Bearbeitet das durch ItemId definierte Element in einem vereinfachten Eigenschaften-Dialog.

ParameterBeschreibung
sItemId (String) Id des zu bearbeitenden Elements ({x-x-y-y-z-z})
Properties (String-Array) Array mit Eigenschaftennamen, die im Dialog bearbeitet werden sollen.
Für die Eigenschaften muss es jeweils ein definiertes Eigenschaftenformat geben.
bShowInvisible (Boolean) Sollen auch auch unsichtbar (Größe < 0) definierte Eiegnschaften im Dialog darstellen.
sTitle (String) Titelzeile der Dialogüberschrift.
sDescription (String) Beschreibungszeile der Dialogüberschrift.
sProfile (String) Profilname unter dem die Fenstergröße in der Registry gespeichert wird.


Application.GetDocumentPath(DocNo)

Gibt den Ablagepfad des Dokuments zurück.

Application.DbExecute(Connection, Statement)

Führt das SQL-Statement auf der benannten Datenbankverbindung aus.
Wird keine Verbindung (Connection) angegeben, wird die Datenbank der Session verwendet.
In Multi-Vault-Umgebungen kann der Name des Vault angegeben werden, um die Datenbank des Vault zu verwenden.
Die Funktion gibt 0 zurück, wenn kein Fehler vorliegt.
Die Funktion liefert kein Ergebnis aus dem SQL-Statement zurück.

DbExecute("", "UPDATE dm_document d inner join dm_version v ON d.doc_did=v.ver_did AND d.doc_rev=v.ver_major AND d.doc_ver=v.ver_minor inner join dm_prop_cad p on v.ver_vid=p.prop_did SET p.NORM = 'DIN 931' WHERE d.doc_docno = 'BS01516';")

Application.DbQuery(Connection, Statement)

Führt das SQL-Abfrage auf der benannten Datenbankverbindung aus.
Wird keine Verbindung (Connection) angegeben, wird die Datenbank der Session verwendet.
In Multi-Vault-Umgebungen kann der Name des Vault angegeben werden, um die Datenbank des Vault zu verwenden.
Die Funktion liefert die Werte der in der Abfrage definierten Felder in einem Array zurück.

DbQuery("", "SELECT lst_idx,lst_name,lst_desc FROM lng_lst WHERE lst_typ='PROJEKTSTATUS';") 

Ergebnis:
0 0 "Erstellt"
1 1 "In Arbeit"
2 2 "Angehalten"
3 3 "Beim Kunden"
4 4 "Im Bau"
5 5 "Fertig"

Application.DbLookup(Connection, Expression, Domain, Criteria)

Mit der DbLookup-Funktion können Sie den Wert eines bestimmten Feldes (Expression) aus einer bestimmten Datensatzgruppe (einer Domäne) abrufen.
Mit der Angabe von Criteria definieren Sie ein Suchkriterium.
In de Praxis werden die 3 Werte zu einem SQL-Statement zusammengesetzt und der erste gefundene Wert ist das Ergebnis der Suche:

SELECT <Expression> FROM <Domain> WHERE Criteria
DbLookup("", "MAX(doc_docno)", "dm_document", "") - Liefert die größte Dokumentnummer
DbLookup("", "sett_value", "dm_setting", "sett_key='bom.autosorted'")  - Liefert den Einstellungswert des Konfigurationsparameters [bom.autosorted]

Application.Sleep(Milliseconds)

Hält die Ausführung der Anwendung an, bis das Timeout-Intervall abgelaufen ist.

Clipboard - Objekt

Globales Objekt mit Funktionen zur Zwischenablage.

Clipboard.Clear

Leert die Zwischenablage

Clipboard.Copy(Text)

Kopiert den Text in die Zwischenablage

Clipboard.Paste

Gibt den aktuellen Text in der Zwischenablage zurück.

Text = Clipboard.Paste()




speedy.*

Allgemeine Objekt-Ereignisse

In der Ereignisroutine werden außer den allgemeinen Eigenschaften der Objekte auch noch objektspezifische Eigenschaften mit ins Dictionary geschrieben.

Object_onEvent(timing, handling, dictionary)

Ein Ereignis passiert. Der Ereignisname wird im Dictionary aufgeführt.

Eigenschaft Beschreibung
event Übergibt einen Ereignis-Namen
wparam
lparam

Folgende allegemeinen Ereignisse sind definiert und fürs skripting geeignet:

NameBeschreibung
Command::ExportDocument
Command::ExportBomTable
CDwPropertyEdit::OnSearch
CDwPropertyEdit::OnEdit
SWXAddin::ActiveModelDocChangeNotify

Object_onCreate(timing, handling, dictionary)

Ein Objekt (z.B. Ordner) wird in der Datenbank erstellt. timing = after: Objekteigenschaften des neuen Objekts werden mit ins Dictionary geschrieben

Object_onDelete(timing, handling, dictionary)

Ein Objekt wird in der Datenbank gelöscht. timing = before: Objekteigenschaften des zu Löschenden Objekts werden mit ins Dictionary geschrieben

Object_onInit(timing, handling, dictionary)

Ein Object-Container wird initalisiert.

Object_onUpdate(timing, handling, dictionary)

Ein Objekt wird aktualsiert, d.h. Änderungen am Objekt werden in die Datenbank geschrieben.

Object_onCopy(timing, handling, dictSource, dictTarget, dictionary)

Ein Object wird kopiert.

Parameter Beschreibung
dictSource Eigenschaften des Quell-Objekts
dictTarget Eigenschaften ds Ziel-Objekts
dictSource Allgemeine Eigenschaften

Object_onCreateObject(timing, handling, dictionary)

Ein neues Objekt wird mit Benutzerinteraktion (Neu-Dialog) erstellt.

Eigenschaft Beschreibung
CreateObject.flag
CreateObject.hwnd
CreateObject.subitem
CreateObject.param
CreateObject.file
CreateObject.usetemplate
CreateObject.useextension
CreateObject.deleteorigin
CreateObject.saveascopy

Object_onEditObject(timing, handling, dictionary)

Die Eigenschaften eines Objekts sollen mit Benutzerinteraktion bearbeitet werden.

Eigenschaft Beschreibung
EditObject.flag
EditObject.hwnd
EditObject.subitem
EditObject.param

Object_onBuildDocName(docno, dictVault, dictParent, dictOrigin, dictDoctype, dictProperties, timing, handling)

Eine neue Dokumentnummer soll genriert werden.

Parameter Beschreibung
docno Rückgabe der neuen Dokumentnummer
dictVault Eigenschaften des aktuellen Vaults
dictParent Eigenschaften des Elternelements (z.B. Ordner)
dictOrigin Eigenschaften des Ursprung Objekts (z.B. Dokument beim Kopieren)
dictDoctype Eigenschaften des Ordnertyps
dictProperties Sonstiges Eigenschaften


Dokument-Ereignisse

In der Ereignisroutine werden außer den Allgemeinen Eigenschaft der Dokumente auch noch Dokumentspezifische Eigenschaften mit ins Dictionary geschrieben.

Document_onEvent(timing, handling, dictionary)

Eigenschaft Beschreibung
eventÜbergibt einen Ereignis-Namen

Document_onBeforeImport(timing, handling, dictionary)

Eigenschaft Beschreibung
filenameÜbergibt den Datei-Namen

Document_onCreate(timing, handling, dictionary)

timing = after: Dokumenteigenschaften des neuen Dokuments werden mit ins Dictionary geschrieben

Document_onDelete(timing, handling, dictionary)

timing = before: Dokumenteigenschaften des zu Löschenden Douments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
filename Übergibt den Datei-Namen

Document_onCreateVersion(timing, handling, dictionary)

timing = after: Dokumenteigenschaften der neuen Version des Douments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
revisionnoErstellt die neue Freigabenummer
majorSchaut nach höherer Freigabenummer
minorSchaut nach niedriger Freigabenummer
statusÜbergibt den aktuellen Status

Document_onDeleteVersion(timing, handling, dictionary)

timing = before: Dokumenteigenschaften der zu löschenden Version des Douments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
majorSchaut nach höherer Freigabenummer
minorSchaut nach niedriger Freigabenummer

Document_onRemoveFile(timing, handling, dictionary)

timing = before: Dokumenteigenschaften des zu entfernenden Douments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
filenameÜbergibt den Datei-Namen

Document_onStatusChange(timing, handling, dictionary)

timing = before: Dokumenteigenschaften des alten Dokuments werden mit ins Dictionary geschrieben
timing = after: Dokumenteigenschaften des neuen Dokuments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
statusÜbergibt den Status

Document_onRelease(timing, handling, dictionary)

Eigenschaft Beschreibung
commentÜbergibt ein Kommentar
majorLetzte Freigabe
deletelocalLöscht die lokale Freigabe

Document_onPendingApproval(timing, handling, dictionary)

Eigenschaft Beschreibung
commentÜbergibt ein Kommentar

Document_onApprove(timing, handling, dictionary)

Eigenschaft Beschreibung
commentÜbergibt ein Kommentar

Document_onUndoRelease(timing, handling, dictionary)

Eigenschaft Beschreibung
commentÜbergibt ein Kommentar

Document_onCheckIn(timing, handling, dictionary)

Eigenschaft Beschreibung
extension String. Dateierweiterung, die eingecheckt werden soll.
deletelocal Boolean. Soll die lokale Datei beim einchecken gelöscht werden.
force Boolean. Erzwingt das einchecken.

Document_onCheckInNew(timing, handling, dictionary)

Eigenschaft Beschreibung
fileÜbergibt eine Datei
originÜbergibt den Ursprungsdateiname
useextensionNutzt die Datei-Extension separat
deletelocalLöscht die lokale Freigabe

Document_onCreateFile(timing, handling, dictionary)

timing = after: Dokumenteigenschaften des neuen Douments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
templateÜbergibt das Template separat
extensionÜbergibt die Datei-Extension separat

Document_onCheckOut(timing, handling, dictionary)

Eigenschaft Beschreibung
extension String. Dateierweiterung, die ausgecheckt werden soll.
force Boolean. Erzwingt das auschecken.
path String. Verzeichnis in das ausgecheckt wird.

Document_onCheckOutReleased(timing, handling, dictionary)

Eigenschaft Beschreibung
extension String. Dateierweiterung, die ausgecheckt werden soll.
force Boolean. Erzwingt das auschecken.
path String. Verzeichnis in das ausgecheckt wird.

Document_onCheckOutIn(timing, handling, dictionary)

Eigenschaft Beschreibung
extension String. Dateierweiterung, die ausgecheckt werden soll.
force Boolean. Erzwingt das auschecken.

Document_onUndoCheckOut(timing, handling, dictionary)


Document_onUndoCheckOutReleased(timing, handling, dictionary)


Document_onCopyOut(timing, handling, dictionary)


Document_onOpen(timing, handling, dictionary)

timing = after: Dokumenteigenschaften des zu öffnenden Dokuments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
extensionÜbergibt die Datei-Extension separat
readonlyÖffnet die Datei nur lesend
waitforexecuteWartet bis etwas ausgeführt ist

Document_onPrint(timing, handling, dictionary)

timing = after: Dokumenteigenschaften des zu Druckenden Dokuments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
extensionÜbergibt die Datei-Extension separat

Document_onView(timing, handling, dictionary)

timing = after: Dokumenteigenschaften des zum Viewen geöffneten Dokuments werden mit ins Dictionary geschrieben

Eigenschaft Beschreibung
extensionÜbergibt die Datei-Extension separat

Document Operations-Ereignisse

Ereignisse die sich beim Kopieren von Dokumenten ergeben.

DocumentOperations_onCopyDocument

Function DocumentOperations_onCopyDocument(timing, handling, source, target, dictionary)
Eigenschaft Beschreibung
source Eigenschaften des Quell Dokuments.
target Eigenschaften des Ziel Dokuments.
dictionary Eigenschafen des Dokumenttyps.

Container-Ereignisse

Container_onDeleteBomStructure(timing, handling, dictionary)

Eigenschaft Beschreibung
docnoÜbergibt die Dokumenten-Nummer

Container_onAddDocument(timing, handling, dictionary)

Eigenschaft Beschreibung
DocumentAlle Eigenschaften des Dokument werden übergeben
ContainerAlle Eigenschaften des Containers werden übergeben

Container_onRemoveDocument(timing, handling, dictionary)

Eigenschaft Beschreibung
DocumentAlle Eigenschaften des Dokument werden übergeben
ContainerAlle Eigenschaften des Containers werden übergeben


File-Ereignisse

Ereignisse, die im Zusammenhang mit Dateioperationen auftreten.

FileOperations_onReReferenceFiles(timing, handling, params, mapfiles)

Parameter Beschreibung
params Dictionary mit allgemeinen Eigenschaften
mapfiles Dictionary mit Datei-Mapping Alter-Dateiname⇔Neuer-Dateiname
Params-Eigenschaft Beschreibung
source Übergibt den Datei-Pfad
target Übergibt den Zielpfad
msg Sollen Fehlermeldungen ausgegeben werden
force Erzwingen

FileOperations_onGetFileDependencies(timing, handling, dictionary, dependencies)

Parameter Beschreibung
dictionary Allgemeine Eigenschaften
dependencies String-Array mit den Dependencies

FileOperations_onReplaceReferencedFiles(timing, handling, dictionary, filename, mapReplacements)

Parameter Beschreibung
dictionary Allgemeine Eigenschaften
filename
mapReplacements

FileOperations_onFileSaveAs(timing, handling, dictionary)

Eigenschaft Beschreibung
filenameÜbergibt den Datei-Pfad
targetÜbergibt den Zielpfad
pagesÜbergibt ob alle Seiten gespeichert wird oder nur die erste

FileOperations_onAppRelease()


FileOperations_onFileExport(timing, handling, dictionary)

Eigenschaft Beschreibung
source Dateiname inkl. Pfad der Quelldatei.
target Dateiname inkl. Pfad der Zieldatei.

Das dictionary enthält zusätzlich die Eigenschaften des Dokuments.
Wenn das timing-Argument den Wert kUpdateUI hat kann der Dictionary Eintrag für den „target“ durch einen neuen Dateinamen inkl. Pfadangabe ersetzt werden. Wurde das Exportziel „target“ verändert muss das Argument handling den Wert kEventHandled erhalten.
z.B.:

Public Function FileOperations_onFileExport(ByVal timing, handling, dictionary)
   Dim old_target, target, BEN1, ext
   if timing = kUpdateUI then
      old_target = dictionary.Item("target")
      ext = PathFindExtension(old_target)
      target = PathRemoveFileSpec(old_target)
      BEN1 = dictionary.Item("BEN1")
      BEN1 = Replace(BEN1, " ", "_")
      target = PathCombine(target, BEN1)
      target = PathAddExtension(target, ext)
      dictionary.Item("target") = target
      handling = kEventHandled
   end if
End Function


Import-/Export-Ereignisse

IO_onImport(timing, handling, import, objects, file)

Parameter Beschreibung
import Allgemeine Eigenschaften sowie die Eigenschaften der Importbeschreibung
objects Array von Objekt-Eigenschaften
file Dateiname der Importdatei.

IO_onImportFile(timing, handling, import, objects, file)

Parameter Beschreibung
import Allgemeine Eigenschaften sowie die Eigenschaften der Importbeschreibung
objects Array von Objekt-Eigenschaften
file Dateiname der Importdatei.

IO_onImportObject(timing, handling, import, dictionary, first)

Parameter Beschreibung
import Allgemeine Eigenschaften sowie die Eigenschaften der Importbeschreibung
dictionary Eigenschaften des zu importierenden Objekts
first Boolean. Erstes Objekt des laufenden Imports.

IO_onExport(timing, handling, dictionary, objects, filename)

Paramater Beschreibung
timing
handling
dictionary Allgemeine Eigenschaften der Session und des Export-Objekts.
objects Collection von Dictionary Objekten mit jeweils den Eigenschaften der zu exportierenden Objekten.
filename Dateiname der Exportdatei, wenn in eine Datei exportiert wird.

Makro Befehle

OnCommand01 - OnCommand99

Funktion, die per kundenspezifischer Anpassung der Ribbonleiste, aufgerufen werden kann.

Parameter Beschreibung
dictionary Dictionary mit allgemeinen Eigenschaften der Session und des Vaults.
documents Array mit allen beim Makroaufruf markierten Dokumenten (Dokumentnummer).

Erweiterung der Ribbonleiste um ein Schaltflächenelement:

   <ELEMENT>
	<ELEMENT_NAME>Button</ELEMENT_NAME>
	<ID>
	   <NAME>OnCmdScript01</NAME>
	   <VALUE>24500</VALUE>
	</ID>
	<TEXT>Befehl 01</TEXT>
	<INDEX_SMALL>8</INDEX_SMALL>
	<INDEX_LARGE>8</INDEX_LARGE>
   </ELEMENT>
RibbonbefehlBefehls-IDScriptbefehl
OnCmdScript01 24500 OnCommand01
OnCmdScript99 24599 OnCommand99

Beispiel Script-Funktion:

Function OnCommand01(dictionary, documents)
   On Error Resume Next
   Dim i, count
 
   MsgBox "OnCommand01: " & dictionary.Item("session.user")
   count = UBound(documents) - LBound(documents)
   For i=0 To count 
      MsgBox "document[" & i & "]:=[" & documents(i) & "]"
   Next 
End Function


document.*

Die Skriptdatei „document“ enthält Ereignisse, die im Neu- und Eigenschaften-Dialogs eines Dokuments aufgerufen werden. Sobald Scriptdatei im Script-Ordner gefunden wurde, erscheint neben der Dokumentnummer eine Schaltfläche. Beispielecodes sind unter ../script/example/document.example.vbs für sie bereitgelegt.

OnBrowse (kBefore, dictionary)

Wird durch betätigen der Schaltfläche rechts neben der Dokumentnummer aufgerufen

ParameterBeschreibung
kBeforeZeitpunkt wann die Aktion ausgeführt werden soll(Hier unrelevant)
dictionaryÜbergibt das Dictionary Objekt

Rückgabe: true oder 1 := Das Dictionary enthält Eigenschaften, die in den Dialog zu übernehmen sind.

OnValidate(kBefore, dictionary)

Wird beim Bestätigen des Neu-Dialogs vor dem Erstellen eines neuen Dokuments aufgerufen

ParameterBeschreibung
kBeforeZeitpunkt wann die Aktion ausgeführt werden soll(Hier unrelevant)
dictionaryÜbergibt das Dictionary Objekt

Rückgabe: 1 := Das Dictionary enthält Eigenschaften, die in den Dialog zu übernehmen sind.

Sobald OnValidate aufgerufen wurde, wird der OnBrowse nicht mehr aufgerufen.

OnChangeProp (prop, val, dictionary)

Wird bei Änderung einer Eigenschaft im Neu- und Eigenschaften-Dialog aufgerufen.

ParameterBeschreibung
prop Eigenschaft auf die Reagiert werden soll.
val Dazugehöriger Wert zur Eigenschaft.
dictionary Übergibt das Dictionary Objekt

Rückgabe: 1 := Das Dictionary enthält Eigenschaften, die in den Dialog zu übernehmen sind.


container.*

Die Skriptdatei „container“ enthält Ereignisse, die im Neu- und Eigenschaften-Dialogs eines Ordners aufgerufen werden. Sobald Scriptdatei im Script-Ordner gefunden wurde, erscheint neben dem Ordnernamen eine Schaltfläche. Beispielecodes sind unter ../script/example/container.example.vbs für sie bereitgelegt.

OnBrowse (kBefore, dictionary)

Wird durch betätigen der Schaltfläche rechts neben dem Ordnernamen aufgerufen

ParameterBeschreibung
kBeforeZeitpunkt wann die Aktion ausgeführt werden soll(Hier unrelevant)
dictionaryÜbergibt das Dictionary Objekt

Rückgabe: true oder 1 := Das Dictionary enthält Eigenschaften, die in den Dialog zu übernehmen sind.

OnValidate(kBefore, dictionary)

Wird beim Bestätigen des Neu-Dialogs vor dem Erstellen eines neuen Ordners aufgerufen

ParameterBeschreibung
kBeforeZeitpunkt wann die Aktion ausgeführt werden soll(Hier unrelevant)
dictionaryÜbergibt das Dictionary Objekt

Rückgabe: 1 := Das Dictionary enthält Eigenschaften, die in den Dialog zu übernehmen sind.

Sobald ein OnValidate aufgerufen wurde, wird der OnBrowse nicht mehr aufgerufen.


swxSpeedy.*

Die Skriptdatei „swxSpeedy“ enthält Ereignisse, die vom Solidworks AddIn aufgerufen werden. Beispielecodes sind unter ../script/example/swxSpeedy.vbs für sie bereitgelegt.

OnFileSave(lEventTiming, dictionary)

Ereignis-Routine beim Speichern.

ParameterBeschreibung
lEventTimingZeitpunkt wann die Aktion ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnFileCheckIn(lEventTiming, dictionary)

Ereignis-Routine beim Einchecken.

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnFileRelease(lEventTiming, dictionary)

Ereignis-Routine beim Freigeben.

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnReleaseRecreate_SaveAs(lEventTiming, dictionary)

Ereignis-Routine zum Speichern beim Freigeben.

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnPendingApprovalRecreate_SaveAs(lEventTiming, dictionary)

Ereignis-Routine zum Speichern bei Antrag auf Prüfung

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnApproveRecreate_SaveAs(lEventTiming, dictionary)

Ereignis-Routine zum Speichern bei Prüfung

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnFileOpen(lEventTiming, dictionary)

Ereignis-Routine die beim öffnen einer Datei ausgeführt wird.

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt




aisSpeedy.*

Die Skriptdatei „aisSpeedy“ enthält Ereignisse, die vom Inventor AddIn aufgerufen werden. Beispielecodes sind unter ../script/example/aisSpeedy.vbs für sie bereitgelegt.

OnFileSave(lEventTiming, dictionary)

Ereignis-Routine beim Speichern.

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnFileSaveAs(lEventTiming, dictionary)

Ereignis-Routine beim Speichern unter.

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnFileCheckIn(lEventTiming, dictionary)

Ereignis-Routine beim Einchecken

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnFileRelease(lEventTiming, dictionary)

Ereignis-Routine beim Freigeben

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnReleaseRecreate_SaveAs(lEventTiming, dictionary)

Ereignis-Routine zum Speichern beim Freigeben

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnPendingApprovalRecreate_SaveAs(lEventTiming, dictionary)

Ereignis-Routine zum Speichern bei Antrag auf Prüfung

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnApproveRecreate_SaveAs(lEventTiming, dictionary)

Ereignis-Routine zum Speichern bei Prüfung

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt


OnSaveAs(lEventTiming, dictionary)

Ereignis-Routine zum Speichern in anderen Dateiformaten. Wird z.B. vom speedy-Zusatzbefehl „Speichern unter“ verwendet.

Eigenschaft Beschreibung
lEventTimingZeitpunkt wann die aktion Ausgeführt werden soll
dictionaryÜbergibt das Dictionary Objekt