One Category
More Than One Category
When you first create a new component, a default category called Configuration will be created for you. Categories are shown in the WYSIWYG display, but only if there are more than one. Therefore, the Configuration category will not initially be visible, as there is only one category. Once a second category is added, the tree will appear:
|
|
|
One Category |
|
More Than One Category |
The Configuration category will possess a single default parameter field called Name. Name is used for display in the workspace secondary window, if the component is a module. It can also be used for identification of the component when scripting with Python.
To add a new category page to your component definition, simply click the Add Category button in the ribbon control bar:
Or, once multiple categories have been added, right-click over the categories tree and select Add Category.
In either case, a new category page will appear with default name Untitled as shown below.
An editor is also provided for limited management of categories. To invoke, left-click the WYSIWYG display and click the '...' button on the Categories property.
|
|
|
Invoke Via Categories Property |
|
Category Editor |
To adjust category properties, first ensure that the category is in focus (selected). The properties form will display all category related attributes.
|
|
|
Properties Form |
|
Selected Category |
Appearance:
Level: Display only. Shows the current indent level of the selected category. See Setting Category Level below.
Name: Enter a descriptive name for the category.
Behaviour:
Condition: Enter a expression (optional) to determine under what input conditions the category is to be enabled (the default is true). If a category is disabled, the user will still be able to view the contents, but all input fields within it will be disabled. See Expressions Statements and Operators for more details.
Visible: Visibility option for the category. If the Condition statement is false, this property controls whether or not the disabled category will be visible. If true, then the category will appear in a disabled state. If false, the disabled category will be invisible.
Data:
Index: Display Only. Shows the unique index number of the category. This is a sequential number starting from 0, which represents order number of the category in the tree. For example, the fifth category in the list will have an index number of 4.
Layout:
Splitter Position (%): Controls the position of the parameter form splitter bar for all parameters in this category. Note that this splitter position can be adjusted manually (left-click and hold over the splitter bar). The default position for new parameters may be set in the parameter form properties.
Once you have added more than one category, there will of course be a need to navigate through them. In the category tree, simply left-click on the desired category page to view its properties and content.
Once you have added more than one category, there may be a need to re-order their sequence. To move a category up or down, select the category and press the associated button in the ribbon control bar:
Or, select a category page, right-click and select one of the Move options:
Categories may be indented to create a second dimension of organization in the category tree. Indented categories help to encapsulate and organize like data.
To indent or outdent a category, select the category and press the associated button in the ribbon control bar:
Or, right-click on the category and select Increase Indent or Decrease Indent:
Category pages are duplicated by simply copying and pasting them in the categories tree. Select the desired category in the tree, right-click and select Copy (or press Ctrl + c). Paste the category: Right-click on the categories tree and select Paste (or press Ctrl + v).
|
|
|
Copy |
|
Paste |
A new category page will appear in the tree with a number appended to the copied category name. You may rename the category as described in Changing Category Properties above.
To delete a category, select it in the categories tree and either: Click the Delete button in the ribbon control bar, press the Delete key on your keyboard, or right-click and select Delete.
