ImageSlider.CalcHitInfo(Point) Method

Returns information on the image slider elements located at the specified point.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual ImageSliderHitInfo CalcHitInfo(
    Point hitPoint
)

VB.NET

Public Overridable Function CalcHitInfo(
    hitPoint As Point
) As ImageSliderHitInfo

Parameters

Name	Type	Description
hitPoint	Point	A System.Drawing.Point structure specifying the test point coordinates relative to the top-left corner of the ImageSlider control.

Returns

Type	Description
DevExpress.XtraEditors.Controls.ImageSliderHitInfo	An ImageSliderHitInfo object containing information about the image slider elements located at the test point.

Remarks

Use the CalcHitInfo method to determine which element is located at the specified point. This method returns the ImageSliderHitInfo object. Read the ImageSliderHitInfo.HitTest property of the ImageSliderHitTest type to get the ImageSlider‘s visual element to which the test point belongs. The ImageSliderHitTest enumeration provides the following values:

• Image — the test point belongs to the image.
• LeftButton — the test point belongs to the previous image button
• RightButton — the test point belongs to the next image button
• None — the test point does not belong to the ImageSlider control

Example

The following code demonstrates how to determine over which element of the ImageSlider the mouse pointer is located.

In the following example, the MouseMove event of the ImageSlider is handled. The ImageSlider.CalcHitInfo method is called to determine over which element the mouse pointer is located. The retrieved information is used to slide images.

C#

using DevExpress.XtraEditors.Controls;

//...

private void imageSlider1_MouseMove(object sender, MouseEventArgs e) {
    ImageSliderHitInfo ishi = imageSlider1.CalcHitInfo(e.Location);
    ImageSliderHitTest isht = ishi.HitTest;
    switch (isht) {
        case ImageSliderHitTest.LeftButton:
            imageSlider1.SlidePrev();
            break;
        case ImageSliderHitTest.RightButton:
            imageSlider1.SlideNext();
            break;
    }
}

VB.NET

Imports DevExpress.XtraEditors.Controls

'...

Private Sub imageSlider1_MouseMove(sender As Object, e As MouseEventArgs)
    Dim ishi As ImageSliderHitInfo = imageSlider1.CalcHitInfo(e.Location)
    Dim isht As ImageSliderHitTest = ishi.HitTest
    Select Case isht
        Case ImageSliderHitTest.LeftButton
            imageSlider1.SlidePrev()
            Exit Select
        Case ImageSliderHitTest.RightButton
            imageSlider1.SlideNext()
            Exit Select
    End Select
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CalcHitInfo(Point) method.

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-image-slider-cell-editor/CS/WindowsFormsApplication202/ImageSliderHelper.cs#L58

ImageSlider slider = sender as ImageSlider;
ImageSliderHitInfo info = slider.CalcHitInfo(e.Location);
if ((info.HitTest == ImageSliderHitTest.LeftButton || info.HitTest == ImageSliderHitTest.RightButton))

VB.NET

winforms-grid-image-slider-cell-editor/VB/WindowsFormsApplication202/ImageSliderHelper.vb#L62

Dim slider As ImageSlider = TryCast(sender, ImageSlider)
Dim info As ImageSliderHitInfo = slider.CalcHitInfo(e.Location)
If (info.HitTest = ImageSliderHitTest.LeftButton OrElse info.HitTest = ImageSliderHitTest.RightButton) Then