Add User Command Dialog

The Add User Command dialog allows you to create User commands, and specify their location in the relevant eCADSTAR application. It is displayed by clicking Add split button > Custom in the User Command Settings dialog.

Add User Command

Icon

Specify a small and large icon for the new user command in the Select Icon dialog. This is displayed by clicking the small and large Icon boxes. The provided icons are 16 x 16 pixels and 32 x 32 pixels. To specify an icon of your choice for each eCADSTAR application, create the "gui\images\usericons" folders at the location shown below, and copy the relevant .png icon to the usericons folder.

• eCADSTAR Library Editor: "%APPDATA%\Zuken\eCADSTAR\[version]\settings.ncsle\gui\images\usericons".
• eCADSTAR Schematic Editor: "%APPDATA%\Zuken\eCADSTAR\[version]\settings.sch\gui\images\usericons".
• eCADSTAR PCB Editor: "%APPDATA%\Zuken\eCADSTAR\[version]\settings.ncs\gui\images\usericons".

Differently-sized icons are automatically scaled to fit.

 

 

ID

A unique identifier that is associated with the User command. The value userCommand[number] is automatically assigned. Alternatively, define a name in this field.

Command Name

For User commands, this value is displayed by the icon on the ribbon. It is also displayed when you point the cursor at the command on the ribbon.

Description

For User commands, this value is displayed when you point the cursor at the command on the ribbon.

Command strings

Displays the macro variables that are associated with the User command. Select macro variables by clicking Insert macro variable, and selecting them from the displayed list.

Insert macro variable

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. 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 Coordinates	Not available in eCADSTAR Schematic Editor	${cursorPointX}
Cursor Y Coordinates	Not available in eCADSTAR Schematic Editor	${cursorPointY}
Number of Conductor Layers	Not available in eCADSTAR Schematic Editor	${numberOfCondLayers}

Location

Specify where the User command is saved in eCADSTAR. It can be saved as a macro or User tool command in the Quick Access Toolbar, or in the Report Generator menu on the ribbon. If you select Custom, then it is not added to the Quick Access Toolbar or ribbon, but can be added subsequently. The icons in this dialog are updated, depending on the type of User command.

Value	Description
Custom	The selected command is not added to User Report, User Tool or Macro menus. However, it can be accessed from the following dialogs: User Command Settings, Quick Access Toolbar Settings and Ribbon Setting.
Macro Menu	The selected command is accessed from the drop down list on the Macro button in the Quick Access Toolbar.
Report Generator Menu	The selected command is accessed from the drop-down list on the Report Generator split button on the ribbon.
User Tool Menu	The selected command is accessed from the drop-down list on the Add User Tool button in the Quick Access Toolbar.

OK

The User command that you add is saved in the relevant eCADSTAR application, and the Add User Command dialog is closed.

Cancel

Closes the Add User Command dialog without adding new User commands.