SaveExcel(String,ExcelSaveFlags,ExcelWarningList) Method

Saves the content of the Spread component to the specified Excel-compatible file with headers and a list of warnings.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SaveExcel( _
   ByVal fileName As String, _
   ByVal saveFlags As ExcelSaveFlags, _
   ByVal warningList As ExcelWarningList _
) As Boolean

'Usage
 
Dim instance As FpSpread
Dim fileName As String
Dim saveFlags As ExcelSaveFlags
Dim warningList As ExcelWarningList
Dim value As Boolean
 
value = instance.SaveExcel(fileName, saveFlags, warningList)

public bool SaveExcel( 
   string fileName,
   ExcelSaveFlags saveFlags,
   ExcelWarningList warningList
)

Parameters

fileName: Path and name of file
saveFlags: Save flag
warningList: List of Excel warnings

Return Value

Boolean: true if successful; false otherwise

Exceptions

Exception	Description
System.IO.FileNotFoundException	Specified file is not found
System.ArgumentNullException	No file name is specified (or specified file name is null)
System.ArgumentException	No file name is specified (or specified file name is empty)

Example

This example saves an Excel file to a string.

string f;  
f = "D:\\formula1.xls";  
FarPoint.Excel.ExcelWarningList w = new FarPoint.Excel.ExcelWarningList(); 
fpSpread1.SaveExcel(f, FarPoint.Excel.ExcelSaveFlags.NoFlagsSet, w);

Visual Basic

Dim f As String 
f = "D:\mptest.xls"
Dim w As New FarPoint.Excel.ExcelWarningList 
FpSpread1.SaveExcel(f, FarPoint.Excel.ExcelSaveFlags.NoFlagsSet, w)

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
Overload List