# CheckedComboBox

## Шаблон CheckedComboBox <a href="#template" id="template"></a>

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

```xml
<MyObject Name="" Type="CheckedComboBox" 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>
  <Hint></Hint>
  <ContextMenu Name="" />
  <Change User="" Source="" ValueSet="" />
  <!--Тэги, специфичные для CheckedComboBox-->
  <DropDownHeight></DropDownHeight>
  <DropDownWidth></DropDownWidth>
  <ScrollWithWheel></ScrollWithWheel>
  <InputLanguage></InputLanguage>
  <InputCase></InputCase>
  <SearchMode Value="" />
  <Sorted></Sorted>
  <UpdateResult Type="" />
  <FlatStyle></FlatStyle>
  <NullValue Show="" Title="" />
  <NullValueTitle></NullValueTitle>
  <Formatting>
    <BackColor Name="">
      <Expression></Expression>
      <Items>
        <Item></Item>
        <Item></Item>
      </Items>
    </BackColor>
    <ForeColor Name="">
      <Expression></Expression>
      <Items>
        <Item></Item>
        <Item></Item>
      </Items>
    </ForeColor>
  </Formatting>
  <ValueList>
    <DataConnection SourceDataConnection="">
      <Fields>
        <Field Name="" />
        <Field Name="" />
      </Fields>
    </DataConnection>
  </ValueList>
  <Value></Value>
</MyObject>
```

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

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

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

Значением `<CheckedComboBox>` считается линейный массив выбранных элементов из списка.

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

### Задание значения <a href="#set-value" id="set-value"></a>

Значение объекта: любое значение (кроме NULL) будет преобразовано в линейный массив.

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

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

### DropDownHeight <a href="#drop_down_height" id="drop_down_height"></a>

Высота выпадающего списка.

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

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

```xml
<DropDownHeight>100</DropDownHeight>
```

### DropDownWidth <a href="#drop_down_width" id="drop_down_width"></a>

Ширина выпадающего списка.

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

По умолчанию используется значение ширины объекта.

```xml
<DropDownWidth>200</DropDownWidth>
```

### ScrollWithWheel <a href="#scroll_with_wheel" id="scroll_with_wheel"></a>

Признак, включающий или отключающий возможность изменять значение колесиком мышки.

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

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

```xml
<ScrollWithWheel>False</ScrollWithWheel>
```

### InputLanguage <a href="#input_language" id="input_language"></a>

Название языка для ограничения по вводимым символам.

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

<table data-header-hidden><thead><tr><th align="center"></th><th width="435.6666666666667"></th></tr></thead><tbody><tr><td align="center">Rus</td><td>Русский</td></tr><tr><td align="center">Eng</td><td>Английский</td></tr><tr><td align="center">None</td><td>Без ограничений по языку</td></tr></tbody></table>

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

Если язык вводимого символа не совпадает с языком, указанном в данном тэге, то этот символ будет трансформирован в символ другого языка, расположенный на этой же клавише на клавиатуре.

```xml
<InputLanguage>None</InputLanguage>
```

### InputCase <a href="#input_case" id="input_case"></a>

Название типа регистра для ограничения по вводимым символам.

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

<table data-header-hidden><thead><tr><th width="154.3434714210802" align="center"></th><th width="435.6666666666667"></th></tr></thead><tbody><tr><td align="center">Upper</td><td>Верхний регистр</td></tr><tr><td align="center">Lower</td><td>Нижний регистр</td></tr><tr><td align="center">None</td><td>Без ограничений по регистру</td></tr></tbody></table>

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

Если регистр вводимого символа не совпадает с регистром, указанном в данном тэге, то этот символ будет трансформирован в указанный регистр.

```xml
<InputCase>None</InputCase>
```

### SearchMode <a href="#search_mode" id="search_mode"></a>

Признак, определяющий, может ли пользователь искать элементы в списке с помощью ручного ввода текста.

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

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

```xml
<SearchMode Value="True" />
```

### Search

Признак, определяющий, тип поиска.

Необязательный тэг. Для обязательного атрибута `Type` ожидается название одного из типов:

<table data-header-hidden><thead><tr><th width="192.3434714210802" align="center"></th><th width="435.6666666666667"></th></tr></thead><tbody><tr><td align="center">VisibleChecked</td><td>только видимые элементы, которые автоматически отмечаются выбранными</td></tr><tr><td align="center">Checked</td><td>все выделенные элементы</td></tr></tbody></table>

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

```xml
<Search Type="VisibleChecked"/>
```

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

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

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

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

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

### UpdateResult <a href="#update_result" id="update_result"></a>

Способ изменения значения объекта.

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

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

```xml
<UpdateResult Type="OnHide" />
```

#### Атрибуты тэга \<UpdateResult> <a href="#attributes_tag_update_result" id="attributes_tag_update_result"></a>

