NameAttribute Class

Article
02/23/2011

Specifies the string literal name of a given connection property when specified in a connection string.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.VisualStudio.Data.NameAttribute

Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class NameAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Property)]
public sealed class NameAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Property)]
public ref class NameAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Property)>]
type NameAttribute =  
    class
        inherit Attribute
    end

public final class NameAttribute extends Attribute

The NameAttribute type exposes the following members.

Constructors

	Name	Description
	NameAttribute	Class constructor. Initializes a new instance of the NameAttribute class with the specified connection property name.

Top

Properties

	Name	Description
	Name	Retrieves the string literal name of a given connection property.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Returns a value indicating whether the value of the current object instance is equal to a specified object. (Overrides Attribute.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the has code for the current object instance. (Overrides Attribute.GetHashCode().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

Use this class to work around restrictions on the naming of properties on classes (for example, they cannot contain spaces). A DDEX provider should apply this attribute to any connection property for which these restrictions create problems.

For example, the connection string for the Microsoft SQL Server data provider includes a property called Integrated Security. On a class this must be named "IntegratedSecurity" since properties cannot contain spaces; thus, this attribute is used to define the correct name in the connection string as "Integrated Security".

Inherits from Attribute class.

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