Share via

IVsDataConnectionProperties Interface

  • Article

Represents the interface that exposes methods and properties for the parsing and formatting of connection strings, as well as for storage of strongly typed properties, custom attributes, and synonyms.

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

Syntax

'Declaration
Public Interface IVsDataConnectionProperties _
    Inherits IDictionary(Of String, Object), ICollection(Of KeyValuePair(Of String, Object)),  _
    IEnumerable(Of KeyValuePair(Of String, Object)), IEnumerable

public interface IVsDataConnectionProperties : IDictionary<string, Object>, 
    ICollection<KeyValuePair<string, Object>>, IEnumerable<KeyValuePair<string, Object>>, 
    IEnumerable

public interface class IVsDataConnectionProperties : IDictionary<String^, Object^>, 
    ICollection<KeyValuePair<String^, Object^>>, IEnumerable<KeyValuePair<String^, Object^>>, 
    IEnumerable

type IVsDataConnectionProperties =  
    interface 
        interface IDictionary<string, Object>
        interface ICollection<KeyValuePair<string, Object>>
        interface IEnumerable<KeyValuePair<string, Object>>
        interface IEnumerable 
    end

public interface IVsDataConnectionProperties extends IDictionary<String, Object>, ICollection<KeyValuePair<String, Object>>, IEnumerable<KeyValuePair<String, Object>>, IEnumerable

The IVsDataConnectionProperties type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of elements contained in the ICollection<T>. (Inherited from ICollection<KeyValuePair<String, Object>>.)
Public property IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. (Inherited from ICollection<KeyValuePair<String, Object>>.)
Public property Item Gets or sets the element with the specified key. (Inherited from IDictionary<String, Object>.)
Public property Keys Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>. (Inherited from IDictionary<String, Object>.)
Public property Values Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>. (Inherited from IDictionary<String, Object>.)

Top

Methods

  Name Description
Public method Add(T) Adds an item to the ICollection<T>. (Inherited from ICollection<KeyValuePair<String, Object>>.)
Public method Add(TKey, TValue) Adds an element with the provided key and value to the IDictionary<TKey, TValue>. (Inherited from IDictionary<String, Object>.)
Public method Add(String, Type, Object) When implemented by a class, adds a new property to the current connection properties collection.
Public method Clear Removes all items from the ICollection<T>. (Inherited from ICollection<KeyValuePair<String, Object>>.)
Public method Contains Determines whether the ICollection<T> contains a specific value. (Inherited from ICollection<KeyValuePair<String, Object>>.)
Public method ContainsKey Determines whether the IDictionary<TKey, TValue> contains an element with the specified key. (Inherited from IDictionary<String, Object>.)
Public method CopyTo Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. (Inherited from ICollection<KeyValuePair<String, Object>>.)
Public method GetEnumerator Returns an enumerator that iterates through the collection. (Inherited from IEnumerable<KeyValuePair<String, Object>>.)
Public method Parse When implemented by a class, disassembles the components of a connection string into a set of properties in the current DataConnectionProperties instance.
Public method Remove(TKey) Removes the element with the specified key from the IDictionary<TKey, TValue>. (Inherited from IDictionary<String, Object>.)
Public method Remove(T) Removes the first occurrence of a specific object from the ICollection<T>. (Inherited from ICollection<KeyValuePair<String, Object>>.)
Public method Reset() When implemented by a class, resets the values of connection properties to an initial state.
Public method Reset(String) When implemented by a class, removes the specified property from the current set of data connection properties.
Public method ToSafeString When implemented by a class, retrieves a string representation of the current set of data connection properties that excludes sensitive properties or properties that should not be persisted.
Public method ToString When implemented by a class, retrieves the default string representation of the current connection properties.
Public method TryGetValue Gets the value associated with the specified key. (Inherited from IDictionary<String, Object>.)

Top

Remarks

In the simplest case, a derived class should add properties to its class and place component attributes on these properties to customize their behavior. In a more advanced case, a derived class can override the parsing and formatting code, and dynamically change any of the properties depending on specific actions, such as setting the value of a property.

This interface has a base implementation in the DDEX Framework.

See Also

Reference

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace