Create Combo Boxes

XML Forms Guide

Version
R2024.1.1
Create Combo Boxes

When you create a combo box, you define the source of the combo box options and the data class to be updated by the user. You can also filter the combo box to display only certain items.

Copy
<Field>
    <Style>IVComboBox</Style>
    <Block>n</Block>
    <Row>n</Row>
    <Column>n</Column>
    <BindingProperty>data_class</BindingProperty>
    <DataProvider>data_class</DataProvider>
    <DisplayMemberPath>value_set</DisplayMemberPath>
    <SelectedValuePath>identifier</SelectedValuePath>
    <Filter>
        <FieldName>field</FieldName>
        <FieldValue>value1;value2</FieldValue>
    </Filter>
    <IsRequired>True/False</IsRequired>
    <IsReadOnly>True/False</IsReadOnly>
    <InitialValue>value</InitialValue>
    <Visible>True/False</Visible>
    <DisplayName>label</DisplayName>
    <ColumnSpan>n</ColumnSpan>
</Field>

The <DataProvider> tag identifies the data source of the combo box options, while <DisplayMemberPath> defines which set of values should be displayed within the combo box. The <SelectedValuePath> identifies the value to be stored when the user makes a selection.

Within the <Filter> tag, the <FieldName> tag identifies the field being filtered, and the <FieldValue> identifies one or more values to be included in the list.

To filter a combo box so that only specific values are shown, define the <FieldValue> properties, and separate each value with a semicolon. For example:

Copy
<Filter>
    <FieldName>field</FieldName>
    <FieldValue>value1;value2;value5</FieldValue>
</Filter>