When creating a User-Coded Model (UCM) or a Subcircuit , HYPERSIM will display a default form when double clicking the component in the schematic. The Form Editor allows to create a Custom View to better organize the form of the component. The default custom view file name for a component is CustomView_{BlockName}.xml.

While the Subcircuit configuration allows to customize the name of the custom view file, it is recommended to keep the default name, to improve the coherence of the file system.

Saving a form Custom View

In order to edit the view of a component, its xml file must first be generated. For eligible components, one can right click in the regular component form.

Once saved, the view will be put under the _hyp folder of the project, inside a subfolder view. This means that the custom view is available only for the model. The custom views are searched for in that order, the most specific one will be loaded upon opening the form.

Location	Scope	Notes

Location	Scope	Notes
${HYP_FOLDER}\view	Project only	Will be exported with the model
${USER_HOME}\HYPERSIM\view	User only, all projects	Will not be exported with the model by default
${HYPERSIM_DIR}\Windows\Hyperworks\data\view	All users, all projects	Should not be edited manually, but can be overridden if required.
Installation binaries	All users, all projects	Cannot be edited

Editing the form

This documentation uses the Examples | Distribution Connected Battery Energy Storage System with Average Converter model as example.

After saving the layout, the layout can be edited showing the following view :

1 : The form editor tabs enable to switch between the widget view, which displays the final layout of the component, and the parameter view, which lists all available parameters in the component.
2 : The tree view shows the Custom View structure. Each tab is made of a grid, in which Widgets are inserted and linked to the parameters of the block.
3 : The form preview shows the current result of the Custom View. The grid can be shown or hidden from the View menu at the top of the window. When a widget is being edited, it will be blinking in the preview.
4 : The property menu shows the configuration of the currently selected structure element.

Form editor tabs

The Widget tab is the main window where the custom view is edited.

The Parameters tab shows a list of all parameters available in the component.

If a parameter is not yet controllable in the custom view, it will be shown in red. Right clicking will allow to add a widget in a specific location in the custom view.
If a parameter is already controllable in the custom view, a right click Locate option is available, to quickly access its widget.

Tree view structure

The tree view shows 4 layer of depths, eaching offering right click context menu options.

Component level : showing the component category as title, it allows to control the default dimensions of the windows.
Tab level : For each tab, the name and number of columns can be edited.
- Note : If the custom view has only 1 tab, it may be displayed as __UNKNOWN__, as this title will not be visible when opening the component form
Column level : From this level, cosmetic widgets may be inserted.
Widget level : From this level, rows can be added in the grid, and the widget may be located, deleted or moved to another location.

Form preview

This scene displays the current result of the custom view.

Note : While this view allows to edit the textfield values, and change units as a regular component form would, the result cannot be applied onto the component, it is simply a preview of the behavior.

Property menu

The list of each property of the selected item is visible in this panel. The options for the component, tabs and columns are minimal and self explanatory.

When selecting a widget, we see 3 category of controls

The shared properties. The first properties are identical for each widget, cosmetic or applicative, such as WidgetType, Tab, Positions, Sizes.
Custom properties. Each widget can carry a set of optional properties, which customizes its behavior. for example a textfield may be read only, or web component may control the path to its image.
Widget moving controls. Buttons Up, Down, Left, Right allow to move the widget in the view