New to Telerik Reporting? Start a free 30-day trial

ReportXmlSerializer

Class

Serializes and deserializes objects into and from XML. This class is dedicated for serializing and deserializing objects only from the Telerik.Reporting namespace.

Constructors

ReportXmlSerializer()

Initializes a new instance of the ReportXmlSerializer class.

public ReportXmlSerializer()

Methods

Deserialize(Stream)

Deserializes the XML document contained by the specified Stream.

public object Deserialize(Stream stream)

Parameters:streamStream

The Stream that contains the XML document to deserialize.

Returns:

object

The Telerik.Reporting object being deserialized.

Remarks:

Use the stream parameter to specify an object that derives from the Stream class, which is designed to write to streams. Classes that derive from the Stream class include: BufferedStream, FileStream, MemoryStream, etc.

Example:

The following example deserializes an object using a Stream:

using (System.IO.FileStream fileStream = new System.IO.FileStream("Report1.xml", System.IO.FileMode.Open, System.IO.FileAccess.Read))
{
    Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
        new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

    Telerik.Reporting.Report report = (Telerik.Reporting.Report)
        xmlSerializer.Deserialize(fileStream);
}

Using fileStream As New System.IO.FileStream("Report1.xml", System.IO.FileMode.Open, System.IO.FileAccess.Read)
    Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()

    Dim report As Telerik.Reporting.Report = DirectCast(xmlSerializer.Deserialize(fileStream), Telerik.Reporting.Report)
End Using

Deserialize(string)

Deserializes the XML document from the specified URI.

public object Deserialize(string inputUri)

Parameters:inputUristring

The URI for the file containing the XML data.

Returns:

object

The Telerik.Reporting object being deserialized.

Example:

The following example deserializes an object using a URI:

Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
    new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

Telerik.Reporting.Report report = (Telerik.Reporting.Report)
    xmlSerializer.Deserialize("Report1.xml");

Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()
Dim report As Telerik.Reporting.Report = DirectCast(xmlSerializer.Deserialize("Report1.xml"), Telerik.Reporting.Report)

Deserialize(TextReader)

Deserializes the XML document contained by the specified TextReader.

public object Deserialize(TextReader reader)

Parameters:readerTextReader

The TextReader that contains the XML document to deserialize.

Returns:

object

The Telerik.Reporting object being deserialized.

Remarks:

Classes that inherit from TextReader include StringReader and StreamReader. If you are using a StreamReader to deserialize an object, you must construct the StreamReader with an appropriate Encoding. The encoding specified by the XML document is ignored.

Example:

The following example deserializes an object using a TextReader:

using (System.IO.FileStream fileStream = new System.IO.FileStream("Report1.xml", System.IO.FileMode.Open, System.IO.FileAccess.Read))
using (System.IO.TextReader textReader = new System.IO.StreamReader(fileStream))
{
    Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
        new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

    Telerik.Reporting.Report report = (Telerik.Reporting.Report)
        xmlSerializer.Deserialize(textReader);
}

Using fileStream As New System.IO.FileStream("Report1.xml", System.IO.FileMode.Open, System.IO.FileAccess.Read)
    Using textReader As System.IO.TextReader = New System.IO.StreamReader(fileStream)
        Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()

        Dim report As Telerik.Reporting.Report = DirectCast(xmlSerializer.Deserialize(textReader), Telerik.Reporting.Report)
    End Using
End Using

Deserialize(XmlReader)

Deserializes the XML document contained by the specified XmlReader.

public object Deserialize(XmlReader reader)

Parameters:readerXmlReader

The XmlReader that contains the XML document to deserialize.

Returns:

object

The Telerik.Reporting object being deserialized.

Example:

The following example deserializes an object using a XmlReader:

System.Xml.XmlReaderSettings settings = new System.Xml.XmlReaderSettings();
settings.IgnoreWhitespace = true;

using (System.Xml.XmlReader xmlReader = System.Xml.XmlReader.Create("Report1.xml", settings))
{
    Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
        new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

    Telerik.Reporting.Report report = (Telerik.Reporting.Report)
        xmlSerializer.Deserialize(xmlReader);
}

