LocalizationCodeDomSerializer.cs source code in C# .NET

Source code for the .NET framework in C#



/ DotNET / DotNET / 8.0 / untmp / whidbey / REDBITS / ndp / fx / src / Designer / Host / Serialization / LocalizationCodeDomSerializer.cs / 1 / LocalizationCodeDomSerializer.cs

//     Copyright (c) Microsoft Corporation.  All rights reserved.
namespace System.ComponentModel.Design.Serialization {
    using System; 
    using System.CodeDom;
    using System.Collections; 
    using System.ComponentModel;
    using System.ComponentModel.Design;
    using System.Diagnostics;
    using System.Globalization; 
    using System.IO;
    using System.Reflection; 
    using System.Resources; 
    using System.Runtime.Serialization;
    ///     Code model serializer for resource managers.  This is called
    ///     in one of two ways.  On Deserialization, we are associated
    ///     with a ResourceManager object.  Instead of creating a 
    ///     ResourceManager, however, we create an object called a
    ///     SerializationResourceManager.  This class inherits 
    ///     from ResourceManager, but overrides all of the methods. 
    ///     Instead of letting resource manager maintain resource
    ///     sets, it uses the designer host's IResourceService 
    ///     for this purpose.
    ///     During serialization, this class will also create
    ///     a SerializationResourceManager.  This will be added 
    ///     to the serialization manager as a service so other
    ///     resource serializers can get at it.  SerializationResourceManager 
    ///     has additional methods on it to support writing data 
    ///     into the resource streams for various cultures.
    internal class LocalizationCodeDomSerializer: CodeDomSerializer {

        private CodeDomLocalizationModel _model;
        private CodeDomSerializer _currentSerializer; 

        ///     Only we can create an instance of this. Everyonen else accesses it though 
        ///     static properties.
        internal LocalizationCodeDomSerializer(CodeDomLocalizationModel model, object currentSerializer) {
            _model = model;
            _currentSerializer = currentSerializer as CodeDomSerializer;

        ///    Returns true if we should emit an ApplyResources method for this object. We only emit 
        ///    this method once during serialization, and we track this by appending an object to
        ///    the context stack. 
        private bool EmitApplyMethod(IDesignerSerializationManager manager, object owner) {
            ApplyMethodTable table = (ApplyMethodTable)manager.Context[typeof(ApplyMethodTable)];
            if (table == null) { 
                table = new ApplyMethodTable();
            if (!table.Contains(owner)) {
                return true;
            return false;

        ///    Serializes the given object into a CodeDom object.  This uses the stock 
        ///    resource serialization scheme and retains the expression it provides.
        public override object Serialize(IDesignerSerializationManager manager, object value) {
            PropertyDescriptor desc = (PropertyDescriptor)manager.Context[typeof(PropertyDescriptor)];
            ExpressionContext tree = (ExpressionContext)manager.Context[typeof(ExpressionContext)];
            bool isSerializable = (value != null) ? TypeDescriptor.GetReflectionType(value).IsSerializable : true; 

            // If value is not serializable, we have no option but to call the original serializer, 
            // since we cannot push this into resources. 
            bool callExistingSerializer = !isSerializable;
            // Compat: If we are serializing content, we need to skip property reflection to preserve compatibility,
            //         since tools like WinRes expect items in collections (like TreeNodes and ListViewItems)
            //         to be serialized as binary blobs.
            bool serializingContent = (desc != null && desc.Attributes.Contains(DesignerSerializationVisibilityAttribute.Content)); 

            // We also skip back to the original serializer if there is a preset value for this object. 
            if (!callExistingSerializer) {
                callExistingSerializer = tree != null && tree.PresetValue == value; 

            if (_model == CodeDomLocalizationModel.PropertyReflection && !serializingContent && !callExistingSerializer) {
                // For a property reflecting model, we need to do more work.  Here we need to find 
                // the object we are serializing against and inject an "ApplyResources" method
                // against the object and its name.  If any of this machinery fails we will 
                // just return the existing expression which will default to the original behavior. 
                CodeStatementCollection statements = (CodeStatementCollection)manager.Context[typeof(CodeStatementCollection)];
                // In the case of extender properties, we don't want to serialize using the property
                // reflecting model.  In this case we'll skip it and fall through to the
                // property assignment model.
                bool skipPropertyReflect = false; 
                ExtenderProvidedPropertyAttribute attr = null;
                if (desc != null) { 
                    attr = desc.Attributes[typeof(ExtenderProvidedPropertyAttribute)] as ExtenderProvidedPropertyAttribute;
                    if (attr != null && attr.ExtenderProperty != null) { 
                        skipPropertyReflect = true;
                if (!skipPropertyReflect && tree != null && statements != null) {
                    string name = manager.GetName(tree.Owner); 
                    CodeExpression ownerExpression = SerializeToExpression(manager, tree.Owner); 

                    if (name != null && ownerExpression != null) { 

                        RootContext rootCxt = manager.Context[typeof(RootContext)] as RootContext;
                        if (rootCxt != null && rootCxt.Value == tree.Owner) {
                            name = "$this"; 
                        // Ok, if we got here it means we have enough data to emit 
                        // using the reflection model.
                        SerializeToResourceExpression(manager, value, false); 

                        if (EmitApplyMethod(manager, tree.Owner)) {
                            ResourceManager rm = manager.Context[typeof(ResourceManager)] as ResourceManager;
                            Debug.Assert(rm != null, "No resource manager available in context."); 
                            CodeExpression rmExpression = GetExpression(manager, rm);
                            Debug.Assert(rmExpression != null, "No expression available for resource manager."); 
                            CodeMethodReferenceExpression methodRef = new CodeMethodReferenceExpression(rmExpression, "ApplyResources");
                            CodeMethodInvokeExpression methodInvoke = new CodeMethodInvokeExpression(); 

                            methodInvoke.Method = methodRef;
                            methodInvoke.Parameters.Add(new CodePrimitiveExpression(name)); 
                        return null;    // we have already worked our statements into the tree.

            if (callExistingSerializer) { 
                return _currentSerializer.Serialize(manager, value);
            else { 
                return SerializeToResourceExpression(manager, value);

        ///    This class is used as a table to track which objects we've injected the "ApplyResources" method for. 
        private class ApplyMethodTable { 
            private Hashtable _table = new Hashtable(); 

            internal bool Contains(object value) { 
                return _table.ContainsKey(value);

            internal void Add(object value) { 
                _table.Add(value, value);

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.


Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK