Configuration & Customization

Configuration and Customization Overview

There are many ways you can configure the Altium Designer design space so that it works the best for you, including using dual monitors, viewing all documents simultaneously, and saving your unique desktop layout.

The Altium Designer design space can be customized in order to help you be more productive in your design work. Resources in an editor are the menu bars, toolbars and the shortcut key tables. Behind each resource item, there is a pre-packaged process launcher that activates a command when its resource item is selected. All the commands available from the menus can be added to or deleted from these resources. The pre-packaged process launchers bundle together the process that runs when the command is selected, plus any parameters, bitmaps (icons), captions (the name of an item that displays on a resource), descriptions, and associated shortcut keys. If a process launcher is modified, every linked instance of the command on any bar will be updated.

Configuring the Design Environment

The following sections describe ways you can configure the Altium Designer design space to suit your needs.

Dual Monitor Support

Altium Designer supports the use of dual monitors with a recommended resolution of 2560 x 1440. With many documents open simultaneously, several panels, toolbars and support documents, this feature affords you enough space to configure a more comfortable working environment. You might, for example, dedicate the use of one monitor solely for design, while arranging various panels and additional documents on the other. Use the computer settings to configure your monitor set up according to your needs.

Displaying Documents

When you open a document, it becomes the active document in the main design window on the Documents Bar. Multiple documents may be opened simultaneously and each open document has its own tab at the top of the design window. Only one document can be active within the main design window; the active document is distinguished by a highlighted appearance of its tab. The image below shows three documents open, one PCB and two schematics, with the middle schematic document currently active.

To make another open document the active document, click on its tab. Alternatively, use the Ctrl+Tab or Ctrl+Shift+Tab keys to cycle forward or backward (respectively) through all open documents. If you have a large number of documents open, you can choose to group them by enabling the Group documents if need option in the Documents Bar options on the System - View page of the Preferences dialog. Documents can be grouped by document kind or by project. 

Document Insight

Document Insight provides an alternate way to preview and open your documents. When the Enable Document Insight option is enabled on the  System - Design Insight page of the Preferences dialog, a small preview of the document is displayed when you hover the cursor over the document icon in the Projects panel. Click on the preview to open the document. Note that the document must have been open at least once for the preview to be displayed.

Document Window Management

With Altium Designer, you are not limited to viewing and working with a single design document at a time. Various commands are provided that allow you to effectively manage the open documents and tailor their display to your preferred working habits.

Right-click on a document tab to access various commands for managing the document. These commands including closing and saving the document(s), as well as commands affecting the display of all open documents within the main design window, as shown below. Commands for splitting the main design window vertically (Split Vertical) or horizontally (Split Horizontal) are invaluable when performing cross-document tasks, such as cross-probing between a schematic and its PCB.

When split, the regions are treated as though they are individual windows. One document may be active in each region, but only one document, across all regions, can have the focus at any given time. When a new document is added, or an existing document is opened, it will be opened as part of the region in which the currently focused document resides. The image below shows the design space split vertically; the highlighted schematic document is the currently active document.

The right-click commands also allow you to tile the documents (Tile All), which opens each document in the design space as shown in the below image. In the image, the highlighted PCB document is the currently active document.

Use the Merge All command to 'merge' all documents back into a single design window.

You can also open a document in its own separate design window by right-clicking on its tab then choosing Open In New Window from the menu. 

Desktop Layouts

As a further aid in setting up the design environment, Altium Designer supports the notion of Desktop Layouts. This feature allows you to arrange the application's document windows, panels and toolbars around the desktop as required and then save that layout to a file. Using this feature, multiple users can quickly arrange the design space to suit their design habits by loading their preferred layout. Options for saving and loading layouts, including resetting to the default layout shipped with the software, are available from the System - View page of the Preferences dialog.

Customizing the Design Space

Every designer has a different way of working. Altium Designer recognizes this and, therefore, allows you to customize your design space, which allows you to be more productive. For example, you can create new toolbars and commands, as well as add commands to a toolbar or menu, and also create drop-down menus. The following sections describe the procedures for customizing your design space.

Customizing Toolbars and Menus

