InNote Property (ViewportHitTestInformation)

Gets whether the location refers to a sticky note.

Syntax

Visual Basic
C#

'Declaration
 
Public ReadOnly Property InNote As Boolean

'Usage
 
Dim instance As ViewportHitTestInformation
Dim value As Boolean
 
value = instance.InNote

public bool InNote {get;}

Property Value

Boolean: true if the cursor is over the cell note area; false otherwise

Example

This example returns whether the cursor is on the note.

private void fpSpread1CellClick(object sender, FarPoint.Win.Spread.CellClickEventArgs e)
{
      FarPoint.Win.Spread.HitTestInformation hti;
      FarPoint.Win.Spread.ViewportHitTestInformation vi;
      hti = fpSpread1.HitTest(e.X, e.Y);
      vi = hti.ViewportInfo;
      if (hti.Type == HitTestType.Viewport)
      {
            MessageBox.Show(vi.InNote.ToString());
      }   
}

Visual Basic

Private Sub FpSpread1CellClick(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.CellClickEventArgs)
      Dim hti As FarPoint.Win.Spread.HitTestInformation
      Dim vi As New FarPoint.Win.Spread.ViewportHitTestInformation
      hti = FpSpread1.HitTest(e.X, e.Y)
      vi = hti.ViewportInfo
      If hti.Type = HitTestType.Viewport Then
            MessageBox.Show(vi.InNote)
      End If
End Sub

Requirements

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

Reference

ViewportHitTestInformation Class
ViewportHitTestInformation Members