This documentation is archived and is not being maintained.

BamlLocalizableResourceKey Class

Represents a key for a BamlLocalizableResource that is used to identify localizable resources.

Namespace: System.Windows.Markup.Localizer
Assembly: PresentationFramework (in presentationframework.dll)

public class BamlLocalizableResourceKey
public class BamlLocalizableResourceKey
public class BamlLocalizableResourceKey
You cannot use this managed class in XAML.

This class represents a key that can uniquely identify a localizable value inside binary XAML (BAML). It is represented as a combination of a Uid, class name, and property name.

The Uid value must be added to the source Extensible Application Markup Language (XAML) file either by using the "updateUid" Microsoft build engine (MSBuild) task (for example, msbuild /t:updateUid myproj.proj), or manually. BAML without a Uid cannot be localized. The class name is the type name of the element that contains the localizable property. Property name refers to the property that has the localizable value. A special property called "$Content" is used to represent values that are implicitly assigned to an element. For example:

<TextBlock x:Uid="myBlock">Click </TextBlock>

The following example demonstrates how to use a BamlLocalizableResourceKey.

// Obtain the BAML stream.
Stream source = entry.Value as Stream;

// Create a BamlLocalizer on the stream.
BamlLocalizer localizer = new BamlLocalizer(source);
BamlLocalizationDictionary resources = localizer.ExtractResources();

// Write out all the localizable resources in the BAML.
foreach (DictionaryEntry resourceEntry in resources)
    BamlLocalizableResourceKey key = resourceEntry.Key as BamlLocalizableResourceKey;
    BamlLocalizableResource value = resourceEntry.Value as BamlLocalizableResource;
        "    {0}.{1}.{2} = {3}",


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0