SaveTextFileRange(Int32,Int32,Int32,Int32,Stream,Boolean,IncludeHeaders,Boolean,String,String,String) Method

Saves the range in the sheet (and may include headers and footer) as delimited text to a stream as specified.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SaveTextFileRange( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer, _
   ByVal stream As Stream, _
   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 row As Integer
Dim column As Integer
Dim rowCount As Integer
Dim columnCount As Integer
Dim stream As Stream
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.SaveTextFileRange(row, column, rowCount, columnCount, stream, unformatted, includeHeaders, includeFooter, rowDelimiter, columnDelimiter, cellDelimiter)

public bool SaveTextFileRange( 
   int row,
   int column,
   int rowCount,
   int columnCount,
   Stream stream,
   bool unformatted,
   IncludeHeaders includeHeaders,
   bool includeFooter,
   string rowDelimiter,
   string columnDelimiter,
   string cellDelimiter
)

Parameters

row: Starting row index
column: Starting column index
rowCount: Number of rows
columnCount: Number of columns
stream: Stream to which to save the range of cells
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 SaveTextFileRange 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)
        {
System.IO.Stream s;
string fileName;
fileName = "c:\\controls\\textfile1.txt";
s = System.IO.File.Open(fileName, System.IO.FileMode.OpenOrCreate);
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^");
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, false, "#", "%", "^");
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", System.Text.Encoding.ASCII);
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, false, "#", "%", "^", System.Text.Encoding.ASCII);
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", false);
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, false, "#", "%", "^", false);
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", false, System.Text.Encoding.ASCII);
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, false, "#", "%", "^", false, System.Text.Encoding.ASCII);
//FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", false, System.Text.Encoding.ASCII, false);
FpSpread1.Sheets[0].SaveTextFileRange(0, 0, 5, 5, s, true, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, false, "#", "%", "^", false, System.Text.Encoding.ASCII, false);
s.Close();
        }

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
Dim s As System.IO.Stream
Dim fileName As String
fileName = "c:\controls\textfile1.txt"
s = System.IO.File.Open(fileName, System.IO.FileMode.OpenOrCreate)
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^")
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, False, "#", "%", "^")
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", System.Text.Encoding.ASCII)
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, False, "#", "%", "^", System.Text.Encoding.ASCII)
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", False)
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, False, "#", "%", "^", False)
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", False, System.Text.Encoding.ASCII)
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, False, "#", "%", "^", False, System.Text.Encoding.ASCII)
'FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, "#", "%", "^", False, System.Text.Encoding.ASCII, False)
FpSpread1.Sheets(0).SaveTextFileRange(0, 0, 5, 5, s, True, FarPoint.Web.Spread.Model.IncludeHeaders.ColumnHeadersCustomOnly, False, "#", "%", "^", False, System.Text.Encoding.ASCII, False)
s.Close()
End Sub

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

SheetView Class
SheetView Members
Overload List