Class DicomXmlSerializer

Class DicomXmlSerializer

Namespace: Aspose.Medical.Dicom.Serialization
Assembly: Aspose.Medical.dll (25.11.0)

Provides functionality to serialize DICOM objects to XML and to deserialize XML into DICOM objects.

public static class DicomXmlSerializer

Inheritance

object DicomXmlSerializer

Inherited Members

object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Methods

Deserialize(string, DicomXmlSerializerOptions?)

Parses the text representing a single XML value into an instance of the Aspose.Medical.Dicom.Dataset.

public static Dataset Deserialize(string xml, DicomXmlSerializerOptions? options = null)

Parameters

xml string

The XML text to parse.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

Returns

Dataset

The Aspose.Medical.Dicom.Dataset or null.

Deserialize(Stream, DicomXmlSerializerOptions?)

Parses the text representing a single XML value into an instance of the Aspose.Medical.Dicom.Dataset.

public static Dataset Deserialize(Stream stream, DicomXmlSerializerOptions? options = null)

Parameters

stream Stream

The XML stream to parse.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

Returns

Dataset

The Aspose.Medical.Dicom.Dataset or null.

DeserializeAsync(string, DicomXmlSerializerOptions?)

Parses the text representing a single XML value into an instance of the Aspose.Medical.Dicom.Dataset.

public static Task<dataset> DeserializeAsync(string xml, DicomXmlSerializerOptions? options = null)

Parameters

xml string

The XML text to parse.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

Returns

Task < Dataset &gt;

The Aspose.Medical.Dicom.Dataset or null.

DeserializeAsync(Stream, DicomXmlSerializerOptions?)

Parses the text representing a single XML value into an instance of the Aspose.Medical.Dicom.Dataset.

public static Task<dataset> DeserializeAsync(Stream stream, DicomXmlSerializerOptions? options = null)

Parameters

stream Stream

The XML stream to parse.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

Returns

Task < Dataset &gt;

The Aspose.Medical.Dicom.Dataset or null.

Serialize(Dataset, DicomXmlSerializerOptions?)

Converts a Aspose.Medical.Dicom.Dataset to XML.

public static string Serialize(Dataset dataset, DicomXmlSerializerOptions? options = null)

Parameters

dataset Dataset

DICOM Dataset to be serialized.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

Returns

string

XML with serialized DICOM Dataset.

Serialize(Stream, Dataset, DicomXmlSerializerOptions?)

Converts a Aspose.Medical.Dicom.Dataset to XML.

public static void Serialize(Stream output, Dataset dataset, DicomXmlSerializerOptions? options = null)

Parameters

output Stream

The stream to which you want to write.

dataset Dataset

DICOM Dataset to be serialized.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

SerializeAsync(Dataset, DicomXmlSerializerOptions?)

Asynchronously converts a Aspose.Medical.Dicom.Dataset to XML.

public static Task<string> SerializeAsync(Dataset dataset, DicomXmlSerializerOptions? options = null)

Parameters

dataset Dataset

DICOM Dataset to be serialized.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

Returns

Task < string &gt;

XML with serialized DICOM Dataset.

SerializeAsync(Stream, Dataset, DicomXmlSerializerOptions?)

Asynchronously converts a Aspose.Medical.Dicom.Dataset to XML.

public static Task SerializeAsync(Stream output, Dataset dataset, DicomXmlSerializerOptions? options = null)

Parameters

output Stream

The stream to which you want to write.

dataset Dataset

DICOM Dataset to be serialized.

options DicomXmlSerializerOptions ?

Options that controls serialization/deserialization process of DICOM objects.

Returns

Task

XML with serialized DICOM Dataset.