Spread Windows Forms 7.0 Product Documentation
GetRowViewportIndexFromY Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > SpreadView Class : GetRowViewportIndexFromY Method

Y coordinate

Glossary Item Box

Gets the index of the viewport row for the specified coordinate for the active sheet.


Visual Basic (Declaration) 
Public Function GetRowViewportIndexFromY( _
   ByVal y As Integer _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As SpreadView
Dim y As Integer
Dim value As Integer
value = instance.GetRowViewportIndexFromY(y)
public int GetRowViewportIndexFromY( 
   int y


Y coordinate

Return Value

Integer index of viewport row


This method (along with GetColumnViewportIndexFromX) allows you to retrieve the index of the viewport row or viewport column from pixel offsets. This is useful in mouse-handling to see in which viewport a mouse event (MouseDown, MouseMove, etc.) occurred.

The viewport row index is zero-based, so the first (top) viewport row has an index of 0.


This example uses the GetRowViewportIndexFromY method.
C#Copy Code
private void fpSpread1MouseDown(object sender, System.Windows.Forms.MouseEventArgs e)
     int i;
     i = fpSpread1.GetRootWorkbook.GetRowViewportIndexFromY(e.Y);
VB.NETCopy Code
Private Sub FpSpread1MouseDown(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles FpSpread1.MouseDown
     Dim i As Integer
     i = FpSpread1.GetRootWorkbook.GetColumnViewportIndexFromX(e.X)
End Sub


Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.