TCustomHeaderControl class

In unit ComCtrls

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

Declaration

pascal

TCustomHeaderControl = class(TCustomControl)

Inheritance

Descends from it: THeaderControl

Description

TCustomHeaderControl - base class for 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 determining what action is to occur or what is to be displayed in any attached Panel or Form.

Properties

`SectionFromOriginalIndex`	public	Gets a header section by its original position in the Sections collection.
`DragReorder`	published	Enables or disables reordering of header sections on the control using drag and drop.
`Images`	published	Contains bitmaps displayed on the header sections for the control.
`ImagesWidth`	published	Specifies the width for Images displayed in the header control.
`Sections`	published	Sections - the short segments of the header separated by vertical bars that function as the elementary selection units of the header.

Methods

`CreateSection`	protected	Creates a new header section for the control.
`CreateSections`	protected	Creates the collection used to store header sections defined for the control.
`Loaded`	protected	Performs actions when the component has been loaded during LCL component streaming.
`Notification`	protected	Handles the notification when a component is added to or removed from the class instance.
`SectionClick`	protected	Performs actions needed when the mouse is clicked on the specified header section.
`SectionResize`	protected	Performs actions needed to resize the specified header section.
`SectionTrack`	protected	Performs actions needed when the mouse tracking state for a header section has changed.
`SectionSeparatorDblClick`	protected	Performs actions to handle a mouse double click event for the specified header section.
`SectionEndDrag`	protected	Signals the OnSectionEndDrag event handler (when assigned).
`SectionDrag`	protected	Signals the OnSectionDrag event handler (when assigned and enabled).
`MouseEnter`	protected	Signals the OnMouseEnter event handler (when assigned).
`MouseLeave`	protected	Signals the OnMouseLeave event handler (when assigned).
`MouseDown`	protected	Handles a mouse down event for the control.
`MouseMove`	protected	Handler for MouseMove events.
`MouseUp`	protected	Signals the OnMouseUp handler.
`UpdateState`	protected	Updates the State property in one or more of the Sections on the header control.
`GetControlClassDefaultSize`	protected	Gets the default size for new instances of the class.
`DoAutoAdjustLayout`	protected	Applies an automatic layout policy to the control using the specified scaling factors.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Click`	public	Signals OnClick and/or executes the ActionLink when the control has been clicked.
`DblClick`	public	Signals the OnDblClick event handler (when assigned).
`GetSectionAt`	public	Gets the header section at the position specified in P.
`Paint`	public	Draws the control to its Canvas using highlighting, drag images, and theme details.
`PaintSection`	public	Paints the specified header section to the Canvas for the control.
`ChangeScale`	public	Scales the width of the header sections in the control using the specified multiplier and divisor.

Events

`OnSectionDrag`	published	Event handler signalled to determine whether a header section can be dragged and dropped at a new position on the control.
`OnSectionEndDrag`	published	Event handler signalled when a drag and drop operation for a section is completed.
`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.
`OnSectionSeparatorDblClick`	published	Event handler signalled when a separator between header sections on the control is double-clicked.
`OnCreateSectionClass`	published	Event handler signalled to get the class type used to create a new section for the header control.