The properties of the Combo Box widget are:

Property

Description

Optionality

Default value

Obs.

Name

Name of the widget used in the screen scope.

Optional

When the widget is implicitly created by dragging an attribute or entity into an Edit Record, this property will be set by default to <entity_name>_<attribute_name>, for example Customer_Class.

In any other case it's empty by default.

Although optional, only named widgets are available in the scope of the screen or web block. Only then you can use their runtime properties.

See rules for naming elements.

Variable

 

Variable that holds the end-user selection. This variable can be loaded with a default value set in the Preparation action.

 

The variable must be of the type referenced by SourceEntity. You can type the name of the variable directly or use the Select Variable window.

Optional

 

Mandatory only if Source Entity/Structure is specified.

 

If the end-user selects a value that is not among the Entity/Structure list of values, i.e., selects a value among the Special List values, this property has the Null Identifier value.

Validation Parent

 

Allows you to bind a Combo Box widget to a specific Edit Record widget.

 

You can select the Edit Record from a drop-down list of the Edit Record widgets currently placed in the screen or screen block.

Optional

When the Combo Box widget is directly dragged into, for example, the EditRecord1 widget or implicitly created by dragging an attribute into EditRecord1, this property will be set by default to EditRecord1.

In any other case it's empty by default.

Specifying this property will place the Combo Box widget inside the Edit Record widget, in the screen's Scope Tree.

Mandatory

Boolean expression that allows you to specify whether the end-user must provide a value to the variable associated with this widget.

 

You can directly type the values true or false, select a variable that handles this (if the variable is not of type Boolean, an error message is presented and the module is not valid), or use the Expression editor.

Mandatory

When the Combo Box widget is implicitly created by dragging an attribute or entity into an Edit Record, this property will be set accordingly with the attribute's Is Mandatory property.

In any other case it's False by default.

If this property is True, the Mandatory special class is added to the  <select> HTML tag that corresponds to this widget. Learn more about how Web widgets are translated into HTML tags.

Source Record List

List used to populate the options of the widget when the screen is rendered.

Optional

 

This property is only relevant when you do not want to display all the entity occurrences: You want to apply filters, which means design your own aggregate or advanced query to retrieve them.

Source Entity/Structure

Name of the entity or structure whose attribute you want to display. When this property is different from “(none)”, a list is produced to populate the options of the widget. If no Source Record List is specified, this widget is populated with all the rows for Source Entity/Structure.

Optional

(none)

This property must be used whenever you want to display the rows (all or some) of an entity. The only situation where you can leave it empty is when you only need the Special List values in the list.

Source Attribute

Name of the attribute of the Source Entity/Structure. This attribute holds to the values presented in the widget.

Optional

 

Mandatory only when Source Entity/Structure is specified.

In this case you have to indicate what attribute is selected from that entity.

Source Identifier Attribute

Name of the structure identifier attribute to pair the identifier with the value held by the Variable.

Optional

 

Mandatory when the property Source Entity/Structure is a structure.

Special Variable

Name of the variable that collects the user selection from the Special List on submitting.

 

If the variable already has a value, the corresponding row is selected by default. You can type the name of the variable directly or use the Select Variable window. The variable must be of type Text, Phone Number, Email, Boolean, Integer, or Long Integer; if not, an error message is presented and the module is not valid.

Optional

 

Only relevant if you are using a Special List.

 

During runtime, if the end-user selects a value that is not among the Special List values, i.e., selects a value among the Source Entity/Structure list of values, this property has the value "".

Width

Indicates the width of the widget. You can change the width by editing this property or by resizing it using the Grid in the Content Canvas.

Optional

3 col

The value of this property can be in columns, pixels, points, or percentage.

Margin Left

Indicates the width of the left margin of the widget.

This value can be automatically set by the Grid.

Optional

Auto

The value of this property can be in pixels, points, or percentage.

If not defined and the widget style defines a margin-left then this margin is applied to the widget.

Margin Top

Indicates the height of the top margin of the widget.

This value can be automatically set by the Grid.

Optional

Auto

The value of this property can be in pixels or points.

If Auto is selected and the widget style defines a margin-top then this margin is applied to the widget.

Style

Drop-down list with the styles that can be applied to the combo box.

Optional

 

Learn more About Style Sheets.

Double-click on the property and the Style Sheet Editor is opened with the current style already selected.

Visible

When this property is false, the HTML page, generated at runtime, does not include the HTML tag that corresponds to this widget.

Mandatory

True

You can directly type the values true or false, select a variable that handles this (if the variable is not of type Boolean, an error message is presented and the eSpace is not valid), or use the Expression editor.

Enabled

Allows you to specify whether the end-user can edit the value of the variable associated with this widget. When this property is set to false, the end-user can see and select, but not change, the value of the variable.

 

You can directly type the values true or false, select a variable that handles this (if the variable is not of type Boolean, an error message is presented and the module is not valid), or use the Expression editor.

Mandatory

True

If this property is false, the disabled attribute is added to the <select> HTML tag that corresponds to this widget. Learn more about how widgets are translated into HTML tags.

Special List

Options displayed, at run-time, at the beginning of the drop-down list, using the order specified. Examples: All, None, Today, Every Week, etc.

Property Description Optionality Default value

Obs.

Value

Value that is assigned at the internal variable SpecialListValue associated to the drop-down list.

NA

 

 

Option

Text displayed at run-time.

NA

 

 

On Change

Grouped properties in the context of changing the value of the widget.

Property Description Optionality Default value

Obs.

Destination

A list of possible screen actions created for the current screen is displayed sorted by name. Simply choose one of them.

Optional

 

The screen action will be called using Ajax. Learn more about rich screens using Ajax.

Destination Arguments

The list of arguments that corresponds to the input parameters of the screen action. The values of the parameters must be of the same type as the input parameters.

NA

NA

The argument is mandatory or optional, if the parameter in the destination screen is respectively mandatory or optional.

Extended Properties

Additional properties for attributes and/or events that implement specific behaviors of your widget.

Property Description Optionality Default value

Obs.

Name

Name of the attribute that the HTML element can accept as specified in the HTML language reference.

NA

 

This property is added to the <select> HTML tag that corresponds to this widget.

Learn more about Extending Properties and how widgets are translated into HTML tags.

Value

The value for the attribute.

NA

 

This property is added to the <select> HTML tag that corresponds to this widget.

Learn more about Extending Properties and how widgets are translated into HTML tags.

See Also

About Combo Box Widget