IsSpreadXmlFile(Stream) Method

Determines whether the specified stream contains a top-level Spread XML node.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function IsSpreadXmlFile( _
   ByVal stream As Stream _
) As Boolean

'Usage
 
Dim stream As Stream
Dim value As Boolean
 
value = SpreadSerializer.IsSpreadXmlFile(stream)

public static bool IsSpreadXmlFile( 
   Stream stream
)

Parameters

stream: Stream to consider as a source of Spread XML

Return Value

True if the specified Spread XML stream contains a top-level Spread XML node; false otherwise

Remarks

Use this method to consider whether the source is indeed an XML stream with Spread data.

Example

This example checks if a file is a Spread XML file.

FarPoint.Win.Spread.Model.SpreadSerializer s = new FarPoint.Win.Spread.Model.SpreadSerializer();
System.IO.Stream stream;
stream = System.IO.File.Open("D:\\SpreadFiles\\file01.xml", System.IO.FileMode.Open);
bool b = s.IsSpreadXmlFile(stream);
MessageBox.Show("The file is a Spread XML file is " + b.ToString());

Visual Basic

Dim s As New FarPoint.Win.Spread.Model.SpreadSerializer
Dim stream As System.IO.Stream
stream = System.IO.File.Open("D:\SpreadFiles\file01.xml", System.IO.FileMode.Open)
Dim b As Boolean = s.IsSpreadXmlFile(stream)
MessageBox.Show("The file is a Spread XML file is " & b.ToString)

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