# ListBox

## Шаблон ListBox <a href="#template_listbox" id="template_listbox"></a>

Перечень всех возможных тэгов объекта:

```xml
<MyObject Name="" Type="ListBox" Assembly="BaseControls" ChangeForm="">
  <!--Тэги, общие для всех графических объектов-->
  <Top></Top>
  <Bottom></Bottom>
  <Left></Left>
  <Right></Right>
  <Height></Height>
  <Width></Width>
  <FontStyle></FontStyle>
  <ForeColor></ForeColor>
  <BackColor></BackColor>
  <Enabled></Enabled>
  <Visible></Visible>
  <Opacity></Opacity>
  <Hint></Hint>
  <ContextMenu Name="" />
  <Change User="" Source="" ValueSet="" />
  <!--Тэги, специфичные для ListBox-->
  <Sorted></Sorted>
  <SelectionMode></SelectionMode>
  <NullValue Show="" Title="" />
  <ValueList>
    <DataConnection SourceDataConnection="">
      <Fields>
        <Field Name="" />
        <Field Name="" />
      </Fields>
    </DataConnection>
  </ValueList>
  <Value></Value>
</MyObject>
```

## Описание ListBox <a href="#description_listbox" id="description_listbox"></a>

```xml
<MyObject Name="ListBoxName" Type="ListBox" Assembly="BaseControls">
  <!--Тэги, общие для всех графических объектов-->
  <!--Тэги, специфичные для ListBox-->
</MyObject>
```

### Получение значения ListBox <a href="#get_value_listbox" id="get_value_listbox"></a>

Значением ListBox считается реальное (не отображаемое, а именно реальное) значение выбранного элемента из списка.

```xml
<Object Name="ListBoxName" />
```

### Задание значения ListBox <a href="#set_value_listbox" id="set_value_listbox"></a>

Значение объекта: любое значение.

```xml
<Object Name="ListBoxName"></Object>
```

## Тэги, специфичные для ListBox <a href="#tags_listbox" id="tags_listbox"></a>

### Sorted <a href="#sorted" id="sorted"></a>

Признак сортировки элементов списка по отображаемым значениям.

Необязательный тэг. Ожидается логическое значение.

По умолчанию используется значение False.

```xml
<Sorted>False</Sorted>
```

### SelectionMode <a href="#selection_mode" id="selection_mode"></a>

Название типа выбора элементов в списке.

Необязательный тэг. Ожидается название одного из типов выбора элементов в списке:

<table data-header-hidden><thead><tr><th align="center"></th><th width="443"></th></tr></thead><tbody><tr><td align="center">None</td><td>Выделение элементов запрещено</td></tr><tr><td align="center">One</td><td>Разрешено выделение только одного элемента</td></tr></tbody></table>

По умолчанию используется значение One.

```xml
<SelectionMode>One</SelectionMode>
```

### NullValue <a href="#null_value" id="null_value"></a>

Настройка отображения NULL-значения объекта.

Необязательный тэг. Значение тэга `<NullValue>`: не ожидается.

Если тэг `<NullValue>` отсутствует, то для атрибута `Show` используется значение False.

```xml
<NullValue Show="" Title="" />
```

#### Атрибуты тэга `<NullValue>` <a href="#attributes_tag_null_value" id="attributes_tag_null_value"></a>

<table data-header-hidden><thead><tr><th align="center"></th><th width="426"></th></tr></thead><tbody><tr><td align="center">Show</td><td><p>Признак, определяющий, будет ли в списке элемент, имеющий реальное значение NULL.</p><p></p><p>Необязательный атрибут. Ожидается логическое значение.</p><p></p><p>По умолчанию используется значение False.</p></td></tr><tr><td align="center">Title</td><td><p>Отображаемое значение элемента, имеющего реальное значение NULL.</p><p></p><p>Необязательный атрибут. Любое значение будет переведено в текстовое.</p><p></p><p>По умолчанию используется пустое значение.</p></td></tr></tbody></table>

### ValueList <a href="#value_list" id="value_list"></a>

Элементы списка.

Необязательный тэг. Ожидается таблица с одним, двумя или более столбцами (например, ссылка на [`GetDataConnection`](/workflow-mobile-forms-syntax/workflow_mobile_forms/dataconnections.md)).

Первое поле будет соответствовать реальному значению элемента, второе – его отображаемому значению (если второго поля нет, то отображаемое значение равно реальному).

Все остальные поля могут быть опционально использованы в выражениях для условного форматирования элементов списка.

```xml
<ValueList>
  <DataConnection SourceDataConnection="SourceDataConnectionName">
    <Fields>
      <Field Name="Field1Name" />
      <Field Name="Field2Name" />
    </Fields>
  </DataConnection>
</ValueList>
```

### Value <a href="#value" id="value"></a>

Значение, соответствующее реальному значению выделенного элемента.

Необязательный тэг. Значение тэга `<Value>`: любое значение.

```xml
<Value>Value</Value>
```

## Get-проперти для получения свойств <a href="#get_property_listbox" id="get_property_listbox"></a>

### Sorted <a href="#get_sorted" id="get_sorted"></a>

Возвращает признак сортировки элементов списка по отображаемым значениям.

```xml
<Object Name="ListBoxName">
  <Property Name="Sorted" />
</Object>
```

### SelectionMode <a href="#get_selection_mode" id="get_selection_mode"></a>

Возвращает название типа выбора элементов в списке.

```xml
<Object Name="ListBoxName">
  <Property Name="SelectionMode" />
</Object>
```

### Text <a href="#get_text" id="get_text"></a>

Возвращает отображаемое значение выбранного элемента.

```xml
<Object Name="ListBoxName">
  <Property Name="Text" />
</Object>
```

### ValueList <a href="#get_value_list" id="get_value_list"></a>

Возвращает элементы списка (таблица с двумя столбцами).

```xml
<Object Name="ListBoxName">
  <Property Name="ValueList" />
</Object>
```

## Set-проперти для динамического задания свойств <a href="#set_property_listbox" id="set_property_listbox"></a>

### Sorted <a href="#set_sorted" id="set_sorted"></a>

Задает признак сортировки элементов списка по отображаемым значениям.

Ожидается логическое значение.

```xml
<Object Name="ListBoxName">
  <Property Name="Sorted">True</Property>
</Object>
```

### SelectionMode <a href="#set_selection_mode" id="set_selection_mode"></a>

Задает название типа выбора элементов в списке.

Ожидается название одного из типов выбора элементов в списке.

```xml
<Object Name="ListBoxName">
  <Property Name="SelectionMode">MultiExtended</Property>
</Object>
```

### ValueList <a href="#set_value_list" id="set_value_list"></a>

Задает элементы списка.

Ожидается таблица с двумя столбцами (например, ссылка на [`GetDataConnection`](/workflow-mobile-forms-syntax/workflow_mobile_forms/dataconnections.md) с указанием двух его полей).

```xml
<Object Name="ComboBoxName">
  <Property Name="ValueList">
    <DataConnection SourceDataConnection="SourceDataConnectionName">
      <Fields>
        <Field Name="Field1Name" />
        <Field Name="Field2Name" />
      </Fields>
    </DataConnection>
  </Property>
</Object>
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wfsys.gitbook.io/workflow-mobile-forms-syntax/workflow_mobile_forms/objects/listbox.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
