askvity

How Do You Cancel a Script in Altium?

Published in Altium Scripting 2 mins read

To cancel or stop a script that is currently running or being stepped through in Altium Designer, you can use specific commands or toolbar buttons designed for script debugging.

Stopping a Running or Stepping Script

When you are executing a script, particularly during debugging or stepping through its code line by line, you may need to halt its execution before it completes naturally. This is when the cancellation or stop function is essential.

As stated in the documentation: "If the script needs to be stopped – such as when stepping it through – use the Stop command (Run » Stop, Ctrl+F3) or button ( on the Script Debug toolbar)."

This indicates two primary ways to stop a script once it has started running:

  1. Using the Menu Command: Access the Run menu and select the Stop command.
  2. Using the Keyboard Shortcut: Press the key combination Ctrl+F3.
  3. Using the Toolbar Button: Click the Stop button, typically found on the Script Debug toolbar. This button is visually represented by a square icon ( ).

Here is a quick summary of the methods:

Method Action Location
Menu Select Stop Run menu
Shortcut Press Ctrl+F3 Keyboard
Toolbar Click the Stop button ( ) Script Debug toolbar

Using any of these methods will immediately halt the execution of the currently running or stepping script in Altium Designer.

Related Articles