Spread Windows Forms 7.0 Product Documentation
GetColumnHeaderCellFromPixel(Int32,Int32,Int32) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > SpreadView Class > GetColumnHeaderCellFromPixel Method : GetColumnHeaderCellFromPixel(Int32,Int32,Int32) Method


columnViewportIndex
Column index in the viewport
x
X-coordinate (in pixels) of the pointer location
y
Y-coordinate (in pixels) of the pointer location

Glossary Item Box

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

Syntax

Visual Basic (Declaration) 
Public Overloads Function GetColumnHeaderCellFromPixel( _
   ByVal columnViewportIndex As Integer, _
   ByVal x As Integer, _
   ByVal y As Integer _
) As CellRange
Visual Basic (Usage)Copy Code
Dim instance As SpreadView
Dim columnViewportIndex As Integer
Dim x As Integer
Dim y As Integer
Dim value As CellRange
 
value = instance.GetColumnHeaderCellFromPixel(columnViewportIndex, x, y)
C# 
public CellRange GetColumnHeaderCellFromPixel( 
   int columnViewportIndex,
   int x,
   int y
)

Parameters

columnViewportIndex
Column index in the viewport
x
X-coordinate (in pixels) of the pointer location
y
Y-coordinate (in pixels) of the pointer location

Return Value

CellRange object containing the row and column indexes (in a ) for the cell located at the specified pointer location, or (-1, -1, 0, 0) if no cell is located at the specified location

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, 0, 0).

Use the x and y parameters to specify the location (pixel) on the display of the pointer (or cursor).

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

Example

This example uses the GetColumnHeaderCellFromPixel method.
C#Copy Code
private void fpSpread1MouseDown(object sender, System.Windows.Forms.MouseEventArgs e) 
{
    FarPoint.Win.Spread.SpreadView sv  = fpSpread1.GetRootWorkbook();
    sv.AddViewport(0, 1);
    FarPoint.Win.Spread.Model.CellRange cr;

    cr = sv.GetColumnHeaderCellFromPixel(0, 1, e.X, e.Y);
    textBox1.Text = "You are in column header " + cr.Column.ToString();
}
VB.NETCopy Code
Private Sub FpSpread1MouseDown(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles FpSpread1.MouseDown
    Dim sv As FarPoint.Win.Spread.SpreadView = FpSpread1.GetRootWorkbook()
    sv.AddViewport(0, 1)
    Dim cr As FarPoint.Win.Spread.Model.CellRange
    cr = sv.GetColumnHeaderCellFromPixel(0, 1, e.X, e.Y)
    TextBox1.Text = "You are in column header " & cr.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

See Also

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