SaveXml(FpSpread,Stream,Boolean) Method

Saves an entire Spread component to an XML stream.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function SaveXml( _
   ByVal spread As FpSpread, _
   ByVal stream As Stream, _
   ByVal dataOnly As Boolean _
) As Boolean

'Usage
 
Dim spread As FpSpread
Dim stream As Stream
Dim dataOnly As Boolean
Dim value As Boolean
 
value = SpreadSerializer.SaveXml(spread, stream, dataOnly)

public static bool SaveXml( 
   FpSpread spread,
   Stream stream,
   bool dataOnly
)

Parameters

spread: Spread component to save
stream: Stream to which to save the Spread component as XML
dataOnly: Whether to save only the data in the Spread component

Return Value

Boolean: true if successful; false otherwise

Example

This example saves a spread XML file.

System.IO.Stream stream;
stream = System.IO.File.Create("D:\\SpreadFiles\\file01.xml", System.IO.FileMode.Create);
FarPoint.Win.Spread.Model.SpreadSerializer.SaveXml(fpSpread1, stream, false);

Visual Basic

Dim s As New FarPoint.Win.Spread.Model.SpreadSerializer
Dim stream As System.IO.Stream
stream = System.IO.File.Create("D:\SpreadFiles\file01.xml", System.IO.FileMode.OpenOrCreate)
s.SaveXml(FpSpread1, stream, False)

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

SpreadSerializer Class
SpreadSerializer Members
Overload List