LayoutViewHitInfo.HitTest Property

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

Namespace: DevExpress.XtraGrid.Views.Layout.ViewInfo

Assembly: DevExpress.XtraGrid.v21.1.dll

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

Declaration

C#

public LayoutViewHitTest HitTest { get; set; }

VB.NET

Public Property HitTest As LayoutViewHitTest

Property Value

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

Available values:

Show 33 items

Name	Description
None	The test point is outside a View.
Bounds	The test point belongs to a View’s border or scroll bar.
ClientArea	This member supports the internal infrastructure and is not intended to be used directly from your code.
HeaderArea	The test point belongs to a View’s header panel.
FooterArea	This member supports the internal infrastructure and is not intended to be used directly from your code.
CardsArea	The test point belongs to a View’s empty area not occupied by cards.
ViewCaption	The test point belongs to a View’s caption.
Card	The test point belongs to a card‘s client area not occupied by field captions and values.
CardCaption	The test point belongs to a card’s caption.
CardExpandButton	The test point belongs to the expand button that resides within the card caption and is used to expand/collapse the card.
Field	The test point belongs to a card field‘s area not occupied by the field’s caption and value.
FieldCaption	The test point belongs to a card field’s caption.
FieldValue	The test point belongs to a card field’s value box.
FieldPopupActionArea	This member supports the internal infrastructure and is not intended to be used directly from your code.
FieldSortButton	The test point belongs to the Field Sort Button.
FieldFilterButton	The test point belongs to a Field Filter Button.
LayoutItem	The test point belongs to a card layout item (a group, tabbed group, separator, label or empty space item). See LayoutViewHitInfo.LayoutItem to learn more.
SingleModeButton	The test point belongs to the “One Card” button within the header panel that applies the single card display mode to the View.
RowModeButton	The test point belongs to the “One Row” button within the header panel that applies the single row display mode to the View.
ColumnModeButton	The test point belongs to the “One Column” button within the header panel that applies the single column display mode to the View.
MultiRowModeButton	The test point belongs to the “Multiple Rows” button within the header panel that applies the corresponding display mode to the View.
MultiColumnModeButton	The test point belongs to the “Multiple Columns” button within the header panel that applies the corresponding display mode to the View.
CarouselModeButton	The test point belongs to the “Carousel View” button within the header panel that applies the corresponding display mode to the View.
PanButton	The test point belongs to the pan button within the header panel that invokes the card panning feature.
CustomizeButton	The test point belongs to the “Customize” button within the header panel.
CloseZoomButton	The test point belongs to a View’s zoom button.
FilterPanel	The test point belongs to a View’s filter panel.
FilterPanelCloseButton	The test point belongs to a filter panel close button.
FilterPanelActiveButton	The test point belongs to the check box in the filter panel used to enable/disable filtering within a View.
FilterPanelText	The test point belongs to a string in the filter panel which represents the filter criteria applied to a View.
FilterPanelMRUButton	The test point belongs to a button in the filter panel used to display a dropdown window with a list of the most recently used filter criteria.
FilterPanelCustomizeButton	The test point belongs to a filter panel customize button.
MasterTabPageHeader	The test point belongs to the View’s master-detail tab.

Remarks

The bounds of the object identified by the HitTest property are specified by the LayoutViewHitInfo.HitRect property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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-provide-the-capability-of-adding-custom-buttons-to-the-layoutview-header-panel-e3692/CS/LayoutViewCustomButtonContent/LayoutViewCustomButtonHandler.cs#L21

    LayoutViewHitInfo currentHitInfo = hitInfo as LayoutViewHitInfo;
    currentView.ButtonsCollection.CheckForCustomButtonClick((int)currentHitInfo.HitTest);
}

VB.NET

how-to-provide-the-capability-of-adding-custom-buttons-to-the-layoutview-header-panel-e3692/VB/LayoutViewCustomButtonContent/LayoutViewCustomButtonHandler.vb#L22

    Dim currentHitInfo As LayoutViewHitInfo = TryCast(hitInfo, LayoutViewHitInfo)
    currentView.ButtonsCollection.CheckForCustomButtonClick(CInt((currentHitInfo.HitTest)))
End Sub