Defining User Commands

The following procedures describe how to create, delete and edit User commands using the User Command Settings dialog. They also describe how to export and import the User commands in any eCADSTAR application. This dialog is displayed by clicking Configuration >  User Command Settings User Command Settings in the File tab on the ribbon. The User commands that you create can be added to the ribbon and Quick Access Toolbar, and assigned to customized functions, including shortcut keys, strokes and mouse buttons.

Adding User Commands

Add a user command as follows:

  1. In the File tab on the ribbon, click Configuration >  User Command Settings User Command Settings. The User Command Settings dialog is displayed.
  2. Click Add in the User Command Settings dialog. The Add User Command Dialog is displayed.
  3. Click the small and large Icon boxes to associate a small and large icon with the new User command. The Select Icon dialog is displayed.
  4. 16 x 16 pixels and 32 x 32 pixels icons are listed in the Select Icon dialog.
  5. To specify an icon of your choice, create the "usericons" folder shown below, and copy the icon to it:
    %APPDATA%\Zuken\eCADSTAR\2017.0\settings.ncsle\settings\gui\images\usericons. Differently-sized icons are automatically scaled to fit.
  1. In the ID field, enter a unique identifier for the User command or accept the default value.
  2. In the Command name field, enter the name that is displayed on the ribbon by the User command.
  3. In the Description field, enter the description of the command. This is displayed when you point the cursor at the command on the ribbon.

Inserting Macro variables

Insert a macro variable by clicking Insert macro variable and selecting it from the displayed list, or by typing it in the Command strings box. The available macro variables are shown below. See: Using Macro Variables.

Item String to be inserted
Program Folder Path ${binDirPath}
Environment variable ${env:environment variable name}
Information File Path ${infoFilePath}
Warning File Path ${warningFilePath}
Error File Path ${errorFilePath}
Design Data File Path (not available in eCADSTAR Schematic Editor) ${dsgnPath}
Design Data Folder Path (not available in eCADSTAR Schematic Editor) ${dsgnDirPath}
Cursor X Coordinate (not available in eCADSTAR Schematic Editor) ${cursorPointX}
Cursor Y Coordinate (not available in eCADSTAR Schematic Editor) ${cursorPointY}
Number of conductor layers (not available in eCADSTAR Schematic Editor) ${numberOfCondLayers}

Exporting User Commands

Export the User commands to a file as follows.

  1. In the User Command Settings dialog, click Save As. The Save As dialog is displayed.
  2. In the Save As dialog, specify a .eac file in which to save the settings and click Save.

Importing User Commands

In any eCADSTAR application, import previously-exported User command settings as follows.

  1. In the User Command Settings dialog, click Load The Open dialog is displayed.
  2. In the Open dialog, double-click an exported .eac file. Alternatively, select it and click Open in the dialog. After removing duplicate items, the imported settings are merged with existing customizations. These settings are previewed in the User Command Settings dialog. Imported user commands are highlighted.
  3. Click OK to add the previewed settings. The added User commands are made available in the relevant eCADSTAR application. Alternatively, click Cancel to discard the previewed settings.
Note
  • If you load commands that were exported from a different eCADSTAR application, and are not applicable to the current application, then they are made unavailable. Commands are also made unavailable that you load from a later release to one that does not support them.
  • The existing labels and icons that are assigned to a command are not changed if you attempt to load a duplicate command.

Editing User Commands

Edit the details of a user command as follows.

  1. In the User command list box in the User Command Settings dialog, select a user command and click Edit. Alternatively, right-click a User command and select Edit in the assist menu. The Edit User Command Dialog is displayed.
  2. Edit the details in the Edit Command Settings dialog and click OK.
  3. In the User Command Settings dialog, click OK. Your changes are applied, and the dialog is closed.

Deleting User Commands

Delete a User command as follows.

  1. In the User command list box in the User Command Settings dialog, select a user command that you want to delete. You can select multiple commands, if required.
  2. Click Delete in the User Command Settings dialog, or right-click a User command and select Delete in the assist menu. The selected user command is deleted.
  3. Click OK in the User Command Settings dialog. Your changes are applied, and the dialog is closed.