HitInfo.HitTest Property

Gets or sets a value identifying the type of the visual element located under the test point.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

public HitTest HitTest { get; set; }

VB.NET

Public Property HitTest As HitTest

Property Value

Type	Description
HitTest	A HitTest enumeration value identifying the type of the visual element under the test point.

Available values:

Name	Description
None	The test point is not within a dock panel.
Border	The test point belongs to the dock panel’s border.
Client	The test point belongs to the dock panel’s client area.
Caption	The test point belongs to a dock panel’s caption.
TabPanel	The test point belongs to a tab panel in a tab container.
Tab	The test point belongs to a tab button in a tab container.
PrevTabButton	The test point belongs to a scroll button used to traverse backwards through the tabs in a tab container.
NextTabButton	The test point belongs to a scroll button used to traverse forwards through the tabs in a tab container.
AutoHidePanel	The test point belongs to the label within the auto hide container which corresponds to a dock panel with its auto hiding functionality enabled.
EmbeddedButtonPanel	The test point belongs to the header buttons panel, which contains both default and custom header buttons.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the HitTest 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-implement-a-context-menu-allowing-to-activate-a-certain-dockpanel-in-a-tabbed-group-e2676/CS/WindowsFormsApplication1/Form1.cs#L39

HitInfo info = ((DockPanel)sender).GetHitInfo(e.Location);
if (info.HitTest == HitTest.Tab) {
    popupMenu1.ShowPopup(panel.PointToScreen(e.Location));

how-to-activate-a-dockpanel-when-an-end-user-is-dragging-over-its-tab-e838/CS/WindowsFormsApplication2/PanelHelper.cs#L32

HitInfo info = pnl.GetHitInfo(pt);
if (info.HitTest == HitTest.Tab)
{

VB.NET

how-to-implement-a-context-menu-allowing-to-activate-a-certain-dockpanel-in-a-tabbed-group-e2676/VB/WindowsFormsApplication1/Form1.vb#L44

Dim info As HitInfo = (CType(sender, DockPanel)).GetHitInfo(e.Location)
If info.HitTest = HitTest.Tab Then
    popupMenu1.ShowPopup(panel.PointToScreen(e.Location))

how-to-activate-a-dockpanel-when-an-end-user-is-dragging-over-its-tab-e838/VB/WindowsFormsApplication2/PanelHelper.vb#L28

Dim info As HitInfo = pnl.GetHitInfo(pt)
If info.HitTest = HitTest.Tab Then
    e.Effect = DragDropEffects.All