• Avalanche
  • Avalanche.Core
  • Lexical

    Show / Hide Table of Contents
    • Avalanche.Localization
      • Introduction
      • Localization
      • LocalizationFile
      • LocalizationFiles
      • LocalizationFileSystem
      • LocalizationFileFormat
      • LocalizationLine
      • LocalizationLines
      • TemplateFormat
      • CultureProvider
      • FallbackCultureProvider
      • ResourceManager
      • LocalizationError
      • Microsoft.Extensions
        • Introduction
        • DependencyInjection
        • FileProvider
        • Logging
        • ITextLocalizer
        • IFileLocalizer
        • Localization
        • AspNetCore
      • Pluralization
        • Introduction
        • Multiple plural parameters
        • Custom PluralRules
        • Invariant Culture
        • Unit Prefix
        • IPluralRule
        • IPluralNumber
        • IPluralRules
        • CLDRs
        • Unicode.CLDR41
        • Unicode.CLDR40
      • Articles
        • Alphabet localization
        • Benchmarks
        • Caching
        • Class Library
        • Demo
        • Diagnostics
        • Embedded resources
        • Emplacement
        • File localization
        • Text localization
    • Avalanche.Message
      • Introduction
      • IMessage
      • IMessageProvider
      • IMessageDescription
      • IMessageDescriptions
      • MessageLevel
      • Message printing
      • Messages and Exceptions
      • Logging
      • Validation
      • Localization
    • Avalanche.StatusCode
      • Introduction
      • HResult
        • Introduction
        • HResult.Facilities
        • BasicMessages
        • RpcMessages
        • DispatchMessages
        • ItfMessages
        • Win32Messages
        • ClrMessages
      • System
        • Introduction
        • AccessControlMessages
        • AggregateMessages
        • AppDomainMessages
        • ArgumentMessages
        • ArgumentNullMessages
        • ArgumentOutOfRangeMessages
        • ArithmeticMessages
        • ArrayMessages
        • AssemblyMessages
        • BadImageFormatMessages
        • CodeContractMessages
        • CodePageMessages
        • CollectionsMessages
        • CompilerServiceMessages
        • CryptographyMessages
        • CultureMessages
        • DiagnosticsMessages
        • EventSourceMessages
        • ExecutionEngineMessages
        • FormatMessages
        • HostProtectionMessages
        • IOMessages
        • IndexOutOfRangeMessages
        • InteropServiceMessages
        • InvalidCastMessages
        • InvalidOperationMessages
        • IsolatedStorageMessages
        • LazyMessages
        • MarshalerMessages
        • MemoryMessages
        • MiscellaneousMessages
        • NotImplementedMessages
        • NotSupportedMessages
        • ObjectDisposedMessages
        • OperationCanceledMessages
        • OverflowMessages
        • PlatformMessages
        • PolicyMessages
        • PrincipalMessages
        • ProgramMessages
        • ReferenceMessages
        • ReflectionMessages
        • RegionMessages
        • RemotingMessages
        • ResourcesMessages
        • SecurityMessages
        • SerializationMessages
        • StackMessages
        • TaskMessages
        • TextMessages
        • ThreadingMessages
        • TimeZoneMessages
        • TypeMessages
        • XmlMessages
    • Avalanche.Template
      • Introduction
      • TemplateFormats
      • ITemplatePrintable
      • ITemplateFormatPrintable
      • ITemplateText
      • ITemplateBreakdown
      • ITemplateFormat
      • ITemplateFormats
      • Extract Arguments
      • Emplacement
    • Avalanche.Tokenizer
      • Introduction
      • IToken
      • ITokenizer
      • Tokenizers
    • Avalanche.Service
      • Introduction
      • Service
        • IService
        • Construction
        • Query
        • CancellationToken
        • CachePolicy
        • Cast
        • Scope
        • Dispose
      • Handler
        • Introduction
        • IHandler
        • Cancel
        • Recursion
        • Cyclicity
        • Delegates
        • Casting
        • Invokable
        • Handlers
      • Request
        • Introduction
        • IRequest
        • [Request]
        • [ContextParameter]
        • Print Tree
      • Dependency Injection
        • Introduction
        • ServiceRequest<T>
        • Handler
        • CachePolicy
        • CancellationToken
        • QueryLogger
      • Examples
        • Expression Example
        • Mapper Example
      • ServiceMessages
    • Avalanche.Writer
      • Introduction
      • Writer
      • Referer
      • TypeCast
      • DefaultConstructor
      • DelegateWriter
      • WriterPipe
      • ConstantWriter
      • PassthroughWriter
      • Context
      • WriterMessages
    • Avalanche.Accessor
      • Introduction
      • AccessorServices
      • List
        • ListAccessor
        • ListConstructor
        • ListDeconstructor
        • ListDefaultConstructor
        • ListGet
        • ListSet
        • ListAdd
        • ListInsert
        • ListClear
        • ListCount
        • ListIndexOf
        • ListRemoveAt
        • ListReferer
      • Map
        • MapAccessor
        • MapConstructor
        • MapDeconstructor
        • MapDefaultConstructor
        • MapSet
        • MapGet
        • MapRemove
        • MapClear
        • MapCount
        • MapReferer
      • Record
        • RecordAccessor
        • RecordConstructor
        • RecordDeconstructor
        • RecordDefaultConstructor
      • Field
        • FieldAccessor
        • FieldReader
        • FieldWriter
        • FieldReferer
      • Dependency Injection
        • Introduction
      • AccessorMessages
    • Avalanche.Emit
      • Introduction
      • TypeBuilder
      • ConstructorBuilder
      • MethodBuilder
      • PropertyBuilder
      • FieldBuilder
      • Emit
      • Utilities
    • Avalanche.DataType
      • Introduction
      • IDataTypeBase
      • IDataType
      • IRecordType
      • IFieldType
      • IUnionType
      • IListType
      • IMapType
      • IValueType
      • IEnumerationType
      • IIntegerType
      • IRealType
      • IStringType
      • IAnyType
      • DataTypeRequest
      • PrintTree
      • DataTypeMessages
    • Avalanche.FileSystem
      • Introduction
      • Abstractions
        • IFileSystem
          • IFileSystemBrowse
          • IFileSystemCreateDirectory
          • IFileSystemDelete
          • IFileSystemFileAttribute
          • IFileSystemMount
          • IFileSystemMove
          • IFileSystemObserve
          • IFileSystemOpen
        • IEvent
        • IEntry
        • IOption
        • IToken
      • FileSystem
      • VirtualFileSystem
      • MemoryFileSystem
      • EmbeddedFileSystem
      • HttpFileSystem
      • Decoration
      • IFileProvider
      • Events
      • Utilities
        • Dispose
        • File Scanner
        • Visit Tree
        • File Operation
    • Avalanche.Identity
      • Introduction
      • Identity
      • IdentityParts
      • IdentityInterner
      • IdentityComparer
      • Print Tree
      • IdentityAccessors
        • Introduction
        • TypeName
    • Avalanche.Utilities
      • Introduction
      • Collections
        • Tuples
        • StructList
        • ArrayList
        • BijectionMap
        • LocakableDictionary
        • LockableList
        • MapList
        • Pipe
        • RingQueue
        • EnumerableExtensions
        • TupleUtilities
        • ArrayUtilities
      • Comparers
        • IGraphComparer
        • IGraphComparable
        • AlphaNumericComparer
        • EnumerableComparer
        • EnumerableGraphComparer
        • ReferenceComparer
        • KeyValuePairComparer
        • DefaultComparerProvider
        • RecordComparer
      • Cloners
        • ICloner
        • IGraphCloner
        • IGraphCloneable
        • EnumerableCloner
        • FieldCloner
        • PassthroughCloner
        • RecordCloner
        • ClonerProvider
      • Dispose
        • IDisposeAttachable
        • IDisposeBelatable
      • Provider
        • Introduction
        • ProviderBase
        • Delegate
        • Concatenation
        • Cache
        • ResultCapture
        • AsReadOnly
        • AsService
      • Record
        • IRecordDescription
        • IFieldDescription
        • IConstructorDescription
        • IConstructionDescription
        • IParameterDescription
        • IRecordProviders
        • RecordDelegates
          • RecordCreate
          • RecordClone
          • RecordCopy
          • IRecordDelegates
        • FieldDelegates
          • FieldRead
          • FieldWrite
          • RecreateWith
          • IFieldDelegates
      • String
        • IEscaper
        • UnicodeString
      • Miscellaneous
        • IIdGenerator
        • Permutation
        • IReadOnly
        • IUserDataContainer
        • Void
    • Avalanche.Core
      • License
      • Order

    IMessageDescription Localization

    Avalanche.Message.Localization.dll contains extension methods that help localizing message descriptions. This library requires Avalanche.Localization and Avalanche.Message.

    .Localize(localization, cultureProvider?) localizes the template text of the 'messageDescription'. 'messageDescription' cannot be in read-only state.

    // Create localization
    ILocalization localization = new Localization().AddLine("fi", "NULL.S_OK", "Detect", "Operaatio onnistui");
    // Create message description.
    IMessageDescription ok = new MessageDescription("NULL.S_OK", 0x00000000, "Operation successful").Localize(localization);
    // "Operation successful"
    WriteLine(ok.New().Print(CultureInfo.InvariantCulture));
    // "Operaatio onnistui"
    WriteLine(ok.New().Print(CultureInfo.GetCultureInfo("fi")));
    

    'cultureProvider' can be used to provide default culture externally.

    // Create localization
    ILocalization localization = new Localization().AddLine("fi", "NULL.S_OK", "Detect", "Operaatio onnistui");
    // Create culture provider
    ICultureProvider cultureProvider = new CultureProvider();
    // Create message description.
    IMessageDescription ok = new MessageDescription("NULL.S_OK", 0x00000000, "Operation successful").Localize(localization, cultureProvider);
    // Set language
    cultureProvider.Culture = "en";
    // "Operation successful"
    WriteLine(ok.New().Print());
    // Set language
    cultureProvider.Culture = "fi";
    // "Operaatio onnistui"
    WriteLine(ok.New().Print());
    

    .Localized(localization, cultureProvider?) creates decorated version of 'messageDescription' where text is localized. Can be used with 'messageDescription' that is in read-only state.

    // Create localization
    ILocalization localization = new Localization().AddLine("fi", HResult.S_OK.Key, "Detect", "Operaatio onnistui");
    // Decorate to localize
    IMessageDescription ok = HResult.S_OK.Localized(localization);
    // "Operation successful"
    WriteLine(ok.New().Print(CultureInfo.InvariantCulture));
    // "Operaatio onnistui"
    WriteLine(ok.New().Print(CultureInfo.GetCultureInfo("fi")));
    

    Localization.Default is the default localization singleton that is preconfigured to search localization files under "Resources/" folder.

    // Decorate to localize
    IMessageDescription ok = HResult.S_OK.Localized(Localization.Default);
    

    .LocalizeMessages(localization) can be used to localize entire message description table.

    /// <summary></summary>
    public class StatusCodes : MessageDescriptions
    {
        /// <summary>Base id for datatype codes.</summary>
        public const int BaseCode = 0x20A10000;
        /// <summary>Singleton</summary>
        static Lazy<StatusCodes> instance = new Lazy<StatusCodes>(() => new StatusCodes().ReadSummaryXmls().LocalizeMessages(Localization.Default).SetAllReadOnly<StatusCodes>().SetReadOnly());
        /// <summary>Singleton</summary>
        public static StatusCodes Instance => instance.Value;
    
        /// <summary>Message description fields</summary>
        IMessageDescription badUnexpected = Create(0xA0A10001, nameof(badUnexpected), "'{object}': Unexpected error");
        IMessageDescription badArgumentNull = Create(0xA0A10002, nameof(badArgumentNull), "'{object}': Unexpected error");
        IMessageDescription goodResult = Create(0x20A10003, nameof(goodResult), "'{object}': Unexpected error");
    
        /// <summary>Create description</summary>
        static IMessageDescription Create(long id, string key, string templateText)
            => new MessageDescription($"Library.{char.ToUpper(key[0])}{key.Substring(1)}", id, templateText).SetHResult(id);
    
        /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
        public IMessageDescription BadUnexpected { get => badUnexpected; set => this.AssertWritable().badUnexpected = value; }
        /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
        public IMessageDescription BadArgumentNull { get => badArgumentNull; set => this.AssertWritable().badArgumentNull = value; }
        /// <summary>Good result.</summary>
        public IMessageDescription GoodResult { get => goodResult; set => this.AssertWritable().goodResult = value; }
    }
    

    A new table may need to be apply localization.

    // Create localized message description table
    BasicMessages basicMessages = new BasicMessages()
        .Initialize()
        .LocalizeMessages(Localization.Default)
        .SetAllReadOnly<BasicMessages>()
        .SetReadOnly();
    // Get message description
    IMessageDescription fail = basicMessages.E_FAIL;
    // "Unspecified error"
    WriteLine(fail.New().Print(CultureInfo.InvariantCulture));
    // "Määrittelemätön virhe"
    WriteLine(fail.New().Print(CultureInfo.GetCultureInfo("fi")));
    

    Resources/NULL.yaml:

    TemplateFormat: Brace
    PluralRules: Unicode.CLDR
    
    Invariant:
    - Culture: ""
      Items:
      - Key: NULL.S_OK
        Text: "Operation successful"
      - Key: NULL.E_FAIL
        Text: "Unspecified error"
    
    Finnish:
    - Culture: fi
      Items:
      - Key: NULL.S_OK
        Text: "Operatio onnistui"
      - Key: NULL.E_FAIL
        Text: "Määrittelemätön virhe"
    

    Full Example

    Full example
    using System.Globalization;
    using Avalanche.Localization;
    using Avalanche.Message;
    using Avalanche.StatusCode;
    using Avalanche.Template;
    using Avalanche.Utilities;
    using static System.Console;
    
    class localization_index
    {
        public static void Run()
        {
            {
                // <01>
                // Create localization
                ILocalization localization = new Localization().AddLine("fi", "NULL.S_OK", "Detect", "Operaatio onnistui");
                // Create message description.
                IMessageDescription ok = new MessageDescription("NULL.S_OK", 0x00000000, "Operation successful").Localize(localization);
                // "Operation successful"
                WriteLine(ok.New().Print(CultureInfo.InvariantCulture));
                // "Operaatio onnistui"
                WriteLine(ok.New().Print(CultureInfo.GetCultureInfo("fi")));
                // </01>
            }
            {
                // <02>
                // Create localization
                ILocalization localization = new Localization().AddLine("fi", "NULL.S_OK", "Detect", "Operaatio onnistui");
                // Create culture provider
                ICultureProvider cultureProvider = new CultureProvider();
                // Create message description.
                IMessageDescription ok = new MessageDescription("NULL.S_OK", 0x00000000, "Operation successful").Localize(localization, cultureProvider);
                // Set language
                cultureProvider.Culture = "en";
                // "Operation successful"
                WriteLine(ok.New().Print());
                // Set language
                cultureProvider.Culture = "fi";
                // "Operaatio onnistui"
                WriteLine(ok.New().Print());
                // </02>
            }
            {
                // <03>
                // Create localization
                ILocalization localization = new Localization().AddLine("fi", HResult.S_OK.Key, "Detect", "Operaatio onnistui");
                // Decorate to localize
                IMessageDescription ok = HResult.S_OK.Localized(localization);
                // "Operation successful"
                WriteLine(ok.New().Print(CultureInfo.InvariantCulture));
                // "Operaatio onnistui"
                WriteLine(ok.New().Print(CultureInfo.GetCultureInfo("fi")));
                // </03>
            }
            {
                // <04>
                // Decorate to localize
                IMessageDescription ok = HResult.S_OK.Localized(Localization.Default);
                // </04>
            }
            {
                // <05>
                // Create localized message description table
                BasicMessages basicMessages = new BasicMessages()
                    .Initialize()
                    .LocalizeMessages(Localization.Default)
                    .SetAllReadOnly<BasicMessages>()
                    .SetReadOnly();
                // Get message description
                IMessageDescription fail = basicMessages.E_FAIL;
                // "Unspecified error"
                WriteLine(fail.New().Print(CultureInfo.InvariantCulture));
                // "Määrittelemätön virhe"
                WriteLine(fail.New().Print(CultureInfo.GetCultureInfo("fi")));
                // </05>
            }
            {
                // <06>
                // Create localized table
                IMessage msg = StatusCodes.Instance.BadUnexpected.New("obj");
                // </06>
            }
        }
    
        // <99>
        /// <summary></summary>
        public class StatusCodes : MessageDescriptions
        {
            /// <summary>Base id for datatype codes.</summary>
            public const int BaseCode = 0x20A10000;
            /// <summary>Singleton</summary>
            static Lazy<StatusCodes> instance = new Lazy<StatusCodes>(() => new StatusCodes().ReadSummaryXmls().LocalizeMessages(Localization.Default).SetAllReadOnly<StatusCodes>().SetReadOnly());
            /// <summary>Singleton</summary>
            public static StatusCodes Instance => instance.Value;
    
            /// <summary>Message description fields</summary>
            IMessageDescription badUnexpected = Create(0xA0A10001, nameof(badUnexpected), "'{object}': Unexpected error");
            IMessageDescription badArgumentNull = Create(0xA0A10002, nameof(badArgumentNull), "'{object}': Unexpected error");
            IMessageDescription goodResult = Create(0x20A10003, nameof(goodResult), "'{object}': Unexpected error");
    
            /// <summary>Create description</summary>
            static IMessageDescription Create(long id, string key, string templateText)
                => new MessageDescription($"Library.{char.ToUpper(key[0])}{key.Substring(1)}", id, templateText).SetHResult(id);
    
            /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
            public IMessageDescription BadUnexpected { get => badUnexpected; set => this.AssertWritable().badUnexpected = value; }
            /// <summary>Captured unexpected <see cref="System.Exception"/>.</summary>
            public IMessageDescription BadArgumentNull { get => badArgumentNull; set => this.AssertWritable().badArgumentNull = value; }
            /// <summary>Good result.</summary>
            public IMessageDescription GoodResult { get => goodResult; set => this.AssertWritable().goodResult = value; }
        }
        // </99>
    }
    
    Back to top Copyright © 2022 Toni Kalajainen, contact@avalanche.fi