KGy SOFT Core Libraries Help
Xml
Serializes the object passed in obj parameter into a new XElement object.
Definition
Namespace: KGySoft.Serialization.Xml
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
An XElement instance that contains the serialized object. Result can be deserialized by Deserialize(XElement) method.
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
C#
public static XElement Serialize(
Object? obj,
XmlSerializationOptions options = XmlSerializationOptions.CompactSerializationOfPrimitiveArrays|XmlSerializationOptions.EscapeNewlineCharacters
)VB
Public Shared Function Serialize (
obj As Object,
Optional options As XmlSerializationOptions = XmlSerializationOptions.CompactSerializationOfPrimitiveArrays Or XmlSerializationOptions.EscapeNewlineCharacters
) As XElementC++
public:
static XElement^ Serialize(
Object^ obj,
XmlSerializationOptions options = XmlSerializationOptions::CompactSerializationOfPrimitiveArrays|XmlSerializationOptions::EscapeNewlineCharacters
)F#
static member Serialize :
obj : Object *
?options : XmlSerializationOptions
(* Defaults:
let _options = defaultArg options XmlSerializationOptions.CompactSerializationOfPrimitiveArrays|XmlSerializationOptions.EscapeNewlineCharacters
*)
-> XElement Parameters
- obj Object
- The object to serialize.
- options XmlSerializationOptions (Optional)
- Options for serialization. This parameter is optional.
Default value: CompactSerializationOfPrimitiveArrays, EscapeNewlineCharacters
Return Value
XElementAn XElement instance that contains the serialized object. Result can be deserialized by Deserialize(XElement) method.
Exceptions
| 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 |