LocalizableAttribute Class

Definition

Указывает, должно ли быть локализовано свойство.Specifies whether a property should be localized. Этот класс не может быть унаследован.This class cannot be inherited.

public ref class LocalizableAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class LocalizableAttribute : Attribute
public sealed class LocalizableAttribute : Attribute
type LocalizableAttribute = class
    inherit Attribute
Public NotInheritable Class LocalizableAttribute
Inherits Attribute
Inheritance
LocalizableAttribute
Attributes

Examples

В следующем примере свойство отмечается как требующее локализации.The following example marks a property as needing to be localized.

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

      void set( int value )
      {
         // Insert code here.
      }
   }
[Localizable(true)]
 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    }
    set {
       // Insert code here.
    }
 }
<Localizable(True)> _
Public Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

В следующем примере показано, как проверить значение LocalizableAttribute для MyProperty.The next example shows how to check the value of the LocalizableAttribute for MyProperty. Во-первых, код получает PropertyDescriptorCollection со всеми свойствами для объекта.First, the code gets a PropertyDescriptorCollection with all the properties for the object. Затем код получает MyProperty из PropertyDescriptorCollection.Then, the code gets MyProperty from the PropertyDescriptorCollection. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной attributes.Next, it returns the attributes for this property and saves them in the attributes variable.

Наконец, в коде задается myAttribute значение LocalizableAttribute в AttributeCollection и проверяется, нужно ли локализовать свойство.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 = dynamic_cast<LocalizableAttribute^>(attributes[ LocalizableAttribute::typeid ]);
if ( myAttribute->IsLocalizable )
{
   // Insert code here.
}
// 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.
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

Remarks

При создании кода для компонента члены, помеченные LocalizableAttribute, для которых задано true, имеют значения свойств, сохраненные в файлах ресурсов.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.

По умолчанию элементы, которые не имеют локализуемого атрибута или помечены атрибутом LocalizableAttribute со значением false, будут сохранять значения их свойств в коде, если это разрешено типом данных.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. В противном случае, если для основного компонента задано значение Localizable, все свойства будут сохранены в файле ресурсов.Otherwise, if the main component is set to Localizable, all properties will be persisted to the resource file. Значение по умолчанию — false.The default is false.

Note

При пометке свойства с LocalizableAttribute, для которого задано значение true, для этого атрибута задается константный элемент Yes.When you mark a property with the LocalizableAttribute set to true, the value of this attribute is set to the constant member Yes. Для свойства, помеченного LocalizableAttribute false, значением будет No.For a property marked with the LocalizableAttribute set to false, the value is No. Поэтому, если требуется проверить значение этого атрибута в коде, необходимо указать атрибут как LocalizableAttribute.Yes или LocalizableAttribute.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.

Constructors

LocalizableAttribute(Boolean)

Инициализирует новый экземпляр класса LocalizableAttribute.Initializes a new instance of the LocalizableAttribute class.

Fields

Default

Определяет значение по умолчанию, которое равно атрибуту No.Specifies the default value, which is No. Это статическое (static) поле доступно только для чтения.This static field is read-only.

No

Определяет, что свойство не должно быть локализовано.Specifies that a property should not be localized. Это статическое (static) поле доступно только для чтения.This static field is read-only.

Yes

Определяет, что свойство должно быть локализовано.Specifies that a property should be localized. Это статическое (static) поле доступно только для чтения.This static field is read-only.

Properties

IsLocalizable

Возвращает значение, показывающее, должно ли быть локализовано свойство.Gets a value indicating whether a property should be localized.

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Возвращает значение, показывающее, равно ли значение данного объекта текущему атрибуту LocalizableAttribute.Returns whether the value of the given object is equal to the current LocalizableAttribute.

GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

Определяет, является ли этот атрибут используемым по умолчанию.Determines if this attribute is the default.

IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also