[Overview][Constants][Types][Classes][Procedures and functions][Index] | Reference for unit 'ColorBox' (#lcl)

# TColorBox

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

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

## Declaration

Source position: colorbox.pas line 97

`type TColorBox = class(TCustomColorBox)`
`published`
`property ColorRectWidth: Integer;` |  | Width for the color sample (swatch) displayed for colors in the item list.
`property ColorRectOffset: Integer;` |  | Number of pixels between the color sample and the color name.
`property DefaultColorColor: TColor;` |  | TColor used for the clDefault color constant.
`property NoneColorColor: TColor;` |  | TColor used for the clNone color constant.
`property Selected: TColor;` |  | The TColor value for the selected item in the combo-box control.
`property Style: TColorBoxStyle;` |  | Settings which determine the colors available in the control and their display style.
`property OnGetColors: TGetColorsEvent;` |  | OnGetColors - event handler for the instruction to get colors.
`property ColorDialog: TColorDialog;` |  | Dialog displayed to select a custom color for the control.
`property Align: TAlign;` |  | Specifies the placement of the control on its Parent control.
`property Anchors: TAnchors;` |  | The set of anchor definitions for this control.
`property ArrowKeysTraverseList: Boolean;` |  | Indicates if keyboard Arrow (or cursor) keys can be used to move through the list.
`property AutoComplete: Boolean;` |  | Positions the list box using partial text matching.
`property AutoCompleteText: TComboBoxAutoCompleteText;` |  | Options for the behavior of the Auto-Complete feature.
`property AutoDropDown: Boolean;` |  | Makes the drop-down list appear as soon as the user starts entering text.
`property AutoSelect: Boolean;` |  | Selects the entire content of the edit box when the control receives the focus.
`property AutoSize: Boolean;` |  | Allows automatic adjustment of the size for the control, according to its content.
`property BidiMode: TBiDiMode;` |  | Indicates whether text controls use in bi-directional reading.
`property BorderSpacing: TControlBorderSpacing;` |  | Determines the inner and outer border spacing for this control.
`property Color: TColor;` |  | The background color for the control.
`property Constraints: TSizeConstraints;` |  | Contains the minimum and maximum Width and Height for the control.
`property DragCursor: TCursor;` |  | The cursor shape shown during a drag operation.
`property DragMode: TDragMode;` |  | Determines how a drag operation is started for the control.
`property DropDownCount: Integer;` |  | The maximum number of Items visible in the drop-down list for the control.
`property Enabled: Boolean;` |  | Determines whether the control responds to mouse or keyboard input.
`property Font: TFont;` |  | The font to be used for text display in this control.
`property ItemHeight: Integer;` |  | The default height of an item in the drop-down for the control.
`property ItemWidth: Integer;` |  | The minimum width of the items in the drop-down list.
`property ParentBidiMode: Boolean;` |  | Indicates whether the BiDiMode settings in the Parent control are used.
`property ParentColor: Boolean;` |  | Use the Color from the Parent control, when enabled.
`property ParentFont: Boolean;` |  | Indicates if the Font from the Parent control is used in the control.
`property ParentShowHint: Boolean;` |  | If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`property PopupMenu: TPopupMenu;` |  | A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`property ShowHint: Boolean;` |  | Enables Hint display for the control.
`property TabOrder: TTabOrder;` |  | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`property TabStop: Boolean;` |  | Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`property Visible: Boolean;` |  | Allows the control, and all of its children, to be displayed or hidden.
`property OnChange: TNotifyEvent;` |  | Event handler signalled for user changes to the text in the edit box.
`property OnChangeBounds: TNotifyEvent;` |  | Event handler signalled when the Bounds for the control have been changed.
`property OnClick: TNotifyEvent;` |  | Notification handler for mouse clicks.
`property OnCloseUp: TNotifyEvent;` |  | Handler invoked when the drop-down list closes.
`property OnContextPopup: TContextPopupEvent;` |  | Invoked when a context-sensitive pop-up menu is requested.
`property OnDblClick: TNotifyEvent;` |  | Event handler signalled when a mouse double click occurs in the control.
`property OnDragDrop: TDragDropEvent;` |  | Event handler signalled when an object is dropped onto the control.
`property OnDragOver: TDragOverEvent;` |  | Event handler signalled when a control is dragged over the control instance.
`property OnEndDrag: TEndDragEvent;` |  | Event handler signalled for the end of a drag-drop operation.
`property OnDropDown: TNotifyEvent;` |  | Handler invoked when the list has dropped down.
`property OnEditingDone: TNotifyEvent;` |  | Event handler signalled when editing is completed for the control.
`property OnEnter: TNotifyEvent;` |  | Event handler signalled when the control receives focus.
`property OnExit: TNotifyEvent;` |  | Event handler signalled when the control loses focus.
`property OnKeyDown: TKeyEvent;` |  | Event handler signalled for key down keyboard events.
`property OnKeyPress: TKeyPressEvent;` |  | Event handler signalled for character data entered by the user.
`property OnKeyUp: TKeyEvent;` |  | Event handler signalled when a key up event has occurred for the control.
`property OnMouseDown: TMouseEvent;` |  | Event handler signalled when a mouse down event is handled for the control.
`property OnMouseEnter: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has entered the control.
`property OnMouseLeave: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has left the control.
`property OnMouseMove: TMouseMoveEvent;` |  | Event handler signalled when the mouse pointer is moved in the control.
`property OnMouseUp: TMouseEvent;` |  | Event handler signalled when a mouse up event is handled for the control.
`property OnMouseWheel: TMouseWheelEvent;` |  | Event handler for mouse wheel turned.
`property OnMouseWheelDown: TMouseWheelUpDownEvent;` |  | Event handler signalled for a downward movement of the mouse wheel.
`property OnMouseWheelUp: TMouseWheelUpDownEvent;` |  | Event handler signalled for an upward movement of the mouse wheel.
`property OnStartDrag: TStartDragEvent;` |  | Event handler signalled for the start of a dragging operation.
`property OnSelect: TNotifyEvent;` |  | Handler invoked when an item is selected.
`property OnUTF8KeyPress: TUTF8KeyPressEvent;` |  | Handler for a character entered by the user.
`end;`

## Inheritance

`TColorBox` |  | Implements combo-box control used to select a color name or value.
`TCustomColorBox` |  | The base class for TColorBox.
`TCustomComboBox` |  | The base class for combo-box components.
`TWinControl` |  | Implements a windowed control which can contain other child controls.
`TControl` |  | The base class for visible controls.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

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

## See also

TCustomColorBox |  | The base class for TColorBox.
TCustomColorListBox |  | Implements the base class for TColorListBox.
TColorListBox |  | Implements a list box control used to display and select color names and values.