You can easily customize Altium Designer by arranging the menus and toolbars anywhere on your monitors to suit your needs. The Customizing Editor dialog is used to customize the resources in an editor, as well as adding to or deleting from these resources. When the Customizing Editor dialog is open, you can click and drag commands between the active menus and toolbars. The dialog can be accessed by right-clicking on a menu bar or toolbar then choosing Customize from the drop-down menu or by double-clicking in a blank area (away from any commands) of a menu bar or toolbar. Each editor has its own version of the dialog as shown in the example images below.

Accessing the Customizing Editor dialog: Top image - Utilities toolbar access from a schematic; Bottom image - Menu bar access from a PCB.

Creating a New Toolbar

From the Toolbars tab of the Customizing Editor dialog, you can select which main menu and toolbars to display, create a new or duplicate toolbar, as well as rename, delete or restore toolbars. To create a new toolbar:

1. In the Customizing Editor dialog, click the Toolbars tab.
2. Click New to create a new toolbar. New Toolbar appears in the Bars region.

3. With New Toolbar selected, click Rename then enter the desired name for the new toolbar.
4. Activate the toolbar by enabling its associated Is Active box. A blank toolbar will appear docked in the menu area of the screen.
5. You can now add commands to your new toolbar. See the Adding a Command to a Toolbar or Menu section for details.

Duplicating a Toolbar

If you want to create a new toolbar based on an existing toolbar, it is easier to duplicate the original toolbar and edit the commands.

1. On the Toolbars tab of the Customizing Editor dialog, click the Duplicate button to create a new instance of the selected toolbar.
2. Copy of <toolbar name> appears in the Bars region.

3. With Copy of <toolbar name> selected, click Rename then enter the desired name for the duplicate toolbar.
4. You can now add commands to your new toolbar. See the Adding a Command to a Toolbar or Menu section for details.

Activating Toolbars

Toolbars will only appear on the screen if they are active. Select which toolbars are active (displayed) on the Toolbars tab on the Customizing Editor dialog. When the Is Active box is enabled (checked), the associated toolbar is active and will be displayed.

Adding a Command to a Toolbar or Menu

A command can be linked or duplicated when it is added to a bar. A linked command will be updated if the original process launcher is modified. A duplicated command, however, will remain as a copy of the original process launcher and not be updated. Duplicated commands can be modified to create a new command by changing its process launcher properties. To add a command to a bar:

1. Right-click on a menu bar or a toolbar then select Customize from the menu. The appropriate Customizing Editor dialog opens.

2. The Categories on the Commands tab of the dialog are the menu and submenu headings sorted alphabetically. By default, the built-in bars (the default menus and toolbars) are displayed in the Commands list. Click on a category to display all the commands associated with that menu bar. These are all the commands that are installed for the selected category.
3. Select the command you want to add to a toolbar or menu from the Commands region on the Commands tab of the Customizing Editor dialog.
4. With the dialog still open, go to the menu or toolbar that you want to add the command to and right-click to display the Customize drop-down menu.

5. Choose Insert Link to link to the original process launcher or Insert Duplicate to create a copy of the command.  
6. Release the mouse button and the command will be added to the menu or toolbar.

Shortcuts to Adding Commands to Existing Toolbars

With the Customizing Editor dialog open, select the command in a menu or toolbar you want to duplicate or link. Use Ctrl+Click then drag the command to the new location (to Insert Duplicate); use Shift+Ctrl+Click then drag the command to the new location (to Insert Link).

Setting the Main Menu

You can nominate which main menu bar is active (displayed) by selecting a menu from the Bar to use as Main Menu drop-down on the Toolbars tab in the Customizing Editor dialog.

Restoring Menu and Toolbar Defaults

Use the following steps to restore the original default menus and toolbars and delete all customizations:

1. On the Toolbars tab in the Customizing Editor dialog in the Bars region, select the bar you want to restore then click the Restore button.

2. Click OK to confirm the removal of all customizations from the selected bar and restore the original default menus and toolbars..

Creating a New Command

Use the following steps to create a new command:

1. On the Commands tab of the Customizing Editor dialog, click New to open the Edit Command dialog.

