Skip to main content

ISerializable - Serializing objects

Serializing is a mechanism to create a text/binary version of your objects state, this can be saved or sent somewhere and then deserialized back into the instance again.
i.e. The member variables of your Type get written somewhere with their values of the instance of your Type.

e.g.
Here's the class who's instance I want to recreate somewhere else or at a later time.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace SimpleClass
{
public class Class1
{
public int _myMemberVar;

///
/// required for serialization
///
public Class1()
{
_myMemberVar = 0;
}

public Class1(int value)
{
_myMemberVar = value;
}
}
}

Here's a class which Serializes the instance of the class above with the XMLSerializer. The version below writes the XML version of the instance to the Console, you could replace the
using (Stream str = Console.OpenStandardOutput())
with a FileStream of some sort to write the XML to file.
This results in

www.w3.org/2001/XMLSchema">

<_mymembervar>10



using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using System.IO;
using System.Xml.Serialization;

namespace CallMySimpleClass
{
class Program
{
static void Main(string[] args)
{
SimpleClass.Class1 c = new SimpleClass.Class1(10);

string result = Serialize(c);
Console.WriteLine(result);
}
static string Serialize(object o)
{
string result = null;
using (Stream str = Console.OpenStandardOutput())
{
XmlSerializer x = new XmlSerializer(typeof(SimpleClass.Class1));
x.Serialize(str, o);
}
return result;
}
}
}




So that's how the default Serialization works but what if you want to customize how Serialize works.To do this you can either make members Serializable and NonSerialiazed by putting the [Serializable] and [NonSerialized] attributes on your Types and members (Note: these only work when using the Formatters .net gives you BinaryFormatter and SoapFormatter).Or you can take over the process completely buy making the Type you want to serialize implement ISerializable.


ISerializable:


Labels:

Comments

Post a Comment

Popular posts from this blog

dotNET - Debugging

Debugging with .NET MSIL assemblies Visual Studio and debugging the CLR are different, I'll talk about both. MSIL Assemblies Assemblies compiled with .NET tools such as the CLR compiler are compiled into a file which contains MSIL (Microsoft Intermediate Language). At runtime the contents of the assembly are loaded into the CLR and ran as machine code. When you compile an assembly in debug a PDB file is generated alongside the DLL or EXE you've just created. The link between these 2 files is that the PDB contains the line numbers of the methods and classes as well as the file names of the original source code that created the assembly. When you launch the debugger in Visual Studio the assembly is loaded into the Debugger (similar to the CLR) along with the PDB file. The debugger now uses your PDB file contents to match the running code found in the assembly to locations in source files (hopefully in your present project). CLR CLR Inside Out (msdn magazine) .NET Framework Tools:...
7 comments
Read more

Installer CustomAction, Debugging the CustomAction, InstallState

Custom Action The Custom Action is added to the Setup Project, select the Project node and hit the Custom Action button. This allows you add an Action to a particular phase in the Installation. But first you must create the Custom Action. To Add a Custom Action you must first have a Custom Action created, this is usually in the form of a Installer Class, this should be created in a seperate project, the Installer Class is actually one of the File Templates in the C# Projects. So it's File->New Project and select Visual C# Projects. Then add a Class Library, this will prompt you for the Class Library Types , select "Installer Class". Walkthrough - Creating Custom Action (msdn). Also here's a more comprehensive document on Setup/Installer implementations, it delves into the Registry etc Getting Started with Setup Projects (SimpleTalk). Visual Studio Setup Projects and Custom Actions (Simple Talk). Create your Installer Class and then add it as a Custom Action to the ...
3 comments
Read more

dotNET - Use app.config ApplicationSettings and UserSettings

When using Settings in an Assembly or .exe you can use the Settings Designer to generate a config file using Settings. The Settings Designer provides a wrapper class which allows you to provide defaults and access the config data using Properties. But what if you're not working inside that Assembly or .exe? this presents a problem. If your loading the Assembly externally and want to access that Assembly's .config file you'll probably wish to use something in the System.Configuration namespace... unfortunately it's not of much use if you've created the .config file from the Settings Designer in Visual Studio!! This is because the Designer creates Sections and ApplicationSettings and UserSettings, the System.Configuration namespace does not provide a method to access these (it has a method to access AppSettings which are a different thing. Below I've written a workaround which locates the app.config and accesses the ApplicationSettings and UserSettings using XML i...
8 comments
Read more