Sheet Property (TabStripHitTestInformation)

Returns the sheet the given location refers to.

Syntax

Visual Basic
C#

'Declaration
 
Public ReadOnly Property Sheet As Integer

'Usage
 
Dim instance As TabStripHitTestInformation
Dim value As Integer
 
value = instance.Sheet

public int Sheet {get;}

Property Value

Integer sheet index

Example

This example returns the sheet location.

void fpSpread1SheetTabClick(object sender, SheetTabClickEventArgs e)
{
      Rectangle r = fpSpread1.GetRootWorkbook().GetTabStripRectangle();
      FarPoint.Win.Spread.HitTestInformation hti;
      FarPoint.Win.Spread.TabStripHitTestInformation ti;
      hti = fpSpread1.HitTest(r.X, r.Y);
      ti = hti.TabStripInfo;
      if (hti.Type == HitTestType.TabStrip)
      {
            MessageBox.Show(ti.Sheet.ToString());
      }    
}

Visual Basic

Private Sub FpSpread1SheetTabClick(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.SheetTabClickEventArgs)

      Dim r As Rectangle
      r = FpSpread1.GetRootWorkbook.GetTabStripRectangle()

      Dim hti As FarPoint.Win.Spread.HitTestInformation
      Dim ti As FarPoint.Win.Spread.TabStripHitTestInformation
      hti = FpSpread1.HitTest(r.X, r.Y)
      ti = hti.TabStripInfo
      If hti.Type = HitTestType.TabStrip Then
            MsgBox(ti.Sheet)
      End If

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

TabStripHitTestInformation Class
TabStripHitTestInformation Members