TColorBox class

In unit ColorBox

Implements combo-box control used to select a color name or value.

Declaration

pascal

TColorBox = class(TCustomColorBox)

Inheritance

Description

TColorBox is a TCustomColorBox descendant which implements the a combo-box control used to display and select available color names and values. Each item in the control has a small rectangle where the color is displayed (swatch) and the color name.

The Style property is used to configure the list of available colors and their display names. Style may also trigger use of the OnGetColors event handler to get the items displayed in the combo-box control.

The ColorRectWidth and ColorRectOffset properties can be used to control the size and spacing for the color swatch displayed for the list items.

Colors allows indexed access to the TColor values in the list of items. When included in the Style property, colors like clDefault and/or clNone may be included in the list of Colors. The DefaultColorColor and NoneColorColor properties can be used to specify the TColor values used for those color constants.

ColorNames allows indexed access to the names for the values in Colors.

Use TCustomColorListBox / TColorListBox to display color names and values in a list box control.

Properties

`ColorRectWidth`	published	Width for the color sample (swatch) displayed for colors in the item list.
`ColorRectOffset`	published	Number of pixels between the color sample and the color name.
`DefaultColorColor`	published	TColor used for the clDefault color constant.
`NoneColorColor`	published	TColor used for the clNone color constant.
`Selected`	published	The TColor value for the selected item in the combo-box control.
`Style`	published	Settings which determine the colors available in the control and their display style.
`ColorDialog`	published	Dialog displayed to select a custom color for the control.
`Align`	published	Specifies the placement of the control on its Parent control.
`Anchors`	published	The set of anchor definitions for this control.
`ArrowKeysTraverseList`	published	Indicates if keyboard Arrow (or cursor) keys can be used to move through the list.
`AutoComplete`	published	Positions the list box using partial text matching.
`AutoCompleteText`	published	Options for the behavior of the Auto-Complete feature.
`AutoDropDown`	published	Makes the drop-down list appear as soon as the user starts entering text.
`AutoSelect`	published	Selects the entire content of the edit box when the control receives the focus.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`BidiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragMode`	published	Determines how a drag operation is started for the control.
`DropDownCount`	published	The maximum number of Items visible in the drop-down list for the control.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Font`	published	The font to be used for text display in this control.
`ItemHeight`	published	The default height of an item in the drop-down for the control.
`ItemWidth`	published	The minimum width of the items in the drop-down list.
`ParentBidiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnGetColors`	published	OnGetColors - event handler for the instruction to get colors.
`OnChange`	published	Event handler signalled for user changes to the text in the edit box.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnCloseUp`	published	Handler invoked when the drop-down list closes.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnDropDown`	published	Handler invoked when the list has dropped down.
`OnEditingDone`	published	Event handler signalled when editing is completed for the control.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnSelect`	published	Handler invoked when an item is selected.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.