Dim settings As New XmlReaderSettings() settings.IgnoreWhitespace = True
Using xmlReader As System.Xml.XmlReader = System.Xml.XmlReader.Create("Report1.xml", settings)
    Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()

    Dim report As Telerik.Reporting.Report = DirectCast(xmlSerializer.Deserialize(xmlReader), Telerik.Reporting.Report)
End Using

Serialize(Stream, object)

Serializes the specified value and writes the XML document to the specified Stream.

public void Serialize(Stream stream, object value)

Parameters:streamStream

The Stream used to write the XML document.

valueobject

The value to serialize.

Remarks:

Use the stream parameter to specify an object that derives from the abstract Stream class. Classes that derive from the Stream class include: BufferedStream, FileStream, MemoryStream, etc.

Example:

The following examples serializes an object using a Stream:

using (System.IO.Stream stream = new System.IO.FileStream("Report.xml", System.IO.FileMode.Create))
{
    Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
        new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

    xmlSerializer.Serialize(stream, report);
}

Using stream As System.IO.Stream = New System.IO.FileStream("Report.xml", System.IO.FileMode.Create)
    Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()

    xmlSerializer.Serialize(stream, report)
End Using

Serialize(string, object)

Serializes the specified value and writes the XML document to a file with the specified file name.

public void Serialize(string fileName, object value)

Parameters:fileNamestring

The file which you want to write to. The ReportXmlSerializer creates a file at the specified path and writes to it in XML 1.0 text syntax. The fileName must be a file system path.

valueobject

The value to serialize.

Example:

The following example serializes an object using a file path:

Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
    new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

xmlSerializer.Serialize("Report.xml", report);

Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()
xmlSerializer.Serialize("Report.xml", report)

Serialize(TextWriter, object)

Serializes the specified value and writes the XML document to the specified TextWriter.

public void Serialize(TextWriter writer, object value)

Parameters:writerTextWriter

The TextWriter used to write the XML document.

valueobject

The value to serialize.

Remarks:

In the textWriter parameter, specify an object that derives from the abstract TextWriter class. Classes that derive from the TextWriter class include: StreamWriter, StringWriter, etc.

Example:

The following examples serializes an object using a TextWriter:

using (System.IO.FileStream fs = new System.IO.FileStream("Report.xml", FileMode.Create))
using (System.IO.TextWriter writer = new System.IO.StreamWriter(fs, System.Text.Encoding.UTF8))
{
    Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
        new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

    xmlSerializer.Serialize(writer, report);
}

Using fs As New System.IO.FileStream("Report.xml", System.IO.FileMode.Create)
    Using writer As System.IO.TextWriter = New System.IO.StreamWriter(fs, System.Text.Encoding.UTF8)
        Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()

        xmlSerializer.Serialize(writer, report)
    End Using
End Using

Serialize(XmlWriter, object)

Serializes the specified value and writes the XML document to the specified XmlWriter.

public void Serialize(XmlWriter writer, object value)

Parameters:writerXmlWriter

The XmlWriter used to write the XML document.

valueobject

The value to serialize.

Remarks:

In the xmlWriter parameter, specify an object that derives from the abstract XmlWriter class. For example you can use the XmlTextWriter class.

Example:

The following example serializes an object using a XmlWriter:

using (System.Xml.XmlWriter xmlWriter = System.Xml.XmlWriter.Create("SerializedReport.xml"))
{
    Telerik.Reporting.XmlSerialization.ReportXmlSerializer xmlSerializer =
        new Telerik.Reporting.XmlSerialization.ReportXmlSerializer();

    xmlSerializer.Serialize(xmlWriter, report);
}

Using xmlWriter As System.Xml.XmlWriter = System.Xml.XmlWriter.Create("SerializedReport.xml")
    Dim xmlSerializer As New Telerik.Reporting.XmlSerialization.ReportXmlSerializer()

    xmlSerializer.Serialize(xmlWriter, report)
End Using