User interface form properties
| Property | Meaning | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Form name |
The form name is used to quickly select interface forms, for example, in the Designer.
| ||||||||||
| Form definition |
Form definition linked to the user interface form.
| ||||||||||
| Caption | Caption shown on the user interface form. The caption is used to represent the user interface form in the task view and in the form context menu of the user interface. Translate the given text using the  button. | ||||||||||
| Online help link | The form's help key for navigating to the relevant chapter in the online help. | ||||||||||
| Description |
Detailed description of the user interface form.
| ||||||||||
| Icon | Icon marks the user interface form in the user interface. | ||||||||||
| Sort order |
The sort order determines the position of the interface form in the task view and in the form’s context menu in the administration tools.
| ||||||||||
| Preprocessor condition |
User interface forms can be given a preprocessor condition. This means that an interface form is only available when the preprocessor condition is fulfilled.
| ||||||||||
| Control deactivation |
Specifies which buttons in the toolbar are to be disabled in the front-ends
| ||||||||||
| Disabled |
Use this option to label interface forms that should not be shown in the user interface.
| ||||||||||
| Disabled by preprocessor | If an object definition is excluded through a preprocessor condition, this option is set by the Database Compiler. | ||||||||||
| Show modal | Specifies whether the form is displayed in a separate dialog box. Used by wizards for entering data. | ||||||||||
| Open on new tab | The form is opened on a new tab. | ||||||||||
| Configuration |
The configuration is used to limit the tables and columns on display. Templates for the configuration data definition are found in the pop-up list XML templates. In the SpecialSheetData section, you can transfer special properties implemented during form development to the interface form. For example, the report name and special report parameters can be passed to the report interface form by using this section. In the Properties section, you can transfer special properties of the form that were implemented during form development. | ||||||||||
| Insert values | Insert values are only of relevance to interface forms of the Edit form type. With them you can specify the default values for the columns that are assigned when a new object is added. The input is in VB.Net syntax. |
is grayed out.
is grayed out.
is grayed out.Related Topics
- Form definitions and form templates
- Hierarchical display of data on assignment forms
- Defining insert values
- Conditional compilation using preprocessor conditions
Form definitions and form templates
Form definitions and form templates make up the basis of interface form design. Form definitions contain information about the data that will appear in the forms, for example, tables and columns as well as titles for form tabs and root nodes in hierarchically ordered elements (ChildRelationControl, membership tree) for the form templates defined in the form archives (Forms.*.vif).
Detailed information about this topic
- Form templates
- Form definitions
- Configuration data for displaying many-to-many and object relations on forms
Form templates
All form templates are found in User interface | Forms | Form templates in Designer. It is not usually necessary to define your own form templates.
To display a form template for a user interface form
- In Designer, select User interface | Forms | User interface forms.
- Select the user interface form in the Form Editor.
- In the edit view in Properties, select the Form template tab.
| Property | Meaning | ||
|---|---|---|---|
| Form source type |
Source of the form template. Permitted values are:
| ||
| Assembly name | Name of the assembly file. | ||
| Class | Full type name of the control. | ||
| Form template name |
The form template name is necessary for loading the form template from the form archive.
| ||
| Form archive | Name of the form archive (Forms.*.vif), containing the form template. | ||
| Description | Detailed description of the form template. | ||
| Alternative form template |
It might be necessary to use different form templates of display the interface form, for example, to show an the One Identity Manager web interface or in an administration tool. The form templates can be linked in order to avoid adding a form definition and an interface form for each form template. For this, you need to assign an alternative form template to the form template. This alternative form template is used when the conditions for displaying the original template are not fulfilled. The form template referenced is determined in order to display the interface form. The form template given in the form definition is checked for existence in the form archive and to see if it labeled for the correct display purposes. If these conditions are not fulfilled then the alternative form template is tested for suitability. The form template that fulfills the conditions is used for the user interface display. | ||
| Form type | Type of form. | ||
| Enabled for |
This property specifies the intended use of the form template. Permitted values are:
|
| Form type | Usage |
|---|---|
| Info (I) | Forms of the Info type are only used to display information. Changes to data on these forms cannot be saved. These forms automatically omitted by the automatic form selection in quick edit mode. |
| Edit (E) | Forms of the Edit type are used to edit data. This is the first form to be loaded by the automatic form selection in quick edit mode. |
| Grid (G) | Forms of the Grid type are used to display data in tabular form. |
| MemberRelation (M)) | Forms of the MemberRelation type are used to display the data in an assignment list (many-to-many relations). |
| Report (R) | Forms of the Report type are used to display data in a report form. |
| Virtual (V) |
Forms of the Virtual type are not available in the forms menu. This form type is used to show editors in the Designer. |
| Wizard (W) | Forms of the Wizard type are used to enter data by means of a wizard. The forms are displayed in a modal dialog window. |
Related Topics
Form definitions
The form definitions are found in Designer under User interface | Forms | Form definitions. It is not normally necessary to define your own form definitions.
To display a form template for a user interface form
- In Designer, select User interface | Forms | User interface forms.
- Select the user interface form in the Form Editor.
- In the edit view in Properties, select the Form definition tab.
| Property | Meaning | ||
|---|---|---|---|
| Form definition name | Name of the form definition. This name is used for displaying the form definition in the Designer. | ||
| Form template | Name of the form template to load from the form archive. A form template can be used by several form definitions, such as the form templates for displaying membership trees or the form template for displaying reports. Use the  button next to the input field to integrate a new form template in the form definition. | ||
| Base form for form sequence | By entering a form definition as a base for a sequence of forms, you can create a group of form definitions for one object definition. All form sequence form definitions contain the same base form. The definition of the interface form can only be made for this base form. When the interface form is loaded in the display, the referenced form definitions for all other form definitions in the form sequence are also loaded. You can navigate arbitrarily within the form sequence without leaving the scope of the interface form. | ||
| Description | Detailed description of the form. | ||
| Configuration | The configuration data is used to describe the form properties. The definition of the form properties is written in XML notation. | ||
| Required tables |
A form definition can be assigned additional tables that are used to display data.
|