Class ProviderBasedLocalizationService

Namespace: EPiServer.Framework.Localization

Assembly: EPiServer.Framework.dll

Syntax

[ServiceConfiguration(typeof(LocalizationService), Lifecycle = ServiceInstanceScope.Singleton, FactoryMember = "CreateLocalizationService")]
[InitializableModule]
public class ProviderBasedLocalizationService : LocalizationService, IConfigurableModule, IInitializableModule

Examples

How to register a provider in web.config.

<episerver.framework>
...
<localization fallbackBehavior="FallbackCulture, MissingMessage, Echo" fallbackCulture="en">
<providers>
<add physicalPath="c:\temp\resourceFolder"
   name="customResources"
   type="EPiServer.Framework.Localization.XmlResources.FileXmlLocalizationProvider" />
</providers>
</localization>
...
</episerver.framework>

How to register a provider using a physical path in a IInitializableModule.

using System;
using System.Collections.Specialized;
using System.IO;
using System.Linq;
using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.Framework.Localization;
using EPiServer.Framework.Localization.XmlResources;

namespace CodeSamples
{
[InitializableModule]
[ModuleDependency(typeof(FrameworkInitialization))]
public class CustomLanguageProviderInitializationWithPhysicalPath : IInitializableModule
{
private const string ProviderName = "customResources";
public void Initialize(InitializationEngine context)
{
     //Casts the current LocalizationService to a ProviderBasedLocalizationService to get access to the current list of providers
    ProviderBasedLocalizationService localizationService = context.Locate.Advanced.GetInstance<LocalizationService>() as ProviderBasedLocalizationService;
    if (localizationService != null)
    {
        string langFolder = @"c:\temp\resourceFolder";
        if (Directory.Exists(langFolder))
        {
            NameValueCollection configValues = new NameValueCollection();
            //This config value tells the provider where to find XML language documents.
            configValues.Add(FileXmlLocalizationProvider.PhysicalPathKey, langFolder);
            FileXmlLocalizationProvider localizationProvider = new FileXmlLocalizationProvider();
            //Instanciates the provider
            localizationProvider.Initialize(ProviderName, configValues);
            //Adds it at the end of the list of providers.
            localizationService.Providers.Add(localizationProvider);
        }
    }
}

public void Uninitialize(InitializationEngine context)
{
    //Casts the current LocalizationService to a ProviderBasedLocalizationService to get access to the current list of providers
    ProviderBasedLocalizationService localizationService = context.Locate.Advanced.GetInstance<LocalizationService>() as ProviderBasedLocalizationService;
    if (localizationService != null)
    {
        //Gets any provider that has the same name as the one initialized.
        LocalizationProvider localizationProvider = localizationService.Providers.FirstOrDefault(p => p.Name.Equals(ProviderName, StringComparison.Ordinal));
        if (localizationProvider != null)
        {
            //If found, remove it.
            localizationService.Providers.Remove(localizationProvider);
        }
    }
}

public void Preload(string[] parameters) { }
}
}

How to register a provider using a virtual path in a IInitializableModule.

using System;
using System.Linq;
using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.Framework.Localization;
using EPiServer.Framework.Localization.XmlResources;
using EPiServer.Web.Hosting;

namespace CodeSamples
{
[InitializableModule]
//A dependency to EPiServer CMS initialization is needed to be able to use a VPP
[ModuleDependency(typeof(EPiServer.Web.InitializationModule))] 
public class CustomLanguageProviderInitializationWithVirtualPath : IInitializableModule
{
private const string ProviderName = "CustomProviderName";

public void Initialize(InitializationEngine context)
{
    //Casts the current LocalizationService to a ProviderBasedLocalizationService to get access to the current list of providers
    ProviderBasedLocalizationService localizationService = context.Locate.Advanced.GetInstance<LocalizationService>() as ProviderBasedLocalizationService;
    if (localizationService != null)
    {
        VirtualPathXmlLocalizationProviderInitializer localizationProviderInitializer = 
            new VirtualPathXmlLocalizationProviderInitializer(GenericHostingEnvironment.VirtualPathProvider);
        //a VPP with the path below must be registered in the sites configuration.
        string virtualPath = "~/MyCustomLanguageVPP/";
        FileXmlLocalizationProvider localizationProvider = localizationProviderInitializer.GetInitializedProvider(virtualPath, ProviderName);
        //Inserts the provider first in the provider list so that it is prioritized over default providers.
        localizationService.Providers.Insert(0, localizationProvider);
    }
}

public void Uninitialize(InitializationEngine context)
{
    //Casts the current LocalizationService to a ProviderBasedLocalizationService to get access to the current list of providers
    ProviderBasedLocalizationService localizationService = context.Locate.Advanced.GetInstance<LocalizationService>() as ProviderBasedLocalizationService;
    if (localizationService != null)
    {
        //Gets any provider that has the same name as the one initialized.
        LocalizationProvider localizationProvider = localizationService.Providers.FirstOrDefault(p => p.Name.Equals(ProviderName, StringComparison.Ordinal));
        if (localizationProvider != null)
        {
            //If found, remove it.
            localizationService.Providers.Remove(localizationProvider);
        }
    }
}

public void Preload(string[] parameters) { }
}
}

Constructors

ProviderBasedLocalizationService()

Declaration

public ProviderBasedLocalizationService()

ProviderBasedLocalizationService(ResourceKeyHandler)

Declaration

public ProviderBasedLocalizationService(ResourceKeyHandler keyHandler)

Parameters

Properties

AvailableLocalizations

Declaration

public override IEnumerable<CultureInfo> AvailableLocalizations { get; }

Property Value

Overrides

Providers

Declaration

public IList<LocalizationProvider> Providers { get; protected set; }

Property Value

Remarks

Methods

ConfigureContainer(ServiceConfigurationContext)

Declaration

public void ConfigureContainer(ServiceConfigurationContext context)

Parameters

CreateInstance(ResourceKeyHandler, EPiServerFrameworkSection)

Declaration

public static LocalizationService CreateInstance(ResourceKeyHandler keyHandler, EPiServerFrameworkSection configuration)

Parameters

Returns

CreateLocalizationService(ResourceKeyHandler, FrameworkOptions, IServiceLocator)

Declaration

public static LocalizationService CreateLocalizationService(ResourceKeyHandler keyHandler, FrameworkOptions frameworkOptions, IServiceLocator serviceLocator)

Parameters

Returns

GetAllStringsByCulture(String, String[], CultureInfo)

Declaration

protected override IEnumerable<ResourceItem> GetAllStringsByCulture(string originalKey, string[] normalizedKey, CultureInfo culture)

Parameters

Returns

Overrides

See Also

Initialize(InitializationEngine)

Declaration

public void Initialize(InitializationEngine context)

Parameters

InitializeProviders(ProviderSettingsCollection)

Declaration

public virtual void InitializeProviders(ProviderSettingsCollection settings)

Parameters

LoadString(String[], String, CultureInfo)

Declaration

protected override string LoadString(string[] normalizedKey, string originalKey, CultureInfo culture)

Parameters

Returns

Overrides

See Also

Uninitialize(InitializationEngine)

Declaration

public void Uninitialize(InitializationEngine context)

Parameters

Implements

Extension Methods