GetCellFromPixel Method (FpSpread)

Gets the row and column indexes of the cell at the specified pointer location.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetCellFromPixel( _
   ByVal rowViewportIndex As Integer, _
   ByVal columnViewportIndex As Integer, _
   ByVal x As Integer, _
   ByVal y As Integer _
) As CellRange

'Usage
 
Dim instance As FpSpread
Dim rowViewportIndex As Integer
Dim columnViewportIndex As Integer
Dim x As Integer
Dim y As Integer
Dim value As CellRange
 
value = instance.GetCellFromPixel(rowViewportIndex, columnViewportIndex, x, y)

public CellRange GetCellFromPixel( 
   int rowViewportIndex,
   int columnViewportIndex,
   int x,
   int y
)

Parameters

rowViewportIndex: Index of the row of the viewport
columnViewportIndex: Index of the column of the viewport
x: X-coordinate of the pointer location
y: Y-coordinate of the pointer location

Return Value

CellRange object containing the cell

Remarks

This method returns a CellRange object that consists of row and column coordinates and row and column counts. If a cell exists at the pixel location, then the method returns CellRange(row, column, 1, 1) where row, column are the row index and column index of the cell. If a cell does not exist at the pixel location then the method returns CellRange(-1,-1,-1,-1).

Use the x and y parameters to specify the location (pixel) on the display and use the rowviewportindex and columnviewportindex parameters to specify a particular viewport.

This method only returns cell information for pixel locations in the data area of the sheet, and not for headers or sheet corner or other parts of the Spread component. For cells in the column headers and row headers, use the GetColumnHeaderCellFromPixel and GetRowHeaderCellFromPixel methods.

Example

This example gets the cell located at the specified pointer location.

private void fpSpread1_MouseDown(object sender, System.Windows.Forms.MouseEventArgs e)
{
     FarPoint.Win.Spread.Model.CellRange range = fpSpread2.GetCellFromPixel(0, 0, e.X, e.Y);
     listBox1.Items.Add("range: row=" + range.Row.ToString() + " column=" + range.Column.ToString());
}

Visual Basic

Private Sub FpSpread1_MouseDown(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles      FpSpread1.MouseDown
     Dim range As FarPoint.Win.Spread.Model.CellRange = FpSpread2.GetCellFromPixel(0, 0, e.X, e.Y)
     ListBox1.Items.Add("range: row=" & range.Row.ToString() & " column=" & range.Column.ToString())
End Sub

Requirements

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

Reference

FpSpread Class
FpSpread Members

User-Task Documentation

Customizing Interaction in Cells