Spread Windows Forms 6.0 Product Documentation
OpenSpreadFile Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class : OpenSpreadFile Method


fileName
Path and name of the Spread-compatible file from which to load the contents
sheetIndex

Index of sheet into which to load the data.

Glossary Item Box

Opens a saved Spread file.

Syntax

Visual Basic (Declaration) 
Public Function OpenSpreadFile( _
   ByVal fileName As String, _
   ByVal sheetIndex As Integer _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim fileName As String
Dim sheetIndex As Integer
Dim value As Boolean
 
value = instance.OpenSpreadFile(fileName, sheetIndex)
C# 
public bool OpenSpreadFile( 
   string fileName,
   int sheetIndex
)

Parameters

fileName
Path and name of the Spread-compatible file from which to load the contents
sheetIndex

Index of sheet into which to load the data.

Return Value

Boolean: true if successful; false otherwise

Remarks

Set the SheetIndex to -1 to load all sheets from the file.

Example

This example opens the specified file and determines if it meets the minimal requirements to be considered a Spread SS7 file.

C#Copy Code
bool b;
FarPoint.Win.Spread.FpSpread fpSpread1 = new FarPoint.Win.Spread.FpSpread();
FarPoint.Win.Spread.SheetView shv = new FarPoint.Win.Spread.SheetView();
fpSpread1.Location = new Point(10, 10);
fpSpread1.Height = 200;
fpSpread1.Width = 400;
Controls.Add(fpSpread1);
fpSpread1.Sheets.Add(shv);
b = fpSpread1.IsSpreadSSFile(Application.StartupPath + "\\data.ss6");
label1.Visible = true;
label1.ForeColor = Color.Red;
if (b == true)
{
     fpSpread1.OpenSpreadFile(Application.StartupPath + "\\data.ss6", 0);
     label1.Text = "Is the file a Spread file = " + b.ToString();
}
Visual BasicCopy Code
Dim b As Boolean
Dim fpSpread1 As New FarPoint.Win.Spread.FpSpread()
Dim shv As New FarPoint.Win.Spread.SheetView()
fpSpread1.Location = New Point(10, 10)
fpSpread1.Height = 200
fpSpread1.Width = 400
Controls.Add(fpSpread1)
fpSpread1.Sheets.Add(shv)
b = fpSpread1.IsSpreadSSFile(Application.StartupPath & "\data.ss6")
Label1.Visible = True
Label1.ForeColor = Color.Red
If b = True Then
     fpSpread1.OpenSpreadFile(Application.StartupPath & "\data.ss6", 0)
     Label1.Text = "Is the file a Spread file = " & b.ToString()
End If

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

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