Share via


IVsDataConnectionUIProperties Interface

Provides the ability to manipulate data connection properties in the context of a connection UI (for example, the data connection dialog box).

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

Syntax

'Declaration
Public Interface IVsDataConnectionUIProperties _
    Inherits IVsDataConnectionProperties, IDictionary(Of String, Object),  _
    ICollection(Of KeyValuePair(Of String, Object)), IEnumerable(Of KeyValuePair(Of String, Object)),  _
    IEnumerable, ICustomTypeDescriptor, INotifyPropertyChanged
public interface IVsDataConnectionUIProperties : IVsDataConnectionProperties, 
    IDictionary<string, Object>, ICollection<KeyValuePair<string, Object>>, 
    IEnumerable<KeyValuePair<string, Object>>, IEnumerable, ICustomTypeDescriptor, 
    INotifyPropertyChanged
public interface class IVsDataConnectionUIProperties : IVsDataConnectionProperties, 
    IDictionary<String^, Object^>, ICollection<KeyValuePair<String^, Object^>>, 
    IEnumerable<KeyValuePair<String^, Object^>>, IEnumerable, 
    ICustomTypeDescriptor, INotifyPropertyChanged
type IVsDataConnectionUIProperties =  
    interface 
        interface IVsDataConnectionProperties 
        interface IDictionary<string, Object>
        interface ICollection<KeyValuePair<string, Object>>
        interface IEnumerable<KeyValuePair<string, Object>>
        interface IEnumerable 
        interface ICustomTypeDescriptor 
        interface INotifyPropertyChanged 
    end
public interface IVsDataConnectionUIProperties extends IVsDataConnectionProperties, IDictionary<String, Object>, ICollection<KeyValuePair<String, Object>>, IEnumerable<KeyValuePair<String, Object>>, IEnumerable, ICustomTypeDescriptor, INotifyPropertyChanged

The IVsDataConnectionUIProperties 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 IsComplete When implemented by a class, gets a value indicating whether a given connection string is complete.
Public property IsExtensible When implemented by a class, gets or sets a Boolean value indicating whether the DDEX provider connection properties are extensible.
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. (Inherited from IVsDataConnectionProperties.)
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 GetAttributes Returns a collection of custom attributes for this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetClassName Returns the class name of this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetComponentName Returns the name of this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetConverter Returns a type converter for this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetDefaultEvent Returns the default event for this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetDefaultProperty Returns the default property for this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetEditor Returns an editor of the specified type for this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetEnumerator Returns an enumerator that iterates through the collection. (Inherited from IEnumerable<KeyValuePair<String, Object>>.)
Public method GetEvents() Returns the events for this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetEvents(array<Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter. (Inherited from ICustomTypeDescriptor.)
Public method GetProperties() Returns the properties for this instance of a component. (Inherited from ICustomTypeDescriptor.)
Public method GetProperties(array<Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter. (Inherited from ICustomTypeDescriptor.)
Public method GetPropertyOwner Returns an object that contains the property described by the specified property descriptor. (Inherited from ICustomTypeDescriptor.)
Public method GetSynonyms When implemented by a class, retrieves an array list of synonyms for a specified property.
Public method IsSensitive When implemented by a class, indicates whether a property contains sensitive information.
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. (Inherited from IVsDataConnectionProperties.)
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. (Inherited from IVsDataConnectionProperties.)
Public method Reset(String) When implemented by a class, removes the specified property from the current set of data connection properties. (Inherited from IVsDataConnectionProperties.)
Public method ToDisplayString When implemented by a class, retrieves a string representation of the current set of data connection properties that is suitable for on-screen display.
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. (Inherited from IVsDataConnectionProperties.)
Public method ToString When implemented by a class, retrieves the default string representation of the current connection properties. (Inherited from IVsDataConnectionProperties.)
Public method TryGetValue Gets the value associated with the specified key. (Inherited from IDictionary<String, Object>.)

Top

Events

  Name Description
Public event PropertyChanged Occurs when a property value changes. (Inherited from INotifyPropertyChanged.)

Top

Remarks

This interface is implemented by the DataConnectionProperties class in the DDEX Framework.

See Also

Reference

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace