SaveExcel(String,IncludeHeaders,ExcelWarningList) Method

Saves the contents of the Spread component to Excel in the specified file and whether to include headers and keeps track of warnings.

Syntax

Visual Basic
C#

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

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

public bool SaveExcel( 
   string fileName,
   IncludeHeaders includeHeaders,
   ExcelWarningList warningList
)

Parameters

fileName: Path and file name of file to save
includeHeaders: Whether to export the headers as data
warningList: List of warning messages that occur during this operation

Return Value

Boolean: true if successful; false otherwise

Example

ExcelWarningList w = new ExcelWarningList();
FpSpread1.SaveExcel("test.xls",IncludeHeaders.BothCustomOnly,w);

Visual Basic

Dim w As FarPoint.Excel.ExcelWarningList
FpSpread1.SaveExcel("test.xls",Model.IncludeHeaders.BothCustomOnly,w)

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Parameters

Return Value

Reference

User-Task Documentation

External