Skip to main content
All docs
V24.2

TdxLayoutSplitterItem.GetNearItem Method

Provides access to the adjacent near layout item.

Declaration

function GetNearItem: TdxCustomLayoutItem;

Returns

Type Description
TdxCustomLayoutItem

The adjacent near layout item.

The function returns nil (in Delphi) or nullptr (in C++Builder) if the layout splitter occupies the first position in the parent layout container (the splitter does not delimit two layout items).

Remarks

Call GetNearItem and GetFarItem functions to access two adjacent (near and far) layout items delimited by the splitter.

Near, Far, and Target Layout Items

Near and far item positions depend on the parent layout group‘s LayoutDirection property value:

ldVertical
Default. The group arranges items from top to bottom. The near item is above the splitter, and the far item is below it.
ldHorizontal
The group arranges items from left to right. Near and far items are to the left and right of a splitter, respectively.

The target item is the near or far layout item associated with the splitter, depending on AlignVert and AlignHorz property values as well as the parent group direction.

For example, the near item is the splitter target if the parent group is horizontally arranged, and the AlignHorz property is set to ahLeft:

VCL Layout Control: A Splitter and Delimited Layout Groups

See Also