Skip to main content

Command: Customizable Toolbox

Symbol: _cds_icon_customizable_toolbox.png

Function: The command opens the Customizable Toolbox view.

Call: View menu

Requirement: The implementation language of the created POU must be Structured Text (ST).

The command opens the Customizable Toolbox view. This customizable toolbox allows you to configure the provided items and contents according to your requirements.

In the Customizable Toolbox view, you can manage a set of items which meet specific demands. Depending on the use case, various storage locations are available.

The items contained in the toolbox can be inserted either by drag-and-drop or by double-clicking at the current cursor position in the editor. An item can be inserted into the implementation section as well as the declaration section of the editor.

The items and folders of the customizable toolbox can be individually arranged via drag-and-drop.

Table 83.

_cds_icon_customizable_toolbox.png

Opens a menu with the following options:

Save Current Items

Saves the currently customized items.

Choose Location:

  • user options: The customized toolbox is saved in the user options of the current CODESYS installation.

  • project: The customized toolbox is saved in an option file next to the currently edited project. This configuration will be reloaded when you open the respective project. This view of the Customizable Toolbox is available in this project only.

  • file: The Customizable Toolbox will be saved as a .json file. You can specify the storage location and name in the file dialog. The cas_icon_three_dots.png button opens the Choose File dialog.

Load Items

Loads items from an existing tool configuration.

Choose Location:

  • user options: Loads entries from an existing tool configuration in the user options.

  • project: Loads items from an existing tool configuration which are assigned to a project.

  • file: Loads items from a previously saved configuration as a .json file. In the Choose File dialog, you can click the cas_icon_three_dots.png button to call the storage location from which the file can be loaded.

Restore Default Items

Restores the default view of the toolbox. All items which exist by default will be displayed.

All existing items and folders in the configuration will be replaced by the default view.

Insert Selected Item

Inserts the item selected from the toolbox at the current cursor position.

Create New Item from Selection

Creates a new item from a selected expression under Customizable Toolbox.

A new item can be inserted at the top level, directly below a folder, or as a child of an existing item.

Create New Item from Selection:

  • Name: Name of the new item

  • Description: Sets a description for the new item. The text will be displayed in the Information field when the respective item is selected.

  • Shortcut key: (optional) Specifies a single character for this item which can be used with quick insert mode. The character must be unique within the configuration.

  • Parent: Superordinate item under which the new item will be inserted.

  • Immediate AutoDeclare: The check box activates the Auto Declare dialog. The dialog opens automatically after an item has been inserted into the editor by the Insert Selected Item command. The program attempts to declare the variables contained in the inserted code.

Create Folder

Creates a folder in the Customizable Toolbox view.

Existing items can be moved into the folder via drag-and-drop.

Edit Selected Item

Provides the capability to edit a selected item.

Edit Item:

  • Name: Name of the item

  • Description: Sets a description for the new item. The text will be displayed in the Information field when the respective item is selected.

  • Shortcut key: (optional) Specifies a single character for this item which can be used with quick insert mode. The character must be unique within the configuration.

  • Immediate AutoDeclare: The check box activates the Auto Declare dialog. The dialog opens automatically after an item has been inserted into the editor by the Insert Selected Item command. The program attempts to declare the variables contained in the inserted code.