THeaderSection class

In unit ComCtrls

Implements a section displayed on a TCustomHeaderControl / THeaderControl instance.

Declaration

pascal

THeaderSection = class(TCollectionItem)

Inheritance

Description

THeaderSection is a TCollectionItem descendant which implements a section displayed on a TCustomHeaderControl / THeaderControl instance. THeaderSection is the type added and maintained in the THeaderSections collection, and used in the TCustomHeaderControl.Sections property.

THeaderSection has properties which identify its visual characteristics. This includes the text displayed for the section, its alignment, minimum and maximum widths, and an index for an optional image. Other properties contain run-time information about the section, including its left and right coordinates and its display state.

THeaderSection instances are normally created at design-time and edited using the IDE object inspector. They can be created at run-time using methods in the THeaderSections collection, and edited in code.

Properties

`Left`	public	The position of the left boundary of the section.
`Right`	public	The position of the right boundary of the section.
`State`	public	State - whether normal, hot (i.e. mouse hovers over it ready to be selected) or pressed (selected).
`OriginalIndex`	public	Index position which does not change when the user reorders the sections on a header control.
`Alignment`	published	Alignment - whether text is to be left or right justified or centered.
`ImageIndex`	published	Ordinal position for the image displayed for the header section.
`MaxWidth`	published	Maximum width in pixels allowed for the header section.
`MinWidth`	published	Minimum width in pixels allowed for the header section.
`Text`	published	The text displayed on the header section.
`Width`	published	Total width in pixels for the text and image on the header section.
`Visible`	published	Indicates if the section is visible in the header control.

Methods

`GetDisplayName`	protected	Gets the value for the DisplayName property.
`Create`	public	Constructor for the class instance.
`Assign`	public	Implements object persistence for the THeaderSection type.

Inherited

From TCollectionItem (11)

Changed Collection Destroy DisplayName GetNamePath GetOwner ID Index SetCollection SetDisplayName SetIndex

From TPersistent (5)

AssignTo DefineProperties FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.