SaveXml(FpSpread,Stream,SaveXMLOptions) 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 saveOption As SaveXMLOptions _
) As Boolean

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

public static bool SaveXml( 
   FpSpread spread,
   Stream stream,
   SaveXMLOptions saveOption
)

Parameters

spread: Spread component to save
stream: Stream to which to save the Spread component as XML
saveOption: Whether to save to XML options

Remarks

If the control has many duplicate style settings, then you may wish to use the AllAndStyleMerging option in the SaveXMLOptions enumeration when saving to an XML file. This decreases the file size and improves performance.

Example

This example saves to an XML file.

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

Visual Basic

Dim stream As System.IO.Stream
stream = System.IO.File.Create("C:\SpreadFiles\file01.xml")
FarPoint.Win.Spread.Model.SpreadSerializer.SaveXml(FpSpread1, stream, FarPoint.Win.Spread.SaveXMLOptions.All)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

SpreadSerializer Class
SpreadSerializer Members
Overload List