WinForms › Checked Image List Combobox › CheckedImageListBoxConfiguration

CheckedImageListBoxConfiguration

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.Containers

Class that helps in configuring the CheckedImageListBox.

public sealed class CheckedImageListBoxConfiguration

Members at a glance

`CheckedImageListBoxConfiguration`	Initializes a new instance of the `CheckedImageListBoxConfiguration` class.
`AnnotationImageOnMouseHover`	Gets or sets the annotation image on mouse-hovered items.
`BackColor`	Gets or sets the control backcolor.
`CheckBoxSize`	Gets or sets the size of the CheckBox.
`CheckOnClick`	Gets or sets a value indicating whether the control should toggle the checked/unchecked state upon suer's mouse click on the item.
`CheckedStateImage`	Gets or sets the checked state image - i.e. the image to use for drawing the check state of the item as checked.
`ContentStringFormat`	Gets or sets the content string format.
`IsAnnotationEnabled`	Gets or sets a value indicating whether the control should show the annotation artefact when the mouse is hovered over an item in the control.
`IsImageDrawnWhenUsingDefaultItemTooltip`	Gets or sets a value indicating whether the control should render a built-in image when using default item tooltip.
`IsItemCheckUncheckAllowed`	Gets or sets a value indicating whether the control allows the user to check/uncheck items.
`IsItemSidebarBorderDrawingEnabled`	Gets or sets a value indicating whether the control draws the border for the item sidebar.
`IsItemSidebarDrawingEnabled`	Gets or sets a value indicating whether the control should drawn the item sidebar when the mouse pointer is moved over an item in the control.
`IsReadOnly`	Gets or sets a value indicating whether the control instance is read-only.
`ItemAlternateEndColor`	Gets or sets the end color for the alternate item background drawing.
`ItemAlternateGradientFactor`	Gets or sets the gradient factor for drawing the alternate item.
`ItemAlternateStartColor`	Gets or sets the start color for the alternate item background drawing.
`ItemContentFont`	Gets or sets the item content font.
`ItemContentTextColor`	Gets or sets the foreground color of the selected item's content text.
`ItemDisabledContentTextColor`	Gets or sets the color of the item disabled content text.
`ItemDisabledEndColor`	Gets or sets the end color of the selected item's background when the control is currently disabled.
`ItemDisabledStartColor`	Gets or sets the start color of the selected item's background when the control is currently disabled.
`ItemDisabledTitleTextColor`	Gets or sets the color of the item disabled title text.
`ItemMouseHoverBorderColor`	Gets or sets the border color for drawing the item border.
`ItemMouseHoverBorderThickness`	Gets or sets the item mouse hover border thickness.
`ItemMouseHoverContentTextForeColor`	Gets or sets the foreground color for drawing the item's content text when the mouse hovers over it.
`ItemMouseHoverEndColor`	Gets or sets the end color for drawing the item background when the mouse hovers over it.
`ItemMouseHoverGradientFactor`	Gets or sets the gradient factor for drawing the item background when the mouse hovers over it.
`ItemMouseHoverStartColor`	Gets or sets the start color for drawing the item background when the mouse hovers over it.
`ItemMouseHoverTitleForeColor`	Gets or sets the foreground color for drawing the item's Title text when the mouse hovers over it.
`ItemReadOnlyBorderColor`	Gets or sets the color of the item border when it is in read-only mode (see `IsReadOnly` or its `SelectionMode` property is set to SelectionMode.None.
`ItemReadOnlyContentTextColor`	Gets or sets the color of the item read-only content text.
`ItemReadOnlyEndColor`	Gets or sets the end color of the item when it is in read-only mode (see `IsReadOnly` or its `SelectionMode` property is set to SelectionMode.None.
`ItemReadOnlyStartColor`	Gets or sets the start color of the item when it is in read-only mode (see `IsReadOnly` or its `SelectionMode` property is set to SelectionMode.None.
`ItemReadOnlyTitleTextColor`	Gets or sets the color of the item read-only title text.
`ItemSelectedBorderColor`	Gets or sets the color of the selected item's border border.
`ItemSelectedBorderThickness`	Gets or sets the thickness of the selected item's border.
`ItemSelectedEndColor`	Gets or sets the end color of the selected item's background.
`ItemSelectedGradientFactor`	Gets or sets the linear gradient factor for drawing the selected item's background.
`ItemSelectedStartColor`	Gets or sets the start color of the selected item's background.
`ItemSpacing`	Gets or sets the spacing between the items in the control.
`ItemTitleFont`	Gets or sets the item title font.
`ItemTitleTextColor`	Gets or sets the color of the item title text.
`ItemTooltipContentFont`	Gets or sets the item tooltip content font.
`ItemTooltipTitleFont`	Gets or sets the item tooltip title font.
`ItemUnselectedBorderColor`	Gets or sets the color of the unselected item's border border.
`ItemUnselectedBorderThickness`	Gets or sets the item unselected border thickness.
`ItemUnselectedContentTextColor`	Gets or sets the color of the unselected item's content text.
`ItemUnselectedEndColor`	Gets or sets the end color of the unselected item's background.
`ItemUnselectedGradientFactor`	Gets or sets the linear gradient factor for drawing the unselected item's background.
`ItemUnselectedStartColor`	Gets or sets the start color of the unselected item's background.
`ItemUnselectedTitleTextColor`	Gets or sets the color of the unselected item's title text.
`Items`	Gets or sets the items.
`MinimumItemTopAndBottomMargin`	Gets or sets the item top and bottom margin for the items in the control.
`PaddingBetweenItemComponents`	Gets or sets the padding between item components such as the checkbox, image, and the title/content text area in the items.
`SelectionMode`	Gets or sets the method in which items are selected in the `CheckedImageListBox`.
`ShouldAnimateItemImage`	Gets or sets a value indicating whether the control should animate item image.
`ShouldDrawCheckBoxInVisualStyle`	Gets or sets a value indicating whether the control should draw CheckBox in Windows visual style.
`ShouldDrawItemBorder`	Gets or sets a value indicating whether the control should draw border around each item.
`ShouldDrawTopItemSpacingForFirstItem`	Gets or sets a value indicating whether the control should draw top space above the first item in the list.
`ShouldEnableAlternatingColors`	Gets or sets a value indicating whether the control should enable alternating colors for its items background drawing.
`ShouldExpandItemFullViewUponClick`	Gets or sets a value indicating whether the control should expand item into its full view upon click.
`ShouldRefreshBasedOnMessage`	Gets or sets a value indicating whether the control should refresh its items and its containers based on internal component messages (recommended option).
`ShouldShowDefaultTooltipOnItemHover`	Gets or sets a value indicating whether the control should show default tooltip on item hover.
`ShouldUseImageForCheckState`	Gets or sets a value indicating whether the control should use images for displaying the check state.
`SidebarBorderThickness`	Gets or sets the sidebar border thickness.
`SidebarGradientMode`	Gets or sets the sidebar gradient mode.
`SidebarItemHoveredStateBorderColor`	Gets or sets the color of the sidebar border.
`SidebarItemHoveredStateEndColor`	Gets or sets the end color of the sidebar.
`SidebarItemHoveredStateStartColor`	Gets or sets the start color of the sidebar.
`SidebarItemSelectedStateBorderColor`	Gets or sets the order color of the sidebar when the item is in selected state.
`SidebarItemSelectedStateEndColor`	Gets or sets the end color of the sidebar when the item is in selected state.
`SidebarItemSelectedStateStartColor`	Gets or sets the start color of the sidebar when the item is in selected state.
`SidebarWidth`	Gets or sets the width of the sidebar.
`TitleStringFormat`	Gets or sets the title string format.
`UncheckedStateImage`	Gets or sets the unchecked state image - i.e. the image to use for drawing the check state of the item as unchecked.

Constructors

CheckedImageListBoxConfiguration

public CheckedImageListBoxConfiguration()

Initializes a new instance of the CheckedImageListBoxConfiguration class.

Properties

AnnotationImageOnMouseHover

public Image AnnotationImageOnMouseHover

Gets or sets the annotation image on mouse-hovered items.

This property is used only when the property IsAnnotationEnabled is set to true.

BackColor

public Color BackColor

Gets or sets the control backcolor.

CheckBoxSize

public Size CheckBoxSize

Gets or sets the size of the CheckBox.

This feature will take effect only in either of two situations only:

1. When your are set ShouldDrawCheckBoxInVisualStyle to false, or
2. You are using your custom checkbox images by setting the ShouldUseImageForCheckState to true or ShouldUseImageForCheckState to true.

CheckOnClick

public bool CheckOnClick

Gets or sets a value indicating whether the control should toggle the checked/unchecked state upon suer's mouse click on the item.

CheckedStateImage

public Image CheckedStateImage

Gets or sets the checked state image - i.e. the image to use for drawing the check state of the item as checked.

ContentStringFormat

public StringFormat ContentStringFormat

Gets or sets the content string format.

IsAnnotationEnabled

public bool IsAnnotationEnabled

Gets or sets a value indicating whether the control should show the annotation artefact when the mouse is hovered over an item in the control.

IsImageDrawnWhenUsingDefaultItemTooltip

public bool IsImageDrawnWhenUsingDefaultItemTooltip

Gets or sets a value indicating whether the control should render a built-in image when using default item tooltip.

IsItemCheckUncheckAllowed

public bool IsItemCheckUncheckAllowed

Gets or sets a value indicating whether the control allows the user to check/uncheck items.

IsItemSidebarBorderDrawingEnabled

public bool IsItemSidebarBorderDrawingEnabled

Gets or sets a value indicating whether the control draws the border for the item sidebar.

IsItemSidebarDrawingEnabled

public bool IsItemSidebarDrawingEnabled

Gets or sets a value indicating whether the control should drawn the item sidebar when the mouse pointer is moved over an item in the control.

IsReadOnly

public bool IsReadOnly

Gets or sets a value indicating whether the control instance is read-only.

Value. true if this control instance is read-only; otherwise, false .

If the value is set to true, the control will allow only to scroll the control's view.

ItemAlternateEndColor

public Color ItemAlternateEndColor

Gets or sets the end color for the alternate item background drawing.

ItemAlternateGradientFactor

public float ItemAlternateGradientFactor

Gets or sets the gradient factor for drawing the alternate item.

ItemAlternateStartColor

public Color ItemAlternateStartColor

Gets or sets the start color for the alternate item background drawing.

ItemContentFont

public Font ItemContentFont

Gets or sets the item content font.

ItemContentTextColor

public Color ItemContentTextColor

Gets or sets the foreground color of the selected item's content text.

ItemDisabledContentTextColor

public Color ItemDisabledContentTextColor

Gets or sets the color of the item disabled content text.

ItemDisabledEndColor

public Color ItemDisabledEndColor

Gets or sets the end color of the selected item's background when the control is currently disabled.

ItemDisabledStartColor

public Color ItemDisabledStartColor

Gets or sets the start color of the selected item's background when the control is currently disabled.

ItemDisabledTitleTextColor

public Color ItemDisabledTitleTextColor

Gets or sets the color of the item disabled title text.

ItemMouseHoverBorderColor

public Color ItemMouseHoverBorderColor

Gets or sets the border color for drawing the item border.

ItemMouseHoverBorderThickness

public int ItemMouseHoverBorderThickness

Gets or sets the item mouse hover border thickness.

Value. The item mouse hover border thickness.

ItemMouseHoverContentTextForeColor

public Color ItemMouseHoverContentTextForeColor

Gets or sets the foreground color for drawing the item's content text when the mouse hovers over it.

ItemMouseHoverEndColor

public Color ItemMouseHoverEndColor

Gets or sets the end color for drawing the item background when the mouse hovers over it.

ItemMouseHoverGradientFactor

public float ItemMouseHoverGradientFactor

Gets or sets the gradient factor for drawing the item background when the mouse hovers over it.

ItemMouseHoverStartColor

public Color ItemMouseHoverStartColor

Gets or sets the start color for drawing the item background when the mouse hovers over it.

ItemMouseHoverTitleForeColor

public Color ItemMouseHoverTitleForeColor

Gets or sets the foreground color for drawing the item's Title text when the mouse hovers over it.

ItemReadOnlyBorderColor

public Color ItemReadOnlyBorderColor

Gets or sets the color of the item border when it is in read-only mode (see IsReadOnly or its SelectionMode property is set to SelectionMode.None.

ItemReadOnlyContentTextColor

public Color ItemReadOnlyContentTextColor

Gets or sets the color of the item read-only content text.

ItemReadOnlyEndColor

public Color ItemReadOnlyEndColor

Gets or sets the end color of the item when it is in read-only mode (see IsReadOnly or its SelectionMode property is set to SelectionMode.None.

ItemReadOnlyStartColor

public Color ItemReadOnlyStartColor

Gets or sets the start color of the item when it is in read-only mode (see IsReadOnly or its SelectionMode property is set to SelectionMode.None.

ItemReadOnlyTitleTextColor

public Color ItemReadOnlyTitleTextColor

Gets or sets the color of the item read-only title text.

ItemSelectedBorderColor

public Color ItemSelectedBorderColor

Gets or sets the color of the selected item's border border.

ItemSelectedBorderThickness

public int ItemSelectedBorderThickness

Gets or sets the thickness of the selected item's border.

ItemSelectedEndColor

public Color ItemSelectedEndColor

Gets or sets the end color of the selected item's background.

ItemSelectedGradientFactor

public float ItemSelectedGradientFactor

Gets or sets the linear gradient factor for drawing the selected item's background.

ItemSelectedStartColor

public Color ItemSelectedStartColor

Gets or sets the start color of the selected item's background.

ItemSpacing

public int ItemSpacing

Gets or sets the spacing between the items in the control.

The maximum allowed item spacing value is 24.
If the value set is more than 24 or les than 0, the control will automatically reset the value to 6.

ItemTitleFont

public Font ItemTitleFont

Gets or sets the item title font.

ItemTitleTextColor

public Color ItemTitleTextColor

Gets or sets the color of the item title text.

ItemTooltipContentFont

public Font ItemTooltipContentFont

Gets or sets the item tooltip content font.

ItemTooltipTitleFont

public Font ItemTooltipTitleFont

Gets or sets the item tooltip title font.

ItemUnselectedBorderColor

public Color ItemUnselectedBorderColor

Gets or sets the color of the unselected item's border border.

ItemUnselectedBorderThickness

public int ItemUnselectedBorderThickness

Gets or sets the item unselected border thickness.

Value. The item unselected border thickness.

ItemUnselectedContentTextColor

public Color ItemUnselectedContentTextColor

Gets or sets the color of the unselected item's content text.

ItemUnselectedEndColor

public Color ItemUnselectedEndColor

Gets or sets the end color of the unselected item's background.

ItemUnselectedGradientFactor

public float ItemUnselectedGradientFactor

Gets or sets the linear gradient factor for drawing the unselected item's background.

ItemUnselectedStartColor

public Color ItemUnselectedStartColor

Gets or sets the start color of the unselected item's background.

ItemUnselectedTitleTextColor

public Color ItemUnselectedTitleTextColor

Gets or sets the color of the unselected item's title text.

Items

public List<CheckedImageListBoxItem> Items

Gets or sets the items.

Value. The items.

MinimumItemTopAndBottomMargin

public int MinimumItemTopAndBottomMargin

Gets or sets the item top and bottom margin for the items in the control.

PaddingBetweenItemComponents

public int PaddingBetweenItemComponents

Gets or sets the padding between item components such as the checkbox, image, and the title/content text area in the items.

SelectionMode

public SelectionMode SelectionMode

Gets or sets the method in which items are selected in the CheckedImageListBox.

Value. The selection mode.

ShouldAnimateItemImage

public bool ShouldAnimateItemImage

Gets or sets a value indicating whether the control should animate item image.

ShouldDrawCheckBoxInVisualStyle

public bool ShouldDrawCheckBoxInVisualStyle

Gets or sets a value indicating whether the control should draw CheckBox in Windows visual style.

ShouldDrawItemBorder

public bool ShouldDrawItemBorder

Gets or sets a value indicating whether the control should draw border around each item.

ShouldDrawTopItemSpacingForFirstItem

public bool ShouldDrawTopItemSpacingForFirstItem

Gets or sets a value indicating whether the control should draw top space above the first item in the list.

ShouldEnableAlternatingColors

public bool ShouldEnableAlternatingColors

Gets or sets a value indicating whether the control should enable alternating colors for its items background drawing.

ShouldExpandItemFullViewUponClick

public bool ShouldExpandItemFullViewUponClick

Gets or sets a value indicating whether the control should expand item into its full view upon click.

ShouldRefreshBasedOnMessage

public bool ShouldRefreshBasedOnMessage

Gets or sets a value indicating whether the control should refresh its items and its containers based on internal component messages (recommended option).

ShouldShowDefaultTooltipOnItemHover

public bool ShouldShowDefaultTooltipOnItemHover

Gets or sets a value indicating whether the control should show default tooltip on item hover.

Value. true if the control should show default tooltip on item hover; otherwise, false .

ShouldUseImageForCheckState

public bool ShouldUseImageForCheckState

Gets or sets a value indicating whether the control should use images for displaying the check state.

SidebarBorderThickness

public int SidebarBorderThickness

Gets or sets the sidebar border thickness.

SidebarGradientMode

public LinearGradientMode SidebarGradientMode

Gets or sets the sidebar gradient mode.

SidebarItemHoveredStateBorderColor

public Color SidebarItemHoveredStateBorderColor

Gets or sets the color of the sidebar border.

SidebarItemHoveredStateEndColor

public Color SidebarItemHoveredStateEndColor

Gets or sets the end color of the sidebar.

SidebarItemHoveredStateStartColor

public Color SidebarItemHoveredStateStartColor

Gets or sets the start color of the sidebar.

SidebarItemSelectedStateBorderColor

public Color SidebarItemSelectedStateBorderColor

Gets or sets the order color of the sidebar when the item is in selected state.

SidebarItemSelectedStateEndColor

public Color SidebarItemSelectedStateEndColor

Gets or sets the end color of the sidebar when the item is in selected state.

SidebarItemSelectedStateStartColor

public Color SidebarItemSelectedStateStartColor

Gets or sets the start color of the sidebar when the item is in selected state.

SidebarWidth

public int SidebarWidth

Gets or sets the width of the sidebar.

TitleStringFormat

public StringFormat TitleStringFormat

Gets or sets the title string format.

UncheckedStateImage

public Image UncheckedStateImage

Gets or sets the unchecked state image - i.e. the image to use for drawing the check state of the item as unchecked.