TcxHotZoneStyle.SplitterDirection Method

Returns the orientation of the hot zone and the arrows within it.

Declaration

function SplitterDirection: TcxSplitterDirection; virtual;

Returns

Type
TcxSplitterDirection

Remarks

The orientation is calculated based on the splitter’s State and InvertDirection property values. You can determine the orientation using either the splitter’s Direction property or the hot zone style’s SplitterDirection function, which return the same value. The following table lists available values.

Value	Description
cxsdLeftToRight	The hot zone is horizontally oriented. Arrows are directed to the right.
cxsdRightToLeft	The hot zone is horizontally oriented. Arrows are directed to the left.
cxsdTopToBottom	The hot zone is vertically oriented. Arrows are directed to the bottom.
cxsdBottomToTop	The hot zone is vertically oriented. Arrows are directed to the top.

The image below shows the splitter whose State and InvertDirection properties are set to ssOpened and False, respectively. For this splitter, the Direction property and the SplitterDirection function return cxsdBottomToTop.

The information about the orientation is useful when overriding the CalculateHotZoneRect and DrawHotZone methods. If overriding the CalculateHotZoneRect method, you may need to determine whether the hot zone (together with the owning splitter control) is oriented vertically or horizontally. When implementing hot zone painting by overriding the DrawHotZone method, you will need the same information plus the orientation of hot zone’s arrows (if you intend to paint them).