KGy SOFT Core Libraries Help
Xml
Serializes the object passed in obj by the provided XmlWriter object.
Definition
Namespace: KGySoft.Serialization.Xml
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0
C#
public static void Serialize(
XmlWriter writer,
Object? obj,
XmlSerializationOptions options = XmlSerializationOptions.CompactSerializationOfPrimitiveArrays|XmlSerializationOptions.EscapeNewlineCharacters
)VB
Public Shared Sub Serialize (
writer As XmlWriter,
obj As Object,
Optional options As XmlSerializationOptions = XmlSerializationOptions.CompactSerializationOfPrimitiveArrays Or XmlSerializationOptions.EscapeNewlineCharacters
)C++
public:
static void Serialize(
XmlWriter^ writer,
Object^ obj,
XmlSerializationOptions options = XmlSerializationOptions::CompactSerializationOfPrimitiveArrays|XmlSerializationOptions::EscapeNewlineCharacters
)F#
static member Serialize :
writer : XmlWriter *
obj : Object *
?options : XmlSerializationOptions
(* Defaults:
let _options = defaultArg options XmlSerializationOptions.CompactSerializationOfPrimitiveArrays|XmlSerializationOptions.EscapeNewlineCharacters
*)
-> unit Parameters
- writer XmlWriter
- A preconfigured XmlWriter object that will be used for serialization. The writer must be in proper state to serialize obj properly and will just be flushed but not closed after serialization.
- obj Object
- The Object to serialize.
- options XmlSerializationOptions (Optional)
- Options for serialization. This parameter is optional.
Default value: CompactSerializationOfPrimitiveArrays, EscapeNewlineCharacters
Exceptions
| ArgumentNullException | writer must not be null. |
| InvalidOperationException | The state of writer is wrong or writer is closed. |
| EncoderFallbackException | There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII but public properties of a class contain non-ASCII characters, an EncoderFallbackException is thrown. Such characters are escaped by character entity references in values when possible. |
| NotSupportedException | Root object is a read-only collection. |
| ReflectionException | The object hierarchy to serialize contains circular reference. -or- Serialization is not supported with provided options |