This documentation is archived and is not being maintained.

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 NotInheritable Class LocalizableAttribute _
	Inherits Attribute
Dim instance As LocalizableAttribute

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.


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 Property MyProperty() As Integer 
        ' Insert code here. 
        Return 0
    End Get 
        ' Insert code here. 
    End Set  
End Property

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. 
Dim attributes As AttributeCollection = TypeDescriptor.GetProperties(Me)("MyProperty").Attributes

' Checks to see if the property needs to be localized. 
Dim myAttribute As LocalizableAttribute = CType(attributes(GetType(LocalizableAttribute)), LocalizableAttribute)
If myAttribute.IsLocalizable Then 
     ' Insert code here. 
End If


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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0