<table data-header-hidden><thead><tr><th align="center"></th><th width="435.6666666666667"></th></tr></thead><tbody><tr><td align="center">Type</td><td><p>Название типа изменения значения объекта.</p><p></p><p>Обязательный атрибут. Ожидается название одного из <a href="#checkedcombobox_value_change_types">типов</a> изменения значения объекта.</p></td></tr></tbody></table>

#### Типы изменения значения объекта <a href="#checkedcombobox_value_change_types" id="checkedcombobox_value_change_types"></a>

<table data-header-hidden><thead><tr><th align="center"></th><th width="435.6666666666667"></th></tr></thead><tbody><tr><td align="center">OnHide</td><td>Изменение значения объекта происходит только после закрытия выпадающего списка.</td></tr><tr><td align="center">Always</td><td>Изменение значения объекта происходит мгновенно при любом изменении выбора хотя бы одного элемента из выпадающего списка, даже без его закрытия.</td></tr></tbody></table>

### FlatStyle <a href="#flat_style" id="flat_style"></a>

Название типа границ поля.

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

<table data-header-hidden><thead><tr><th align="center"></th><th width="435.6666666666667"></th></tr></thead><tbody><tr><td align="center">Flat</td><td>Плоское</td></tr><tr><td align="center">Popup</td><td>Плоское, пока не наведена мышь</td></tr><tr><td align="center">Standard</td><td>Обычное</td></tr><tr><td align="center">System</td><td>Определяется операционной системой</td></tr></tbody></table>

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

```xml
<FlatStyle>Standard</FlatStyle>
```

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

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

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

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

```xml
<NullValue Show="False" Title="[Все]" />
```

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

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

### NullValueTitle <a href="#null_value_title" id="null_value_title"></a>

Отображаемое значение элемента, по нажатию на который будут отмечены все остальные элементы в списке.

Необязательный тэг. Любое значение будет переведено в текстовое.

Если тэг `<NullValueTitle>` отсутствует, то используется пустое значение.

