Reference (Control)
You can use the Reference control to specify a reference in a form. The control consists of a label, a text box for the display, and a button that opens a selection dialog box to select the reference.
Click Reference on the left side of the toolbar and drag the control into the dialog. Once the control is placed, the properties open on the right.
Properties
Frequently used
This category displays frequently used controls, properties, and options for each control. You cannot edit the category.
General
Relationship
Property | Specify a user-defined relationship. The relationship is a directional relationship that points from one element to another. You define the relationship in the stereotype that you specified when you created the form. |
Selection dialog | Here you can specify a query that is displayed in the selection dialog box when you assign a reference in the form. If you do not specify a query, the standard selection dialog is used. |
Enabled
This determines whether the Reference can be edited or is only visible. The option is selected by default. If the Reference is deactivated, it is not displayed.
Navigation type
If you have selected the Navigation visible option, you can use the dropdown menu to select where you want to navigate. You can choose between Show definition, Open and Open VS Code.
Navigation visible
This determines whether the button is displayed that you can use in the form, for example, to jump to the storage location of the reference.
Select visible
Use this to specify whether the […] button for selecting a reference is to be displayed or not. By default, the option is highlighted.
Label
You can place labels on the left, right, above or below an Reference. It is also possible to specify more than one label. Labels that you want to display must be made visible. Depending on where you want to place a label, you must click on the arrow behind Bottom, Left, Right, Top to display further properties for the label.
Alignment (horizontal) | Determines the text alignment within the control. The text can be Left, Right, or Center. |
Alignment (vertical) | Determines the text alignment within the control. The text can be aligned up, down, or centered. |
Label | Here you enter a label, which is displayed to you as a name in the form. The label can be created in two languages. You can also specify whether the label is displayed in bold, italic, or bold and italic. |
Bold/ italic | Here you can format the text that you have entered under Label/ Label. |
Visibility | Use the dropdown menu to select whether the label should be Visible, Hidden, or Collapsed. |
Visible | The label entered is displayed. |
Hidden | The label entered is not displayed. The space occupied by the label remains. |
Collapsed | The entered label is not displayed. The space occupied by the label is also not displayed. |
Layout
Alignment
Here you determine how the Reference should take its place horizontally or vertically within the container (blue frame).
Horizontal | |
Left | The Reference is aligned to the left. |
Right | The Reference is aligned to the right. |
Center | The Reference is aligned in the middle. |
Fill | The Reference occupies the entire available space. |
Vertical | If you want to make settings for vertical alignment, you must set the value under Cell/ Vertical to Fill. If you select Auto, no vertical alignment will be displayed. |
Top | The Reference is aligned under the previous item. |
Bottom | The Reference is aligned at the bottom. |
Center | The Reference is aligned in the middle. |
Fill | The Reference occupies the entire available space. |
Cell
Here you determine how much space the Reference should occupy horizontally or vertically.
Auto | The Reference occupies the minimum available space. |
Fill | The Reference occupies the maximum available space. |
Size
Calculation Using the dropdown menu, select whether the values entered – which are entered under Width and Height – refer exclusively to the control or whether the label should be included in the calculation.
Height/ Width Here you can enter values for height and width in px. If the fields remain empty, the width and height are calculated automatically. The width is calculated from the actual available space.
Display
Visible Use the check box to specify whether the Reference should be displayed or hidden in the form. The space occupied by the image remains.
Miscellaneous
Tooltip Here you can enter a tooltip that is displayed as soon as you move over the Reference in the dialog. The tooltip can be created bilingually.