2. Click the Browse button to open the Process Browser dialog to select the desired process for the new command.

3. Use the controls of the Process Browser dialog to search for and find the required process then click OK to return to the Edit Command dialog. 
4. In the Edit Command dialog, the Caption will become the name of the command on the appropriate menu, therefore, use a name that is easily recognizable as a new command.
5. If you require an image to be associated with the new process launcher, click  in the Bitmap File field to find a bitmap file. This image (or icon) will display when the new command is added to toolbars, e.g., the Zoom In command uses the Zoomin.bmp bitmap found in the \System\Buttons folder of the installation.
6. If desired, you can use the Shortcuts region to add a Primary and Alternative shortcut by using the drop-downs for each. Once you have defined the new command, click OK.
7. A [Custom] category has been added to the Categories region of the Customizing Editor dialog. When selected, the new command is displayed in the Commands region.
8. You can now add the new command to the relevant bar(s). See the Adding a Command to a Toolbar or Menu section for details.

Duplicating Commands

It is often easier to create a new command by duplicating an existing command that is similar then modify its parameters. To duplicate a command:

1. On the Commands tab of the Customizing Editor dialog, select the command you want to duplicate then click Duplicate to create a new copy of the selected command.
2. Click on [Custom] in the Categories region to see the new (duplicated) command in the Commands list.
3. Select the new (duplicated) command then click Edit (or double-click the command) to open the Edit Command dialog in which you can modify its properties (e.g., add a new parameter and a new caption) then click OK. 
4. You can select then drag the new command onto a toolbar or menu. 

Deleting a Custom Command

Deleting a customized command stored in the Custom category will delete all instances of the custom command from all resources.

1. In the Customizing Editor dialog, click on the [Custom] category then select the command you want to delete in the Commands region.
2. Click Delete. All instances of the command will be removed from the bars.

Delete a Command from One Resource

If you want to delete just one instance of a command without affecting other instances:

1. With the Customizing Editor dialog open, at the top of the Altium design space, select the command that you want to delete from the menu or toolbar. A white box around the command indicates it is selected.
2. Right-click then select Delete. Alternatively, click and hold on the menu item or toolbar icon and drag it off its bar. The cursor changes to  while dragging.

Adding a Group Separator to a Drop-down Menu

You can add a line separator above the item in a menu or before an icon in a toolbar. With the Customizing Editor dialog open, right-click on a menu or toolbar item then select Begin Group.

Creating a New Drop-Down Menu

1. With the Customizing Editor dialog open, place the cursor where you want to add the new drop-down menu. A drop-down menu can be added to the main menu or to an existing command in a menu.
2. Right-click then select Insert Drop Down. 

3. The Edit Drop Down Menu dialog opens.

4. Enter a Caption (the menu name), a popup key to quickly access the menu (this is optional), and a bitmap for an icon (if required) then click OK. The new menu name (Caption) appears in the menus.
5. You can now add commands to your new menu. See the Adding a Command to a Toolbar or Menu section for details.

Location of Customization Files

The files for your customizations are stored at: \Users\<ProfileName>\AppData\Roaming\Altium\Altium Designer <GUID>. These files are:

• UserTools.tlt
• DXP.rcs

System-Level Commands

On the Commands tab of the Customizing Editor dialog, [System Level] includes the commands to 'toggle floating panel visibility' and to toggle floating panel focus'. Any new commands added to this category will become system commands and their shortcut keys can be used in any editor.

Working with Shortcut Key Tables

A shortcut key table lists all the shortcuts currently available in an editor. Only one shortcut key table can be active per editor. As an example, Schematic Shortcuts is the name of the default shortcut key table for the schematic editor. If a shortcut key is changed in a command, it is updated in the active table automatically.

Shortcut key tables can be added, created, deleted, or modified in the same way as menus and toolbars.

Localization for Foreign Languages

Altium Designer supports several non-English language modes. All menu items and most dialog text will be presented in the language chosen in Windows for the computer on which Altium Designer is installed. Localization is configured on the System - General page of the Preferences dialog. After changing any of the Localization settings, you will need to restart Altium Designer.