Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

LocalizableAttribute Class

Specifies whether a property should be localized. This class cannot be inherited.

System.Object
  System.Attribute
    System.ComponentModel.LocalizableAttribute

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)

[AttributeUsageAttribute(AttributeTargets.All)]
public sealed class LocalizableAttribute : Attribute

The LocalizableAttribute type exposes the following members.

  NameDescription
Public methodLocalizableAttributeInitializes a new instance of the LocalizableAttribute class.
Top

  NameDescription
Public propertyIsLocalizableGets a value indicating whether a property should be localized.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsReturns whether the value of the given object is equal to the current LocalizableAttribute. (Overrides Attribute.Equals(Object).)
Public methodGetHashCodeReturns the hash code for this instance. (Overrides Attribute.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeDetermines if this attribute is the default. (Overrides Attribute.IsDefaultAttribute().)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultSpecifies the default value, which is No. This static field is read-only.
Public fieldStatic memberNoSpecifies that a property should not be localized. This static field is read-only.
Public fieldStatic memberYesSpecifies that a property should be localized. This static field is read-only.
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

When code is generated for a component, members that are marked with the LocalizableAttribute set to true have their property values saved in resource files. You can localize these resource files without modifying the code.

By default, members that have no localizable attribute or are marked with the LocalizableAttribute set to false will have their property values persisted to code, if the data type allows. Otherwise, if the main component is set to Localizable, all properties will be persisted to the resource file. The default is false.

NoteNote

When you mark a property with the LocalizableAttribute set to true, the value of this attribute is set to the constant member Yes. For a property marked with the LocalizableAttribute set to false, the value is No. Therefore, when you want to check the value of this attribute in your code, you must specify the attribute as LocalizableAttribute.Yes or LocalizableAttribute.No.

For more information, see Extending Metadata Using Attributes.

The following example marks a property as needing to be localized.

[Localizable(true)]
 public int MyProperty {
    get {
       // Insert code here. 
       return 0;
    }
    set {
       // Insert code here.
    }
 }

The next example shows how to check the value of the LocalizableAttribute for MyProperty. First, the code gets a PropertyDescriptorCollection with all the properties for the object. Then, the code gets MyProperty from the PropertyDescriptorCollection. Next, it returns the attributes for this property and saves them in the attributes variable.

Finally, the code sets myAttribute to the value of the LocalizableAttribute in the AttributeCollection and checks whether the property needs to be localized.

// Gets the attributes for the property.
AttributeCollection attributes = 
TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;

// Checks to see if the property needs to be localized.
LocalizableAttribute myAttribute = 
(LocalizableAttribute)attributes[typeof(LocalizableAttribute)];
if(myAttribute.IsLocalizable) {
// Insert code here.
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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