Игнорируется при наличии атрибута `Title` в тэге [`<NullValue>`](#nullvalue).

```xml
<NullValueTitle>[Все]</NullValueTitle>
```

### Formatting <a href="#formatting" id="formatting"></a>

Условное форматирование элементов выпадающего списка на основе значений хранящихся в них данных.

Необязательный тэг. Значение тэга `<Formatting>`: список тэгов [`<BackColor>`](#formatting_back_color) и [`<ForeColor>`](#formatting_fore_color).

```xml
<Formatting>
  <BackColor Name="BackColorName">
    <Expression>[0] > {0} * {1}</Expression>
    <Items>
      <Item>10</Item>
      <Item>20</Item>
    </Items>
  </BackColor>
  <ForeColor Name="ForeColorName">
    <Expression>[0] > {0} * {1}</Expression>
    <Items>
      <Item>10</Item>
      <Item>20</Item>
    </Items>
  </ForeColor>
</Formatting>
```

### Тэг \<BackColor> <a href="#formatting_back_color" id="formatting_back_color"></a>

Используется в тэге [`<Formatting>`](#formatting).

Условный цвет фона элемента списка. Необязательный тэг.

Значение тэга `<BackColor>`: не ожидается.

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

<table data-header-hidden><thead><tr><th width="150" align="center"></th><th width="434"></th></tr></thead><tbody><tr><td align="center">Name</td><td><p>Значение.</p><p></p><p>Обязательный атрибут. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb).</p></td></tr></tbody></table>

#### Тэг `<Expression>` <a href="#formatting_back_color_expression" id="formatting_back_color_expression"></a>

Выражение для вычисления, возвращающее логическое значение, на основе которого форматирование будет применено или нет.

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

Выражение для вычисления поддерживает переменные вида "\[N]", где N – порядковый номер столбца в таблице элементов списка (0 – реальное значение, 1 – отображаемое, 2-... – все остальные).

Выражение для вычисления поддерживает переменные вида "{N}" для подстановки значений (N+1)-ого элемента, то есть {0}, {1} и т.д.

Все поддерживаемые в выражении для вычисления конструкции смотрите по ссылке <https://ncalc.codeplex.com/wikipage?title=functions>.

#### Тэг `<Items>` <a href="#formatting_back_color_items" id="formatting_back_color_items"></a>

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

Необязательный тэг. Значение тэга `<Items>`: список тэгов [`<Item>`](#formatting_back_color_items_item).

#### Тэг `<Item>` <a href="#formatting_back_color_items_item" id="formatting_back_color_items_item"></a>

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

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

### Тэг `<ForeColor>` <a href="#formatting_fore_color" id="formatting_fore_color"></a>

Используется в тэге [`<Formatting>`](#formatting).

Условный цвет шрифта элемента списка.

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

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

<table data-header-hidden><thead><tr><th width="150" align="center"></th><th width="434"></th></tr></thead><tbody><tr><td align="center">Name</td><td><p>Значение.</p><p></p><p>Обязательный атрибут. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb).</p></td></tr></tbody></table>

#### Тэг `<Expression>` <a href="#formatting_fore_color_expression" id="formatting_fore_color_expression"></a>

Выражение для вычисления, возвращающее логическое значение, на основе которого форматирование будет применено или нет.

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

Выражение для вычисления поддерживает переменные вида "\[N]", где N – порядковый номер столбца в таблице элементов списка (0 – реальное значение, 1 – отображаемое, 2-... – все остальные).

Выражение для вычисления поддерживает переменные вида "{N}" для подстановки значений (N+1)-ого элемента, то есть {0}, {1} и т.д.

Все поддерживаемые в выражении для вычисления конструкции смотрите по ссылке <https://ncalc.codeplex.com/wikipage?title=functions>.

#### Тэг `<Items>` <a href="#formatting_fore_color_items" id="formatting_fore_color_items"></a>

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

Необязательный тэг. Значение тэга `<Items>`: список тэгов [`<Item>`](#formatting_fore_color_items_item).

#### Тэг `<Item>` <a href="#formatting_fore_color_items_item" id="formatting_fore_color_items_item"></a>

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

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

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

Элементы выпадающего списка.

Необязательный тэг. Ожидается таблица с одним, двумя или более столбцами (например, ссылка на [`GetDataConnection`](/workflow-forms-syntax/workflow_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>

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

Необязательный тэг. Любое значение (кроме NULL) будет преобразовано в линейный массив.

Если поле имеет значение NULL, то элементы в выпадающем списке будут отмечены в зависимости от значения атрибута `Show` тэга [`<NullValue>`](#null_value). Если атрибут `Show` равен True, то будут отмечены все элементы в списке, иначе - не будет выбран ни один.

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

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

### DropDownHeight <a href="#get_drop_down_height" id="get_drop_down_height"></a>

Возвращает высоту выпадающего списка.

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="DropDownHeight" />
</Object>
```

### DropDownWidth <a href="#get_drop_down_width" id="get_drop_down_width"></a>

Возвращает ширину выпадающего списка.

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="DropDownWidth" />
</Object>
```

### InputLanguage <a href="#get_input_language" id="get_input_language"></a>

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

```xml
<Object Name="TextBoxName">
  <Property Name="InputLanguage" />
</Object>
```

### InputCase <a href="#get_input_case" id="get_input_case"></a>

Возвращает название типа регистра для ограничения по вводимым символам.

```xml
<Object Name="TextBoxName">
  <Property Name="InputCase" />
</Object>
```

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

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

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

### FlatStyle <a href="#get_flat_style" id="get_flat_style"></a>

Возвращает название типа границ поля.

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="FlatStyle" />
</Object>
```

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

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

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

### ItemsCount <a href="#get_items_count" id="get_items_count"></a>

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

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="ItemsCount" />
</Object>
```

### SelectedItemsCount <a href="#get_selected_items_count" id="get_selected_items_count"></a>

Возвращает количество выбранных элементов в списке.&#x20;

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="SelectedItemsCount" />
</Object>
```

### VisibleText <a href="#get_visible_text" id="get_visible_text"></a>

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

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="VisibleText" />
</Object>
```

### VisibleTextDelimeter <a href="#get_visible_text_delimeter" id="get_visible_text_delimeter"></a>

Возвращает текстовый список выбранных элементов с заданным разделителем.&#x20;

```xml
<Object Name="CheckedComboBoxName">
  <!--Значение тэга Property: тэг Parameters со вложенными тэгами Parameter-->
  <Property Name="VisibleTextDelimeter" >
    <Parameters>
      <!--Значение тэга Parameter с атрибутом Name, равным Delimeter: ожидается символ или строка, которая будет использоваться как разделитель в выводимом списке выбранных элементов-->
      <Parameter Name="Delimeter">\r</Parameter>
    </Parameters>
  </Property>
</Object>
```

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

### DropDownHeight <a href="#set_drop_down_height" id="set_drop_down_height"></a>

Задает высоту выпадающего списка.

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

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="DropDownHeight">400</Property>
</Object>
```

### DropDownWidth <a href="#set_drop_down_width" id="set_drop_down_width"></a>

Задает ширину выпадающего списка.

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

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="DropDownWidth">300</Property>
</Object>
```

### InputLanguage <a href="#set_input_language" id="set_input_language"></a>

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

Ожидается один из языков.

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="InputLanguage">Rus</Property>
</Object>
```

### InputCase <a href="#set_input_case" id="set_input_case"></a>

Задает название типа регистра для ограничения по вводимым символам.

Ожидается один из типов регистров.

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="InputCase">Lower</Property>
</Object>
```

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

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

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

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

### FlatStyle <a href="#set_flat_style" id="set_flat_style"></a>

Задает название типа границ поля.

Ожидается одно из названий типов границ поля.

```xml
<Object Name="CheckedComboBoxName">
  <Property Name="FlatStyle">Popup</Property>
</Object>
```

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

Задает элементы выпадающего списка.

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

```xml
<Object Name="CheckedComboBoxName">
  <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-forms-syntax/workflow_forms/objects/checkedcombobox.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.
