Creating Custom Classes

In the object navigator one can work with built-in object types and additional objects of custom classes.

One can work with custom classes on the Custom Metadata > Object Classes tab in the Parameters dialog box.

NOTE. Work with custom classes is available for the users included in the ADMINISTRATORS group.

In the web application select the Parameters item on the side panel of the object navigator.
In the desktop application select the Tools > Parameters item in the object navigator's main menu.

To add a custom class, execute one of the operations:

In the web application click the Add button.
In the desktop application:

Click the Add button.
Select the Add item in the context menu of the list of classes.

After executing one of the operations opens the Class <class name> dialog box opens:

Set class description.
Add images that will be displayed in the object navigator on creating custom class objects.
Set up operations that will be available for custom class objects and set their handlers.

To edit a class, execute one of the operations:

In the web application:

Select the class and click the Edit button.
Double-click the class.

In the desktop application:

Select the class and click the Edit button.
Select the Edit item in the class's context menu.
Double-click the class.

After executing one of the operations the Class <class name> dialog box opens. Change class parameters specified on class creation.

To delete the class:

Select one or several classes while holding down the CTRL or SHIFT key.
Execute one of the operations:

In the web application click the Delete button.
In the desktop application:

Click the Delete button.
Select the Delete item in the class's context menu.

After executing the operations the deletion confirmation dialog box opens. If the answer is positive, the selected classes are deleted.

To store images and localize information about custom classes to different languages, use the Resources object:

In the web application select the existing resource in the Resources drop-down list.

To quickly search for the Resources object in the repository, use the search string. Depending on the object display settings, enter name, identifier, or key of the searched object into the search string. Search is executed automatically as the searched text is entered into the search string. The list will display the objects, which names/identifiers/keys contain the entered text. To clear the search string, click the Clear button or press the BACKSPACE key.

To set up displaying of repository objects on the side panel, click the Show Object button and select display option in the drop-down menu:

Name. Objects are displayed with their names. Default option.
Identifier. Objects are displayed with their identifiers.
Key. Objects are displayed with their keys.

Several options can be selected. Identifier and key will be specified in brackets.

In the desktop application:

Select the existing resource in the Resources drop-down list.
Create a new resource using the Create New button.

In the desktop application click the Open button to open the selected resource.

The following information is saved in the resource:

Class names.
Class description.
Names of operations created for classes.
Two groups of images: 16*16 and 32*32.

If required, in each class settings determine proper resources that store information only about the class.

Resources identifiers:

String resources with the CLSNAME<class number> identifier will be created for class names, for example, CLSNAME1.
String resources with the CLSDESCR<class number> identifier will be created for class descriptions, for example, CLSDESCR1.
String resources with the CLS<class number>OP<operation number> identifier will be created for class operations, for example, CLS1OP2.
Collections of small and large images will be stored in graphic resources with the <custom class container identifier>SMALLICON and <custom class container identifier>LARGEICON respectively.

NOTE. After the Resources object is specified, string resources and icons for all existing classes are created automatically. Current names and descriptions are applied to default language.

NOTE. It is available only in the desktop application. To add custom class images in the web application, use the Image tab in the <class name> Class dialog box.

To add images in the custom class list:

Make sure that the resource is selected in the Resources drop-down list.
Click the Small or Large button depending on image size.

After executing the operations the ImageList Editor dialog box opens. Create a collection of small and large icons that can be used during custom class setup on the Description tab in the<class name> Class dialog box. Indexes of large and small icons should be equal. The added images are stored in the selected resource.