BaseLayoutItemHitInfo.Item Property

Gets the layout item (regular group or tabbed group) positioned under the test point.

Namespace: DevExpress.XtraLayout.HitInfo

Assembly: DevExpress.XtraLayout.v19.1.dll

Declaration

C#

public virtual BaseLayoutItem Item { get; }

VB.NET

Public Overridable ReadOnly Property Item As BaseLayoutItem

Property Value

Type	Description
BaseLayoutItem	A BaseLayoutItem descendant that specifies the layout item positioned under the test point.

Remarks

The following table shows which objects are returned in specific cases:

An object returned	The point belongs to:
LayoutControlItem	a regular Layout Item
EmptySpaceItem	an Empty Space Items.
LayoutControlGroup	a Layout Groups‘s caption or border. The BaseLayoutItemHitInfo.IsGroup property returns true in this case.
TabbedControlGroup	a Tabbed Group‘s header or border. The BaseLayoutItemHitInfo.IsTabbedGroup property returns true in this case.
null (Nothing in Visual Basic)	the point is outside the Layout Control

To get the type of the layout item’s element located under the test point use the BaseLayoutItemHitInfo.HitType property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Item property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-extend-the-layoutcontrols-context-menu-to-set-an-image-for-a-layout-item-e2426/CS/WindowsApplication3/Form1.cs#L20

if(layoutControl1.CustomizationForm != null && layoutControl1.CustomizationForm.Visible &&
    e.HitInfo.Item != null) {
    LayoutControlItem layoutItem = e.HitInfo.Item as LayoutControlItem;

how-to-access-an-item-located-at-a-specific-point-e2100/CS/LayoutControl_CalcHitInfo/Form1.cs#L22

BaseLayoutItemHitInfo hi = lc.CalcHitInfo(e.Location);
LayoutControlItem currentItem = hi.Item as LayoutControlItem;
if (currentItem == null || hi.HitType != LayoutItemHitTest.TextArea) return;

VB.NET

how-to-extend-the-layoutcontrols-context-menu-to-set-an-image-for-a-layout-item-e2426/VB/WindowsApplication3/Form1.vb#L21

Private Sub OnLayoutControlShowContextMenu(ByVal sender As Object, ByVal e As DevExpress.XtraLayout.LayoutMenuEventArgs) Handles layoutControl1.ShowContextMenu
    If layoutControl1.CustomizationForm IsNot Nothing AndAlso layoutControl1.CustomizationForm.Visible AndAlso e.HitInfo.Item IsNot Nothing Then
        Dim layoutItem As LayoutControlItem = TryCast(e.HitInfo.Item, LayoutControlItem)

how-to-access-an-item-located-at-a-specific-point-e2100/VB/LayoutControl_CalcHitInfo/Form1.vb#L24

Dim hi As BaseLayoutItemHitInfo = lc.CalcHitInfo(e.Location)
Dim currentItem As LayoutControlItem = TryCast(hi.Item, LayoutControlItem)
If currentItem Is Nothing OrElse hi.HitType <> LayoutItemHitTest.TextArea Then