SaveTextFile(String,Boolean,IncludeHeaders,Boolean,String,String,String) Method

Saves the sheet (and optionally headers and footer) to a text file with the specified name and delimiters.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SaveTextFile( _
   ByVal fileName As String, _
   ByVal unformatted As Boolean, _
   ByVal includeHeaders As IncludeHeaders, _
   ByVal includeFooter As Boolean, _
   ByVal rowDelimiter As String, _
   ByVal columnDelimiter As String, _
   ByVal cellDelimiter As String _
) As Boolean

'Usage
 
Dim instance As SheetView
Dim fileName As String
Dim unformatted As Boolean
Dim includeHeaders As IncludeHeaders
Dim includeFooter As Boolean
Dim rowDelimiter As String
Dim columnDelimiter As String
Dim cellDelimiter As String
Dim value As Boolean
 
value = instance.SaveTextFile(fileName, unformatted, includeHeaders, includeFooter, rowDelimiter, columnDelimiter, cellDelimiter)

public bool SaveTextFile( 
   string fileName,
   bool unformatted,
   IncludeHeaders includeHeaders,
   bool includeFooter,
   string rowDelimiter,
   string columnDelimiter,
   string cellDelimiter
)

Parameters

fileName: Path and name of the file to which to save the sheet
unformatted: Whether to save the data unformatted
includeHeaders: Which header cells from which to save data
includeFooter: Whether to save the data in the footer cells
rowDelimiter: Row delimiter string
columnDelimiter: Column delimiter string
cellDelimiter: Cell delimiter string

Example

This example uses the SaveTextFile method.

FpSpread1.Sheets[0].RowCount = 6;
FpSpread1.Sheets[0].ColumnCount = 6;
FpSpread1.Sheets[0].Cells[0, 0, 5, 5].Text = "test";
FpSpread1.Sheets[0].ColumnHeader.Cells[0, 0].Text = "Custom";
FpSpread1.Sheets[0].Cells[0, 0].BackColor = System.Drawing.Color.CadetBlue;

protected void Button1_Click(object sender, EventArgs e)
        {
//FpSpread1.Sheets[0].SaveTextFile("c:\\controls\\textfile1.txt", false, FarPoint.Web.Spread.Model.IncludeHeaders.None, "#", "%", "^");
FpSpread1.Sheets[0].SaveTextFile("c:\\controls\\textfile1.txt", false, FarPoint.Web.Spread.Model.IncludeHeaders.None, false, "#", "%", "^");
        }

VB.NET

FpSpread1.Sheets(0).RowCount = 6
FpSpread1.Sheets(0).ColumnCount = 6
FpSpread1.Sheets(0).Cells(0, 0, 5, 5).Text = "test"
FpSpread1.Sheets(0).ColumnHeader.Cells(0, 0).Text = "Custom"
FpSpread1.Sheets(0).Cells(0, 0).BackColor = Drawing.Color.CadetBlue

Protected Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
'FpSpread1.Sheets(0).SaveTextFile("c:\controls\textfile1.txt", false, FarPoint.Web.Spread.Model.IncludeHeaders.None, "#", "%", "^")
FpSpread1.Sheets(0).SaveTextFile("c:\controls\textfile1.txt", false, FarPoint.Web.Spread.Model.IncludeHeaders.None, False, "#", "%", "^")
End Sub

Requirements

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

Reference

SheetView Class
SheetView Members
Overload List