Export (0) Print
Expand All

LocalizableAttribute Class

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

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

[AttributeUsageAttribute(AttributeTargets.All)] 
public sealed class LocalizableAttribute : Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.All) */ 
public final class LocalizableAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All) 
public final class LocalizableAttribute extends Attribute
Not applicable.

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 Attributes Overview and 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.
    }
 }

/** @attribute Localizable(true)
 */
/** @property
 */
public int get_MyProperty()
{
    // Insert code here.
    return 0;
}//get_MyProperty

/** @property 
 */
public void set_MyProperty(int value)
{
    // Insert code here.
}//set_MyProperty

public Localizable(true)
function get MyProperty() : int{
  // Insert code here.  Property goes on getter only when a property has
  // both a getter and setter.
  return 0
}

function set MyProperty(value: int){
  // 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.
}

// Gets the attributes for the property.
AttributeCollection attributes = TypeDescriptor.GetProperties(this).
    get_Item("MyProperty").get_Attributes();
// Checks to see if the property needs to be localized.
LocalizableAttribute myAttribute = (LocalizableAttribute)(attributes.
    get_Item(LocalizableAttribute.class.ToType()));
if (myAttribute.get_IsLocalizable()) {
    // Insert code here.
}

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

// Checks to see if the property needs to be localized.
var myAttribute : LocalizableAttribute = LocalizableAttribute(attributes(LocalizableAttribute))
if(myAttribute.IsLocalizable){
     // Insert code here.
}

System.Object
   System.Attribute
    System.ComponentModel.LocalizableAttribute

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 Millennium Edition, 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, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft