SynonymsAttribute Class

Article
10/03/2012

Provides a comma-delimited list of connection property names that are synonymous with a primary connection property name.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.VisualStudio.Data.SynonymsAttribute

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

Syntax

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

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

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

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

public final class SynonymsAttribute extends Attribute

The SynonymsAttribute type exposes the following members.

Constructors

	Name	Description
	SynonymsAttribute	Class constructor. Initializes a new instance of the SynonymsAttribute class.

Top

Properties

	Name	Description
	Synonyms	Retrieves a comma-delimited list of connection property names that are synonymous with the connection property to which this attribute is attached.
	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 this object instance is equal to a specified object. (Overrides Attribute.Equals(Object).)
	GetHashCode	Retrieves the hash 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.)
	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

A provider should apply this attribute to a connection property when there are multiple property names that can refer to the same property value. It is used by the base DataConnectionProperties class to implement the GetSynonyms method, and allows changing the property name to use when graphically building connection properties.

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