CardHitInfo.HitTest Property

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

Namespace: DevExpress.XtraGrid.Views.Card.ViewInfo

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public CardHitTest HitTest { get; set; }

VB.NET

Public Property HitTest As CardHitTest

Property Value

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

Available values:

Show 21 items

Name	Description
None	The test point does not belong to any Card View visual element or is outside the View.
Card	The test point belongs to a card‘s area not occupied by card constituent elements (in other words, the point belongs to a card’s edge).
CardCaption	The test point belongs to a card’s caption.
CardExpandButton	The test point belongs to the card 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 which is not occupied by the field caption or field value cell (in other words, the point belongs to a field edge).
FieldCaption	The test point belongs to a field caption.
FieldValue	The test point belongs to a field value cell.
Separator	The test point belongs to a card separator.
CardUpButton	The test point belongs to a top card scroll button.
CardDownButton	The test point belongs to a bottom card scroll button.
CardCaptionErrorIcon	The test point belongs to an error icon displayed within a card caption. Such error icons are displayed when cards fail to be validated.
QuickCustomizeButton	The test point belongs to the customization button.
CloseZoomButton	The test point belongs to a Card View’s zoom button.
FilterPanel	The test point belongs to a 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 Card View.
FilterPanelText	The test point belongs to a string in the filter panel which represents the filter criteria applied to a Card 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 the filter panel customize button.
ViewCaption	The test point belongs to the View Caption.
MasterTabPageHeader	The test point belongs to the View’s master-detail tab.

Remarks

Some View elements (card, filter panel, etc.) can display other elements within them. For instance, the filter panel can display buttons and filter criteria. Thus, care needs to be taken when using the HitTest property. To determine whether the test point is over the filter panel, it’s not enough to compare the property’s value with the CardHitTest.FilterPanel. Because a constituent element of the panel may reside under the test point and the HitTest property may return CardHitTest.FilterPanelCloseButton, CardHitTest.FilterPanelText, etc. In such cases, it’s better to use the other properties of the CardHitInfo object. For example the CardHitInfo.InFilterPanel 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-highlight-fields-in-cardview-e276/CS/Form1.cs#L222

GridCell c = new GridCell(info.RowHandle, info.Column);
if(info.HitTest == CardHitTest.FieldValue){
    HotTrackCell = new GridCell(info.RowHandle, info.Column);

VB.NET

how-to-highlight-fields-in-cardview-e276/VB/Form1.vb#L215

Dim c As GridCell = New GridCell(info.RowHandle, info.Column)
If info.HitTest = CardHitTest.FieldValue Then
    HotTrackCell = New GridCell(info.RowHandle, info.Column)