CultureAndRegionInfoBuilder.CreateFromLdml Method (String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Reconstitutes a CultureAndRegionInfoBuilder object from a specified XML file that contains a representation of the object.

Namespace:   System.Globalization
Assembly:  sysglobl (in sysglobl.dll)

public static CultureAndRegionInfoBuilder CreateFromLdml(
	string xmlFileName


Type: System.String

A file name that contains the XML representation of a CultureAndRegionInfoBuilder object.

Return Value

Type: System.Globalization.CultureAndRegionInfoBuilder

A new object that is equivalent to the information stored in the xmlFileName parameter.

Exception Condition

xmlFileName is null.


xmlFileName is an empty string (""), or invalid file or path name.


The data in xmlFileName is not in valid XML format.


An I/O error occurred while accessing xmlFileName.


The data in xmlFileName is not in valid LDML format.

The xmlFileName parameter specifies a file name that contains the XML representation of a CultureAndRegionInfoBuilder object. The format of the XML file is called Locale Data Markup Language (LDML) version 1.1. A new CultureAndRegionInfoBuilder object is created and initialized with the data in xmlFileName. The Save method performs the reverse operation of the CreateFromLdml method.

In the LDML file, the properties of a culture are specified as child elements of the <special> element in the <identity> section. A property value is typically specified by the element's type attribute. For example, the following excerpt from an LDML file defines a culture's parent as the English neutral culture.

   <version number="1.1">ldml version 1.1</version>
   <generation date="2012-05-16" />
   <special xmlns:msLocale="">
      <!—content removed -->
      <msLocale:parentName type="en" />
      <!—content removed -->

For more information about the LDML standard, see Unicode Technical Standard #35, "Locale Data Markup Language (LDML)" on the Unicode Consortium website.

The following example demonstrates the Save and CreateFromLdml methods.

// This example demonstrates the CultureAndRegionInfoBuilder.Save and 
// CreateFromLdml methods.
// Compile this example with a reference to sysglobl.dll.

using System;
using System.Globalization;
using System.IO;
using System.Xml;

class Sample 
    public static void Main() 
    string savedCARIB = "mySavedCARIB.xml";
    string msg1 = "The name of the original CultureAndRegionInfoBuilder" +
                  " is \"{0}\".";
    string msg2 = "Reconstituting the CultureAndRegionInfoBuilder object " +
                  "from \"{0}\".";
    string msg3 = "The name of the reconstituted CultureAndRegionInfoBuilder" +
                  " is \"{0}\".";

// Construct a new, privately used culture that extends the en-US culture 
// provided by the .NET Framework. In this sample, the CultureAndRegion-
// Types.Specific parameter creates a minimal CultureAndRegionInfoBuilder 
// object that you must populate with culture and region information.

    CultureAndRegionInfoBuilder cib1 = null;
    CultureAndRegionInfoBuilder cib2 = null;
    try {
        cib1 = new CultureAndRegionInfoBuilder(
                           "x-en-US-sample", CultureAndRegionModifiers.None);
    catch (ArgumentException ae)

// Populate the new CultureAndRegionInfoBuilder object with culture information.
    CultureInfo ci = new CultureInfo("en-US");

// Populate the new CultureAndRegionInfoBuilder object with region information.
    RegionInfo  ri = new RegionInfo("US");

// Display a property of the new custom culture.
    Console.WriteLine(msg1, cib1.CultureName);

// Save the new CultureAndRegionInfoBuilder object in the specified file in
// LDML format. The file is saved in the same directory as the application 
// that calls the Save method.

    Console.WriteLine("Saving the custom culture to a file...");
    try {
        cib1.Save( savedCARIB );
    catch (IOException exc)
        Console.WriteLine("** I/O exception: {0}", exc.Message);

// Create a new CultureAndRegionInfoBuilder object from the persisted file.
    Console.WriteLine(msg2, savedCARIB);
    try {
        cib2 = CultureAndRegionInfoBuilder.CreateFromLdml( savedCARIB );
    catch (XmlException xe)
        Console.WriteLine("** XML validation exception: {0}", xe.Message);

// Display a property of the resonstituted custom culture.
    Console.WriteLine(msg3, cib2.CultureName);

// At this point you could call the Register method and make the reconstituted
// custom culture available to other applications. The mySavedCARIB.xml file
// remains on your computer.

This code example produces the following results:

The name of the original CultureAndRegionInfoBuilder is "x-en-US-sample".
Saving the custom culture to a file...
Reconstituting the CultureAndRegionInfoBuilder object from "mySavedCARIB.xml".
The name of the reconstituted CultureAndRegionInfoBuilder is "x-en-US-sample".


.NET Framework
Available since 2.0
Return to top