AttributeUsageAttribute Class

Article
01/16/2013

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Specifies the usage of another attribute class. This class cannot be inherited.

Inheritance Hierarchy

System. . :: . .Object
System. . :: . .Attribute
System..::..AttributeUsageAttribute

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

Syntax

'Declaration
<SerializableAttribute> _
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := True)> _
Public NotInheritable Class AttributeUsageAttribute _
    Inherits Attribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Class, Inherited = true)]
public sealed class AttributeUsageAttribute : Attribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets::Class, Inherited = true)]
public ref class AttributeUsageAttribute sealed : public Attribute

[<Sealed>]
[<SerializableAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = true)>]
type AttributeUsageAttribute =  
    class
        inherit Attribute
    end

public final class AttributeUsageAttribute extends Attribute

The AttributeUsageAttribute type exposes the following members.

Constructors

	Name	Description
	AttributeUsageAttribute	Initializes a new instance of the AttributeUsageAttribute class with the specified list of AttributeTargets, the AllowMultiple value, and the Inherited value.

Top

Properties

	Name	Description
	AllowMultiple	Gets or sets a Boolean value indicating whether more than one instance of the indicated attribute can be specified for a single program element.
	Inherited	Gets or sets a Boolean value indicating whether the indicated attribute can be inherited by derived classes and overriding members.
	ValidOn	Gets a set of values identifying which program elements that the indicated attribute can be applied to.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

When you are defining your own attribute class, you can control the manner in which it is used by placing an AttributeUsageAttribute on your attribute class. The indicated attribute class must derive from Attribute, either directly or indirectly.

Attribute classes have positional and named parameters. Each public constructor for an attribute class defines a valid sequence of positional parameters for that class. Named parameters are defined by the non-static, public, and read-write fields or properties of the attribute class.

The three properties of AttributeUsageAttribute are set by defining the following parameters:

ValidOn

This positional parameter specifies the program elements that the indicated attribute can be placed on. The set of all possible elements that you can place an attribute on is listed in the AttributeTargets enumeration. You can combine several AttributeTargets values using a bitwise OR operation to get the desired combination of valid program elements.

AllowMultiple

This named parameter specifies whether the indicated attribute can be specified more than once for a given program element.

Inherited

This named parameter specifies whether the indicated attribute can be inherited by derived classes and overriding members.

Thread Safety

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

Share via