Script template for on drop scripts for items
This topic provides a template of the empty functions that can be used in a diagram tab button script for links.
You can copy the script template text that follows from this topic to the Script property in Modeler. If you want single line spacing, copy the following text from this topic to Notepad, and then copy the text from Notepad to Modeler.
Key:
Remarked variable names at the top of the file are available in all functions underneath except where stated.
Remarked variable names immediately above functions are only available in those functions (or subfunctions called).
The comment line '---Context change--- indicates that script is unloaded and reloaded here between function calls - this means that script scoped variables cannot be used to transfer data between functions separated by one of these comment lines, and other methods (such as helper dlls) should be used in the (fairly rare) situation that this is needed.
Option Explicit
'Studio(.DisplayOutputWindowMessage and .ClearOutputWindow)
'Projects
'ActiveProject
'CurrentScript
'Script.DropEffect - 1 for copy, 2 for move, 4 for type assignment
'DroppedItem - the item being dropped
'HitItem - the item being dropped on
'Dictionary available here but *not* available in OnDrop()
Function ValidDrop()
ValidDrop=False'Do not run OnDrop() - abandon Drop
ValidDrop=True'Do run OnDrop()
End Function
'---Context change---
'DropResult - the item created/moved or linked depending on Script.DropEffect
Function OnDrop()
OnDrop=False'Do not commit the transaction
OnDrop=True'Do commit the transaction
End Function