THeaderControl class

In unit ComCtrls

THeaderControl, a header strip of user-designed sections which allow selection of pages or actions.

Declaration

pascal

THeaderControl = class(TCustomHeaderControl)

Inheritance

Description

THeaderControl, a header strip of user-designed sections which allow selection of pages or actions.

THeaderControl offers a widget that could be placed along the edge of a Panel or Form allowing a highly customized mechanism for selection. However there are no intrinsically associated display areas and it is the developer's responsibility to supply an index associated with the selection from the THeaderControl and determine what action is to occur or what is to be displayed in any attached Panel or Form.

THeaderControl is used by selecting its icon from the Common Controls tab of the IDE Component Palette and placing it on the Form in the desired position. It may be convenient to dock it with a Form or Panel whose properties it is to be used for controlling.

After size, position, docking, alignment, anchoring etc have been performed using the Object Inspector or Form Designer, the Sections of the Header can be created by selecting the control, right-clicking with the mouse and choosing 'Section Editor'. A Stringlist editor will pop up with options to add, delete or move entries up or down the list. Each entry is given an Index which can be used in OnClick event handlers to determine the action to be taken when that section is selected at run-time.

Properties

`Align`	published	Specifies the placement of the control on its Parent control.
`Anchors`	published	The set of anchor definitions for this control.
`BiDiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderWidth`	published	Width of the Border around the control; default is zero.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragKind`	published	Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`DragMode`	published	Determines how a drag operation is started 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.
`Images`	published	Contains bitmaps displayed on the header sections for the control.
`ImagesWidth`	published	Specifies the width for Images displayed in the header control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`Sections`	published	Sections - the short segments of the header separated by vertical bars that function as the elementary selection units of the header.
`ShowHint`	published	Enables Hint display for the control.
`ParentBiDiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`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.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnCreateSectionClass`	published	Event handler signalled to get the class type used to create a new section for the header 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.
`OnEndDock`	published	Event handler signalled for the end of a drag-dock operation.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`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.
`OnMouseWheelHorz`	published	Event handler signalled for a horizontal movement of the mouse wheel.
`OnMouseWheelLeft`	published	Event handler signalled for a leftward movement of the mouse wheel.
`OnMouseWheelRight`	published	Event handler signalled for a rightward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnSectionClick`	published	Event handler signalled when a mouse click event occurs in a section header on the control.
`OnSectionResize`	published	Event handler signalled when a resize operation for a header section has been completed.
`OnSectionTrack`	published	Event handler signalled when drag tracking/resizing is activated for the selected header section on the control.