BamlLocalizableResourceKey Class

 

Represents a key that is used to identify localizable resources in a BamlLocalizationDictionary.

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

System.Object
  System.Windows.Markup.Localizer.BamlLocalizableResourceKey

public class BamlLocalizableResourceKey

NameDescription
System_CAPS_pubmethodBamlLocalizableResourceKey(String, String, String)

Initializes a new instance of the BamlLocalizableResourceKey class with the supplied Uid, class name, and property name.

NameDescription
System_CAPS_pubpropertyAssemblyName

Gets the name of the assembly that defines the type of the localizable resource as declared by its ClassName.

System_CAPS_pubpropertyClassName

Gets the class name component of this BamlLocalizableResourceKey.

System_CAPS_pubpropertyPropertyName

Gets the property name component of this BamlLocalizableResourceKey.

System_CAPS_pubpropertyUid

Gets the Uid component of this BamlLocalizableResourceKey.

NameDescription
System_CAPS_pubmethodEquals(BamlLocalizableResourceKey)

Compares two instances of BamlLocalizableResourceKey for equality.

System_CAPS_pubmethodEquals(Object)

Compares an object to an instance of BamlLocalizableResourceKey for equality.(Overrides Object.Equals(Object).)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Returns an integer hash code representing this instance.(Overrides Object.GetHashCode().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

This class represents a key that can uniquely identify a localizable value inside binary XAML (BAML). It represents 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) target (for example, msbuild /t:updateuid myproj.proj), or manually in the markup. BAML without a Uid cannot be localized. The class name is the type name of the element that contains the localizable property. The property name refers to the property that has the localizable value. A special property called "$Content" is used to represent values that are the initialization text or content property of an element. For example the $Content property name would apply to the initialization text Click in the following XAML:

<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;
    Console.WriteLine(
        "    {0}.{1}.{2} = {3}",
        key.Uid,
        key.ClassName,
        key.PropertyName,
        value.Content
        );                                
}

.NET Framework
Available since 3.0

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

Return to top
Show: