ObjectExtensionsDeepCloneT(T, Boolean) Method

Note: This API is now obsolete.

Clones an object by deep cloning.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1

C#

[ObsoleteAttribute("This DeepClone overload is obsolete. Use the DeepClone<T>(T,Func<object,object?>?) overload instead.")]
public static T DeepClone<T>(
	this T obj,
	bool ignoreCustomSerialization = false
)

VB

<ExtensionAttribute>
<ObsoleteAttribute("This DeepClone overload is obsolete. Use the DeepClone<T>(T,Func<object,object?>?) overload instead.")>
Public Shared Function DeepClone(Of T) ( 
	obj As T,
	Optional ignoreCustomSerialization As Boolean = false
) As T

C++

public:
[ExtensionAttribute]
[ObsoleteAttribute(L"This DeepClone overload is obsolete. Use the DeepClone<T>(T,Func<object,object?>?) overload instead.")]
generic<typename T>
static T DeepClone(
	T obj, 
	bool ignoreCustomSerialization = false
)

F#

[<ExtensionAttribute>]
[<ObsoleteAttribute("This DeepClone overload is obsolete. Use the DeepClone<T>(T,Func<object,object?>?) overload instead.")>]
static member DeepClone : 
        obj : 'T * 
        ?ignoreCustomSerialization : bool 
(* Defaults:
        let _ignoreCustomSerialization = defaultArg ignoreCustomSerialization false
*)
-> 'T

Parameters

obj T: The object to clone.
ignoreCustomSerialization Boolean (Optional): to ignore ISerializable and IObjectReference implementations as well as serialization constructors and serializing methods; to consider all of these techniques instead of performing a forced field-based serialization. This parameter is optional.
Default value: .

Type Parameters

T: Type of the object

Return Value

T
The functionally equivalent clone of the object.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type T. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Note

Obsolete Note: This overload uses the BinarySerializationFormatter internally, which is not always applicable. It is recommended to use the DeepCloneT(T, FuncObject, Object) overload instead.

This method makes possible to clone objects even if their type is not marked by the SerializableAttribute; however, in such case it is not guaranteed that the result is functionally equivalent to the input object.

Caution

In .NET Core there are some types that implement the ISerializable interface, though they are not serializable. In such cases the cloning attempt typically throws a PlatformNotSupportedException. To clone such objects the ignoreCustomSerialization parameter should be .

If ignoreCustomSerialization is , then it is not guaranteed that the object can be cloned in all circumstances (see the note above).

On the other hand, if ignoreCustomSerialization is , then it can happen that even singleton types will be deep cloned. The cloning is performed by the BinarySerializationFormatter class, which supports some singleton types natively (such as Type and DBNull), which will be always cloned correctly.

In .NET Framework remote objects are cloned in a special way and the result is always a local object. The ignoreCustomSerialization parameter is ignored for remote objects.