SaveTextFile(Stream,TextFileFlags,IncludeHeaders,String,String,String) Method

Saves the sheet as delimited text to a stream with specific delimiters.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SaveTextFile( _
   ByVal stream As Stream, _
   ByVal textFileFlags As TextFileFlags, _
   ByVal includeHeaders As IncludeHeaders, _
   ByVal rowDelimiter As String, _
   ByVal columnDelimiter As String, _
   ByVal cellDelimiter As String _
) As Boolean

'Usage
 
Dim instance As SheetView
Dim stream As Stream
Dim textFileFlags As TextFileFlags
Dim includeHeaders As IncludeHeaders
Dim rowDelimiter As String
Dim columnDelimiter As String
Dim cellDelimiter As String
Dim value As Boolean
 
value = instance.SaveTextFile(stream, textFileFlags, includeHeaders, rowDelimiter, columnDelimiter, cellDelimiter)

public bool SaveTextFile( 
   Stream stream,
   TextFileFlags textFileFlags,
   IncludeHeaders includeHeaders,
   string rowDelimiter,
   string columnDelimiter,
   string cellDelimiter
)

Parameters

stream: Stream to which to save the text of the sheet
textFileFlags: Specifies how to process the data when saving to a text file
includeHeaders: Whether to export headers as data
rowDelimiter: Row delimiter string
columnDelimiter: Column delimiter string
cellDelimiter: Cell delimiter string

Example

This example saves to a text file.

SaveFileDialog sfd = new SaveFileDialog();
System.IO.Stream s;
sfd.Filter = "text files (*.txt)|*.txt";
sfd.FilterIndex = 2;
sfd.RestoreDirectory = true;
if (sfd.ShowDialog() == DialogResult.OK)
{
   s = sfd.OpenFile();
   fpSpread1.ActiveSheet.SaveTextFile(s, FarPoint.Win.Spread.TextFileFlags.None, FarPoint.Win.Spread.Model.IncludeHeaders.BothCustomOnly, "\r", ",", "");
   s.Close();
}

Visual Basic

Dim sd As New SaveFileDialog()
Dim s As System.IO.Stream
sd.Filter = "text files (*.txt)|*.txt"
sd.FilterIndex = 2
sd.RestoreDirectory = True
If sd.ShowDialog() = DialogResult.OK Then
    s = sd.OpenFile
    FpSpread1.ActiveSheet.SaveTextFile(s, FarPoint.Win.Spread.TextFileFlags.None, FarPoint.Win.Spread.Model.IncludeHeaders.BothCustomOnly, Chr(13), ",", "")
    s.Close()
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

SheetView Class
SheetView Members
Overload List