WinForms › Checked Image List Box › CheckedImageListBox

CheckedImageListBox

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

A custom ListBox class that provides instant replacement for standard ListBox .NET control, and in addition provides advanced features, including supporting check state, title and content text, and image for the items in the control.

public class CheckedImageListBox : ListBox

Inherits from / implements: ListBox

Members at a glance

`CheckedImageListBox`	Initializes a new instance of the `CheckedImageListBox` class.
`AnnotationImageOnMouseHover`	Gets or sets the annotation image on mouse-hovered items.
`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.
`CreateParams`	Gets the window's creation parameters; while `ShouldDrawFrame` is on, without the border styles `BorderStyle` asks for, since the frame replaces them.
`DrawMode`	Gets or sets the drawing mode for the control.
`EnableItemFullView`	Gets or sets a value indicating whether the control should draw its item in full view all the time (or only when the user selects an item).
`FrameBorderColor`	Gets or sets the colour of the frame's border (see `ShouldDrawFrame`).
`FrameBorderThickness`	Gets or sets the thickness of the frame's border, in logical (96 DPI) pixels, 0 to 8.
`FrameCornerRadius`	Gets or sets the radius of the frame's corners, in logical (96 DPI) pixels, 0 to 32.
`FrameFocusedBorderColor`	Gets or sets the colour of the frame's border while the control has the focus. `Empty` keeps `FrameBorderColor`.
`FramePadding`	Gets or sets the space between the frame's border and the items, in logical (96 DPI) pixels, 0 to 16. It is never less than the corners need to keep the items inside them.
`FrameShadowColor`	Gets or sets the colour of the frame's drop shadow. Its strength is `FrameShadowOpacity`, so the colour's own alpha is not used.
`FrameShadowDepth`	Gets or sets how far the frame's shadow spreads, in logical (96 DPI) pixels, 0 to 24. A third of it is also the distance the shadow drops below the frame.
`FrameShadowOpacity`	Gets or sets the strength of the frame's shadow at its darkest, as a percentage, 0 to 100.
`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.
`IsChildOfPopupWindow`	Gets or sets whether the control is hosted inside a popup/popout window.
`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.
`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.
`ShouldDrawFrame`	Gets or sets a value indicating whether the control draws its own frame: a border with rounded corners, an inner padding and, optionally, a drop shadow, all inside its bounds.
`ShouldDrawFrameShadow`	Gets or sets a value indicating whether the frame casts a soft drop shadow.
`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.
`DefWndProc`	Passes a message on to the default window procedure.
`OnDrawItem`	Raises the DrawItem event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnHandleCreated`	Raises the HandleCreated event, then puts back the height the caller asked for.
`OnKeyDown`	Raises the KeyDown event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnKeyUp`	Raises the KeyUp event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnMeasureItem`	Raises the MeasureItem event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnMouseDown`	Raises the MouseDown event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnMouseLeave`	Raises the MouseLeave event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnMouseMove`	Raises the MouseMove event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnMouseUp`	Raises the MouseUp event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnMouseWheel`	Raises the MouseWheel event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnPaint`	Raises the Paint event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnResize`	Raises the Resize event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`OnSelectedIndexChanged`	Raises the SelectedIndexChanged event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.
`PerformDeterministicRefresh`	Performs the deterministic refresh for the control's internal artefacts.
`PerformRefreshMeasurePaint`	Performs a deterministic refresh by forcing a re-measure and re-paint.
`ProcessCmdKey`	Gives this control first sight of a command key, before the menu system and the parent form see it.
`ScrollIntoView`	Scrolls the index corresponding item into view., and optionally selects that item as the selected index item.
`SelectAll`	Selects all items in the control, and expands all items into their full items view mode for display, even if the control has the `EnableItemFullView`property set to false
`SetBoundsCore`	Performs the work of setting the bounds of this control, remembering the height asked for.
`SetCheckState`	Sets the state of the check.
`UnselectAll`	Unselects all (if there was a current selection of all items), and sets the very first item to be selected as default.
`WndProc`	Processes the Windows messages sent to this control's window.
`AnnotationImageClicked`	Occurs when the annotation image is clicked.
`ItemCheckStateChanged`	Occurs when the user changes the item check-state to checked or unchecked.
`ItemHoverChanged`	Occurs when the user hovers the mouse pointer on an item.
`ItemImageClicked`	Occurs when control's item image is clicked.
`ItemTooltipAboutToDraw`	Occurs when the tooltip is about to draw its content.
`ItemTooltipAboutToPopup`	Occurs when the tooltip is about to be displayed.
`VerticalScroll`	Occurs when the control vertically scrolls its items.

Constructors

CheckedImageListBox

public CheckedImageListBox()

Initializes a new instance of the CheckedImageListBox 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.

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.

CreateParams

protected override CreateParams CreateParams

Gets the window's creation parameters; while ShouldDrawFrame is on, without the border styles BorderStyle asks for, since the frame replaces them.

DrawMode

public override DrawMode DrawMode

Gets or sets the drawing mode for the control.

Value. The draw mode is always set to OwnerDrawVariable mode.

EnableItemFullView

public bool EnableItemFullView

Gets or sets a value indicating whether the control should draw its item in full view all the time (or only when the user selects an item).

Value. Set the value to true if you want the control to draw the items in full view always; otherwise, set it to false .

FrameBorderColor

public Color FrameBorderColor

Gets or sets the colour of the frame's border (see ShouldDrawFrame).

FrameBorderThickness

public int FrameBorderThickness

Gets or sets the thickness of the frame's border, in logical (96 DPI) pixels, 0 to 8.

FrameCornerRadius

public int FrameCornerRadius

Gets or sets the radius of the frame's corners, in logical (96 DPI) pixels, 0 to 32.

FrameFocusedBorderColor

public Color FrameFocusedBorderColor

Gets or sets the colour of the frame's border while the control has the focus. Empty keeps FrameBorderColor.

FramePadding

public int FramePadding

Gets or sets the space between the frame's border and the items, in logical (96 DPI) pixels, 0 to 16. It is never less than the corners need to keep the items inside them.

FrameShadowColor

public Color FrameShadowColor

Gets or sets the colour of the frame's drop shadow. Its strength is FrameShadowOpacity, so the colour's own alpha is not used.

FrameShadowDepth

public int FrameShadowDepth

Gets or sets how far the frame's shadow spreads, in logical (96 DPI) pixels, 0 to 24. A third of it is also the distance the shadow drops below the frame.

FrameShadowOpacity

public int FrameShadowOpacity

Gets or sets the strength of the frame's shadow at its darkest, as a percentage, 0 to 100.

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.

IsChildOfPopupWindow

public bool IsChildOfPopupWindow

Gets or sets whether the control is hosted inside a popup/popout window.

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.

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 override 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.

ShouldDrawFrame

public bool ShouldDrawFrame

Gets or sets a value indicating whether the control draws its own frame: a border with rounded corners, an inner padding and, optionally, a drop shadow, all inside its bounds.

The frame replaces BorderStyle, which is ignored while this is on. It is painted in the control's own non-client area, so the items, the scroll bar and the hit testing all sit inside it. Outside the border - the shadow and the rounded corners - the control paints the background colour of the nearest parent that has an opaque one.

ShouldDrawFrameShadow

public bool ShouldDrawFrameShadow

Gets or sets a value indicating whether the frame casts a soft drop shadow.

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.

Methods

DefWndProc

protected override void DefWndProc(ref Message m)

Passes a message on to the default window procedure.

OnDrawItem

protected override void OnDrawItem(DrawItemEventArgs e)

Raises the DrawItem event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnHandleCreated

protected override void OnHandleCreated(EventArgs e)

Raises the HandleCreated event, then puts back the height the caller asked for.

e: The data for the event.

With IntegralHeight on, Windows fits the window to the whole items it holds - and a freshly created window holds none: ListBox adds them back only once the window exists, and keeps the height the caller asked for privately, putting it back only when IntegralHeight itself changes. Nearly every property on this control recreates the handle, and one (IsReadOnly) was seen to leave the list four pixels tall.

OnKeyDown

protected override void OnKeyDown(KeyEventArgs e)

Raises the KeyDown event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnKeyUp

protected override void OnKeyUp(KeyEventArgs e)

Raises the KeyUp event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMeasureItem

protected override void OnMeasureItem(MeasureItemEventArgs e)

Raises the MeasureItem event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseDown

protected override void OnMouseDown(MouseEventArgs e)

Raises the MouseDown event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseLeave

protected override void OnMouseLeave(EventArgs e)

Raises the MouseLeave event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseMove

protected override void OnMouseMove(MouseEventArgs e)

Raises the MouseMove event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseUp

protected override void OnMouseUp(MouseEventArgs e)

Raises the MouseUp event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseWheel

protected override void OnMouseWheel(MouseEventArgs e)

Raises the MouseWheel event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnPaint

protected override void OnPaint(PaintEventArgs e)

Raises the Paint event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnResize

protected override void OnResize(EventArgs e)

Raises the Resize event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnSelectedIndexChanged

protected override void OnSelectedIndexChanged(EventArgs e)

Raises the SelectedIndexChanged event. CheckedImageListBox overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

PerformDeterministicRefresh

public void PerformDeterministicRefresh()

Performs the deterministic refresh for the control's internal artefacts.

PerformRefreshMeasurePaint

public void PerformRefreshMeasurePaint()

Performs a deterministic refresh by forcing a re-measure and re-paint.

ProcessCmdKey

protected override bool ProcessCmdKey(ref Message msg, Keys keyData)

Gives this control first sight of a command key, before the menu system and the parent form see it.

ScrollIntoView

public bool ScrollIntoView(int index, bool autoSelect)

Scrolls the index corresponding item into view., and optionally selects that item as the selected index item.

index: The index of the item to scroll to.
autoSelect: Specifies whether the control should automatically set the supplied index based item as the currently selected item.

Returns. true if the supplied index is valid for scrolling purposes, false otherwise.

SelectAll

public void SelectAll()

Selects all items in the control, and expands all items into their full items view mode for display, even if the control has the EnableItemFullViewproperty set to false

SetBoundsCore

protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)

Performs the work of setting the bounds of this control, remembering the height asked for.

x: The new left edge.
y: The new top edge.
width: The new width.
height: The new height.
specified: Which of the bounds are being set.

SetCheckState

public void SetCheckState(int index

Sets the state of the check.

index: The index.
isChecked: if set to true the item is set to checked state.

UnselectAll

public void UnselectAll()

Unselects all (if there was a current selection of all items), and sets the very first item to be selected as default.

WndProc

protected override void WndProc(ref Message m)

Processes the Windows messages sent to this control's window.

Events

AnnotationImageClicked

public event EventHandler AnnotationImageClicked

Occurs when the annotation image is clicked.

ItemCheckStateChanged

public event EventHandler<CheckedImageListBoxItemCheckStateChangedEventArgs> ItemCheckStateChanged

Occurs when the user changes the item check-state to checked or unchecked.

ItemHoverChanged

public event EventHandler<CheckedImageListBoxItemHoverChangedEventArgs> ItemHoverChanged

Occurs when the user hovers the mouse pointer on an item.

ItemImageClicked

public event EventHandler ItemImageClicked

Occurs when control's item image is clicked.

ItemTooltipAboutToDraw

public event EventHandler<CheckedImageListBoxTooltipDrawEventArgs> ItemTooltipAboutToDraw

Occurs when the tooltip is about to draw its content.

ItemTooltipAboutToPopup

public event EventHandler<CheckedImageListBoxItemTooltipPopupEventArgs> ItemTooltipAboutToPopup

Occurs when the tooltip is about to be displayed.

VerticalScroll

public event EventHandler VerticalScroll

Occurs when the control vertically scrolls its items.