GridHitInfo.InColumnPanel Property

Gets a value indicating whether the test point is within the Column Header Panel.

Namespace: DevExpress.XtraGrid.Views.Grid.ViewInfo

Assembly: DevExpress.XtraGrid.v23.2.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public virtual bool InColumnPanel { get; }

VB.NET

Public Overridable ReadOnly Property InColumnPanel As Boolean

Property Value

Type	Description
Boolean	true if the test point is within the column header panel; otherwise, false.

Remarks

The InColumnPanel property is useful if you don’t need to determine the exact element residing under the test point and are only interested in whether the point is within the column header panel. For instance, the property can be used if you need to provide a common context menu for the column header panel regardless of which particular column header is right-clicked. If you need to obtain a particular column located under the test point, use the GridHitInfo.Column property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the InColumnPanel 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#

winforms-grid-display-text-editor-in-column-header/CS/WindowsApplication1/MyGridColumnRenameHelper.cs#L51

GridHitInfo info = gridView.CalcHitInfo(args.Location);
if (info.InColumnPanel) return info.Column;
return null;

VB.NET

winforms-grid-display-text-editor-in-column-header/VB/WindowsApplication1/MyGridColumnRenameHelper.vb#L48

Dim info As GridHitInfo = gridView.CalcHitInfo(args.Location)
If info.InColumnPanel Then
    Return info.Column