Skip to main content

BandedGridHitInfo.HitTest Property

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

Namespace: DevExpress.XtraGrid.Views.BandedGrid.ViewInfo

Assembly: DevExpress.XtraGrid.v24.1.dll

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

Declaration

public BandedGridHitTest HitTest { get; set; }

Property Value

Type Description
BandedGridHitTest

A BandedGridHitTest enumeration value identifying the visual element under the test point.

Available values:

Show 46 items
Name Description
None

The test point does not belong to any View’s visual element or is outside the View.

Column

The test point belongs to a column header.

ColumnEdge

The test point belongs to the right edge of a column header. End-users can drag these edges to resize columns horizontally or double-click them to apply best fit to the column (the OptionsColumn.AllowSize option of the desired column must be enabled for this purpose).

ColumnButton

The test point belongs to the column header panel button.

ColumnFilterButton

The test point belongs to a filter button, which can be used by end-users to invoke the flter dropdown. This enables end-users to apply filtering conditions to columns.

ColumnPanel

The test point belongs to the column header panel.

ColumnHeaderSearchButton

The test point belongs to the search button in a column header.

ColumnHeaderSearchText

The test point belongs to the search text in a column header.

RowCell

The test point belongs to a row cell.

RowIndicator

The test point belongs to an indicator panel cell corresponding to a data row or group row.

RowGroupButton

The test point belongs to a group expand button.

RowGroupCheckSelector

The test point belongs to a Group Row Check Box Selector.

Row

The test point belongs to a group row, group row indent or a cell edge.

RowPreview

The test point belongs to a preview section.

RowDetail

The test point belongs to a detail section.

RowDetailEdge

The test point belongs to the detail section’s bottom edge. The edge can be dragged to resize the detail section vertically.

RowDetailIndicator

The test point belongs to an indicator panel cell corresponding to a detail section.

EmptyRow

The test point is below all rows or belongs to an empty space within a row. Empty spaces may appear in advanced banded Views as the result of columns layout customization.

GroupPanel

The test point belongs to the group panel.

GroupPanelColumn

The test point belongs to a column header displayed within the group panel.

GroupPanelColumnFilterButton

The test point belongs to the filter button of the column header that resides within the group panel.

GroupPanelColumnHeaderSearchButton

The test point belongs to the search button in a grouped column header.

GroupPanelColumnHeaderSearchText

The test point belongs to the search text in a grouped column header.

GroupPanelFindPanelButton

The test point belongs to the Find button in the group panel.

Footer

The test point belongs to the view footer.

CellButton

The test point belongs to a master-detail expand button, which can be used to open/close details.

CustomizationForm

The test point belongs to the Customization Form.

FilterPanel

The test point belongs to the filter panel.

FilterCloseButton

The test point belongs to the filter close button.

RowFooter

The test point belongs to a group footer.

RowEdge

The test point belongs to the bottom edge of a data row. The edge can be dragged to resize the row vertically (if the GridOptionsCustomization.AllowRowSizing option is active).

FixedLeftDiv

The test point belongs to the left fixed line.

FixedRightDiv

The test point belongs to the right fixed line.

VScrollBar

The test point belongs to the View’s vertical scroll bar.

HScrollBar

The test point belongs to the View’s horizontal scroll bar.

FilterPanelActiveButton

The test point belongs to the button in the filter panel used to activate 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 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.

GroupRowCell

The test point belongs to the group row cell.

Band

The test point belongs to a band header.

BandEdge

The test point belongs to the right edge of a band header. End-users can drag these edges to resize bands horizontally (the OptionsBand.AllowSize option of the desired band must be enabled for this purpose).

BandPanel

The point belongs to the band header panel.

BandButton

The test point belongs to the band panel button.

Remarks

Usually, the HitTest property is used to determine the type of the element located under the mouse pointer. However, this property may not always suit your needs. Suppose that you need to determine whether a point is over a column header panel. In this case, using the HitTest property means that you need to check whether this property’s return value is BandedGridHitTest.Column, BandedGridHitTest.ColumnButton, BandedGridHitTest.ColumnEdge, BandedGridHitTest.ColumnFilterButton or BandedGridHitTest.ColumnPanel. Thus, it is best to use other properties of the BandedGridHitInfo object in this instance. For the example considered, the best choice is the GridHitInfo.InColumnPanel property.

See Also