CheckedImageListBoxConfiguration
The items and the look of the list that drops down from a MultiSelectableCheckedImageListCombobox.
public sealed class CheckedImageListBoxConfiguration
Remarks
Reach it through MultiSelectableCheckedImageListCombobox.MultiSelectableCheckedImageListBoxConfiguration,
or assign a new one. Every setting is copied to the drop-down list – a CheckedImageListBox – each
time the drop-down opens, so a change shows from the next open.
The settings are those of CheckedImageListBox, where each is described in full. The defaults
here are the combo box's own: a warm scheme of browns, salmon and wheat, with check-on-click on.
Examples
CheckedImageListBoxConfiguration list = toppings.MultiSelectableCheckedImageListBoxConfiguration;
list.Items.Add(new CheckedImageListBoxItem { Title = "Mushrooms", ContentText = "Chestnut, sliced" });
list.Items.Add(new CheckedImageListBoxItem { Title = "Olives", ContentText = "Kalamata, pitted" });
list.ItemSelectedStartColor = Color.LightSteelBlue;
list.ItemUnselectedStartColor = Color.WhiteSmoke;Members at a glance
| Constructors | |
|---|---|
CheckedImageListBoxConfiguration | Creates a configuration with no items and the combo box's default look. |
| Properties | |
AnnotationImageOnMouseHover | Gets or sets the image shown at the right end of the item under the pointer. |
BackColor | Gets or sets the background colour of the drop-down list, seen below the last item and between items. |
CheckBoxSize | Gets or sets the space reserved for an item's check box, and the size of a classic check box. |
CheckOnClick | Gets or sets whether a single click on an item toggles its check box. |
CheckedStateImage | Gets or sets the image shown for a checked item when check states are drawn as images. |
ContentStringFormat | Gets or sets the content string format. |
IsAnnotationEnabled | Gets or sets whether AnnotationImageOnMouseHover is shown at the right end of the item
under the pointer. |
IsImageDrawnWhenUsingDefaultItemTooltip | Gets or sets whether the control's own tool tip shows an information icon beside its title. |
IsItemCheckUncheckAllowed | Gets or sets a value indicating whether the control allows the user to check/uncheck items. |
IsItemSidebarBorderDrawingEnabled | Gets or sets whether the sidebar strip (see IsItemSidebarDrawingEnabled) has an outline. |
IsItemSidebarDrawingEnabled | Gets or sets whether a coloured strip is drawn down the left of the selected item and of the item under the pointer. |
IsReadOnly | Gets or sets whether the list is for looking only: it can be scrolled, but not selected or checked. |
ItemAlternateEndColor | Gets or sets the second colour of the background gradient of every second unselected item. |
ItemAlternateGradientFactor | Gets or sets the direction of every unselected item's gradient while alternating colours are on. |
ItemAlternateStartColor | Gets or sets the first colour of the background gradient of every second unselected item. |
ItemContentFont | Gets or sets the font of every item's content text. |
ItemContentTextColor | Gets or sets the content text colour of a selected item. |
ItemDisabledContentTextColor | Gets or sets a text colour used while the control is disabled: the title's colour, despite the name. |
ItemDisabledEndColor | Gets or sets a second background colour for a disabled control, which the drawing does not use. |
ItemDisabledStartColor | Gets or sets the first colour of every item's background gradient, and the border colour, while the control is disabled. |
ItemDisabledTitleTextColor | Gets or sets a text colour used while the control is disabled: the content text's colour, despite the name. |
ItemMouseHoverBorderColor | Gets or sets the border colour of the unselected item under the pointer. |
ItemMouseHoverBorderThickness | Gets or sets the width of the border of the item under the pointer. |
ItemMouseHoverContentTextForeColor | Gets or sets the content text colour of the unselected item under the pointer. |
ItemMouseHoverEndColor | Gets or sets the second colour of the background gradient of the unselected item under the pointer. |
ItemMouseHoverGradientFactor | Gets or sets the direction of the background gradient of the unselected item under the pointer. |
ItemMouseHoverStartColor | Gets or sets the first colour of the background gradient of the unselected item under the pointer. |
ItemMouseHoverTitleForeColor | Gets or sets the title colour of the unselected item under the pointer. |
ItemReadOnlyBorderColor | Gets or sets every item's border colour while IsReadOnly is on. |
ItemReadOnlyContentTextColor | Gets or sets the colour of every item's content text while IsReadOnly is on. |
ItemReadOnlyEndColor | Gets or sets the second colour of every item's background gradient while IsReadOnly is on. |
ItemReadOnlyStartColor | Gets or sets the first colour of every item's background gradient while IsReadOnly is on. |
ItemReadOnlyTitleTextColor | Gets or sets the colour of every title while IsReadOnly is on. |
ItemSelectedBorderColor | Gets or sets the border colour of a selected item. |
ItemSelectedBorderThickness | Gets or sets the width of a selected item's border. |
ItemSelectedEndColor | Gets or sets the second colour of a selected item's background gradient. |
ItemSelectedGradientFactor | Gets or sets the direction of a selected item's background gradient. |
ItemSelectedStartColor | Gets or sets the first colour of a selected item's background gradient. |
ItemSpacing | Gets or sets the gap left below each item. |
ItemTitleFont | Gets or sets the font of every item's title. |
ItemTitleTextColor | Gets or sets the title colour of a selected item. |
ItemTooltipContentFont | Gets or sets the font of the tool tip text in the drop-down list's own tool tip. |
ItemTooltipTitleFont | Gets or sets the font of the tool tip title in the drop-down list's own tool tip. |
ItemUnselectedBorderColor | Gets or sets the border colour of an unselected item. |
ItemUnselectedBorderThickness | Gets or sets the width of the border of an unselected item. |
ItemUnselectedContentTextColor | Gets or sets the content text colour of an unselected item. |
ItemUnselectedEndColor | Gets or sets the second colour of an unselected item's background gradient. |
ItemUnselectedGradientFactor | Gets or sets the direction of an unselected item's background gradient. |
ItemUnselectedStartColor | Gets or sets the first colour of an unselected item's background gradient. |
ItemUnselectedTitleTextColor | Gets or sets the title colour of an unselected item. |
Items | Gets or sets the items the drop-down list shows, in order. |
MinimumItemTopAndBottomMargin | Gets or sets the space kept above and below an item's content inside its row. |
PaddingBetweenItemComponents | Gets or sets the gap between the parts of an item: the edge, the check box, the image and the text. |
SelectionMode | Not used: the drop-down list always lets the user select several items (MultiExtended). |
ShouldAnimateItemImage | Gets or sets whether the selected item's image is lifted by one pixel, so it appears to rise when the item is selected. |
ShouldDrawCheckBoxInVisualStyle | Gets or sets whether check boxes are drawn in the current Windows theme rather than the classic style. |
ShouldDrawItemBorder | Gets or sets whether a border is drawn around each item. |
ShouldDrawTopItemSpacingForFirstItem | Gets or sets whether a gap of ItemSpacing is left above the first item, as there is below
every item. |
ShouldEnableAlternatingColors | Gets or sets whether every second unselected item (the second, fourth and so on) is drawn in the alternate colours, for a striped list. |
ShouldExpandItemFullViewUponClick | Gets or sets whether, in the collapsed view, the rows are re-measured as soon as the mouse button goes down, so a clicked row opens on the press rather than after the release. |
ShouldRefreshBasedOnMessage | Gets or sets how the drop-down list applies new row heights: by sending them to the list window, or by recreating the window. |
ShouldShowDefaultTooltipOnItemHover | Gets or sets whether the drop-down list shows its own tool tip for an item with a tool tip: the item's tool tip title over its content. |
ShouldUseImageForCheckState | Gets or sets whether every item's check state is shown with CheckedStateImage and UncheckedStateImage instead of a check box. |
SidebarBorderThickness | Gets or sets the width of the sidebar strip's outline. |
SidebarGradientMode | Gets or sets the direction of the sidebar strip's gradient. |
SidebarItemHoveredStateBorderColor | Gets or sets the colour of the sidebar strip's outline on the item under the pointer. |
SidebarItemHoveredStateEndColor | Gets or sets the second colour of the sidebar strip's gradient on the item under the pointer. |
SidebarItemHoveredStateStartColor | Gets or sets the first colour of the sidebar strip's gradient on the item under the pointer. |
SidebarItemSelectedStateBorderColor | Gets or sets the colour of the sidebar strip's outline on the selected item. |
SidebarItemSelectedStateEndColor | Gets or sets the second colour of the sidebar strip's gradient on the selected item. |
SidebarItemSelectedStateStartColor | Gets or sets the first colour of the sidebar strip's gradient on the selected item. |
SidebarWidth | Gets or sets the width of the sidebar strip. |
TitleStringFormat | Gets or sets the title string format. |
UncheckedStateImage | Gets or sets the image shown for an unchecked item when check states are drawn as images. |
Constructors
CheckedImageListBoxConfiguration
Creates a configuration with no items and the combo box's default look.
Properties
AnnotationImageOnMouseHover
Gets or sets the image shown at the right end of the item under the pointer.
- Value
- The default is
null.
Remarks
Copied to the drop-down list each time it opens.
See also
BackColor
Gets or sets the background colour of the drop-down list, seen below the last item and between items.
- Value
- The default is
SystemColors.Window.
Remarks
Copied to the drop-down list each time it opens.
CheckBoxSize
Gets or sets the space reserved for an item's check box, and the size of a classic check box.
- Value
- The default is 16 by 16 logical pixels.
Remarks
Copied to the drop-down list each time it opens.
See also
CheckOnClick
Gets or sets whether a single click on an item toggles its check box.
- Value
- The default is
true.
Remarks
Copied to the drop-down list each time it opens.
See also
CheckedStateImage
Gets or sets the image shown for a checked item when check states are drawn as images.
- Value
- The default is
null.
Remarks
Copied to the drop-down list each time it opens.
See also
ContentStringFormat
Gets or sets the content string format.
- Value
- The default is near-aligned, top-aligned text, trimmed with an ellipsis, with no hot-key prefix.
Remarks
Copied to the drop-down list each time it opens.
See also
IsAnnotationEnabled
Gets or sets whether AnnotationImageOnMouseHover is shown at the right end of the item
under the pointer.
- Value
- The default is
true.
Remarks
Copied to the drop-down list each time it opens.
See also
IsImageDrawnWhenUsingDefaultItemTooltip
Gets or sets whether the control's own tool tip shows an information icon beside its title.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
IsItemCheckUncheckAllowed
Gets or sets a value indicating whether the control allows the user to check/uncheck items.
- Value
- The default is
true.
Remarks
Copied to the drop-down list each time it opens.
See also
IsItemSidebarBorderDrawingEnabled
Gets or sets whether the sidebar strip (see IsItemSidebarDrawingEnabled) has an outline.
- Value
- The default is
true.
Remarks
Copied to the drop-down list each time it opens.
See also
IsItemSidebarDrawingEnabled
Gets or sets whether a coloured strip is drawn down the left of the selected item and of the item under the pointer.
- Value
- The default is
true.
Remarks
Copied to the drop-down list each time it opens.
See also
IsReadOnly
Gets or sets whether the list is for looking only: it can be scrolled, but not selected or checked.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemAlternateEndColor
Gets or sets the second colour of the background gradient of every second unselected item.
- Value
- The default is
Color.White.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemAlternateGradientFactor
Gets or sets the direction of every unselected item's gradient while alternating colours are on.
- Value
- The default is 90.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemAlternateStartColor
Gets or sets the first colour of the background gradient of every second unselected item.
- Value
- The default is
Color.Wheat.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemContentFont
Gets or sets the font of every item's content text.
- Value
- The default is the message-box font family at 8.25 points, regular.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemContentTextColor
Gets or sets the content text colour of a selected item.
- Value
- The default is
Color.Black.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemDisabledContentTextColor
Gets or sets a text colour used while the control is disabled: the title's colour, despite the name.
- Value
- The default is
SystemColors.GrayText.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemDisabledEndColor
Gets or sets a second background colour for a disabled control, which the drawing does not use.
- Value
- The default is
SystemColors.Window.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemDisabledStartColor
Gets or sets the first colour of every item's background gradient, and the border colour, while the control is disabled.
- Value
- The default is
SystemColors.ControlLight.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemDisabledTitleTextColor
Gets or sets a text colour used while the control is disabled: the content text's colour, despite the name.
- Value
- The default is
SystemColors.GrayText.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemMouseHoverBorderColor
Gets or sets the border colour of the unselected item under the pointer.
- Value
- The default is
Color.DarkBlue.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemMouseHoverBorderThickness
Gets or sets the width of the border of the item under the pointer.
- Value
- The default is 1.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemMouseHoverContentTextForeColor
Gets or sets the content text colour of the unselected item under the pointer.
- Value
- The default is
Color.Blue.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemMouseHoverEndColor
Gets or sets the second colour of the background gradient of the unselected item under the pointer.
- Value
- The default is
Color.White.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemMouseHoverGradientFactor
Gets or sets the direction of the background gradient of the unselected item under the pointer.
- Value
- The default is 90.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemMouseHoverStartColor
Gets or sets the first colour of the background gradient of the unselected item under the pointer.
- Value
- The default is
Color.SkyBlue.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemMouseHoverTitleForeColor
Gets or sets the title colour of the unselected item under the pointer.
- Value
- The default is
Color.BlueViolet.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemReadOnlyBorderColor
Gets or sets every item's border colour while IsReadOnly is on.
- Value
- The default is
Color.Black.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemReadOnlyContentTextColor
Gets or sets the colour of every item's content text while IsReadOnly is on.
- Value
- The default is
SystemColors.WindowText.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemReadOnlyEndColor
Gets or sets the second colour of every item's background gradient while IsReadOnly is on.
- Value
- The default is
Color.White.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemReadOnlyStartColor
Gets or sets the first colour of every item's background gradient while IsReadOnly is on.
- Value
- The default is
Color.GhostWhite.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemReadOnlyTitleTextColor
Gets or sets the colour of every title while IsReadOnly is on.
- Value
- The default is
SystemColors.WindowText.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemSelectedBorderColor
Gets or sets the border colour of a selected item.
- Value
- The default is
Color.Red.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemSelectedBorderThickness
Gets or sets the width of a selected item's border.
- Value
- The default is 1.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemSelectedEndColor
Gets or sets the second colour of a selected item's background gradient.
- Value
- The default is
Color.White.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemSelectedGradientFactor
Gets or sets the direction of a selected item's background gradient.
- Value
- The default is 90.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemSelectedStartColor
Gets or sets the first colour of a selected item's background gradient.
- Value
- The default is
Color.LightSalmon.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemSpacing
Gets or sets the gap left below each item.
- Value
- The default is 6.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemTitleFont
Gets or sets the font of every item's title.
- Value
- The default is the message-box font family at 10 points, bold.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemTitleTextColor
Gets or sets the title colour of a selected item.
- Value
- The default is
Color.Brown.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemTooltipContentFont
Gets or sets the font of the tool tip text in the drop-down list's own tool tip.
- Value
- The default is the message-box font family at 11 points, regular.
Remarks
Copied to the drop-down list each time it opens. Used while ShouldShowDefaultTooltipOnItemHover is on.
See also
ItemTooltipTitleFont
Gets or sets the font of the tool tip title in the drop-down list's own tool tip.
- Value
- The default is the message-box font family at 10 points, bold.
Remarks
Copied to the drop-down list each time it opens. Used while ShouldShowDefaultTooltipOnItemHover is on.
See also
ItemUnselectedBorderColor
Gets or sets the border colour of an unselected item.
- Value
- The default is
Color.BurlyWood.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemUnselectedBorderThickness
Gets or sets the width of the border of an unselected item.
- Value
- The default is 1.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemUnselectedContentTextColor
Gets or sets the content text colour of an unselected item.
- Value
- The default is
Color.Brown.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemUnselectedEndColor
Gets or sets the second colour of an unselected item's background gradient.
- Value
- The default is
Color.White.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemUnselectedGradientFactor
Gets or sets the direction of an unselected item's background gradient.
- Value
- The default is 270.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemUnselectedStartColor
Gets or sets the first colour of an unselected item's background gradient.
- Value
- The default is
Color.NavajoWhite.
Remarks
Copied to the drop-down list each time it opens.
See also
ItemUnselectedTitleTextColor
Gets or sets the title colour of an unselected item.
- Value
- The default is
Color.Black.
Remarks
Copied to the drop-down list each time it opens.
See also
Items
Gets or sets the items the drop-down list shows, in order.
- Value
- A list of
CheckedImageListBoxItem; empty to begin with.
Remarks
The same item objects are put into the drop-down list each time it opens, so a check made in the list
is kept on the item: read CheckedImageListBoxItem.IsChecked here at any time. A change to the
list shows from the next time the drop-down opens.
MinimumItemTopAndBottomMargin
Gets or sets the space kept above and below an item's content inside its row.
- Value
- The default is 10.
Remarks
Copied to the drop-down list each time it opens.
See also
PaddingBetweenItemComponents
Gets or sets the gap between the parts of an item: the edge, the check box, the image and the text.
- Value
- The default is 8.
Remarks
Copied to the drop-down list each time it opens.
See also
SelectionMode
Not used: the drop-down list always lets the user select several items (MultiExtended).
- Value
- Kept for compatibility; any value is ignored.
ShouldAnimateItemImage
Gets or sets whether the selected item's image is lifted by one pixel, so it appears to rise when the item is selected.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldDrawCheckBoxInVisualStyle
Gets or sets whether check boxes are drawn in the current Windows theme rather than the classic style.
- Value
- The default is
true.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldDrawItemBorder
Gets or sets whether a border is drawn around each item.
- Value
- The default is
true.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldDrawTopItemSpacingForFirstItem
Gets or sets whether a gap of ItemSpacing is left above the first item, as there is below
every item.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldEnableAlternatingColors
Gets or sets whether every second unselected item (the second, fourth and so on) is drawn in the alternate colours, for a striped list.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldExpandItemFullViewUponClick
Gets or sets whether, in the collapsed view, the rows are re-measured as soon as the mouse button goes down, so a clicked row opens on the press rather than after the release.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldRefreshBasedOnMessage
Gets or sets how the drop-down list applies new row heights: by sending them to the list window, or by recreating the window.
- Value
true(the default, and recommended) to send them to the existing window.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldShowDefaultTooltipOnItemHover
Gets or sets whether the drop-down list shows its own tool tip for an item with a tool tip: the item's tool tip title over its content.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
ShouldUseImageForCheckState
Gets or sets whether every item's check state is shown with CheckedStateImage and UncheckedStateImage instead of a check box.
- Value
- The default is
false.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarBorderThickness
Gets or sets the width of the sidebar strip's outline.
- Value
- The default is 1.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarGradientMode
Gets or sets the direction of the sidebar strip's gradient.
- Value
- The default is
Horizontal.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarItemHoveredStateBorderColor
Gets or sets the colour of the sidebar strip's outline on the item under the pointer.
- Value
- The default is
Color.Black.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarItemHoveredStateEndColor
Gets or sets the second colour of the sidebar strip's gradient on the item under the pointer.
- Value
- The default is
Color.CornflowerBlue.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarItemHoveredStateStartColor
Gets or sets the first colour of the sidebar strip's gradient on the item under the pointer.
- Value
- The default is
Color.RoyalBlue.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarItemSelectedStateBorderColor
Gets or sets the colour of the sidebar strip's outline on the selected item.
- Value
- The default is
Color.Black.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarItemSelectedStateEndColor
Gets or sets the second colour of the sidebar strip's gradient on the selected item.
- Value
- The default is
Color.BurlyWood.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarItemSelectedStateStartColor
Gets or sets the first colour of the sidebar strip's gradient on the selected item.
- Value
- The default is
Color.Brown.
Remarks
Copied to the drop-down list each time it opens.
See also
SidebarWidth
Gets or sets the width of the sidebar strip.
- Value
- The default is 12.
Remarks
Copied to the drop-down list each time it opens.
See also
TitleStringFormat
Gets or sets the title string format.
- Value
- The default is near-aligned, top-aligned text, trimmed with an ellipsis, with no hot-key prefix.
Remarks
Copied to the drop-down list each time it opens.
See also
UncheckedStateImage
Gets or sets the image shown for an unchecked item when check states are drawn as images.
- Value
- The default is
null.
Remarks
Copied to the drop-down list each time it opens.