AdoDotNetConnectionProperties Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Data.Framework.AdoDotNet

Assembly:: Microsoft.VisualStudio.Data.Framework.dll

Package:: Microsoft.VisualStudio.Data.Framework v17.10.40170

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an implementation of the IVsDataConnectionProperties and IVsDataConnectionUIProperties interfaces using the ADO .NET DbConnectionStringBuilder object.

public ref class AdoDotNetConnectionProperties : Microsoft::VisualStudio::Data::Framework::DataSiteableObject<Microsoft::VisualStudio::Data::Core::IVsDataProvider ^>, Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataConnectionUIProperties, System::Collections::Generic::ICollection<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>, System::Collections::Generic::IDictionary<System::String ^, System::Object ^>, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>, System::ComponentModel::ICustomTypeDescriptor, System::ComponentModel::INotifyPropertyChanged

public class AdoDotNetConnectionProperties : Microsoft.VisualStudio.Data.Framework.DataSiteableObject<Microsoft.VisualStudio.Data.Core.IVsDataProvider>, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataConnectionUIProperties, System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IDictionary<string,object>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object>>, System.ComponentModel.ICustomTypeDescriptor, System.ComponentModel.INotifyPropertyChanged

type AdoDotNetConnectionProperties = class
    inherit DataSiteableObject<IVsDataProvider>
    interface IVsDataConnectionProperties
    interface IDictionary<string, obj>
    interface ICollection<KeyValuePair<string, obj>>
    interface seq<KeyValuePair<string, obj>>
    interface IEnumerable
    interface IVsDataConnectionUIProperties
    interface ICustomTypeDescriptor
    interface INotifyPropertyChanged

Public Class AdoDotNetConnectionProperties
Inherits DataSiteableObject(Of IVsDataProvider)
Implements ICollection(Of KeyValuePair(Of String, Object)), ICustomTypeDescriptor, IDictionary(Of String, Object), IEnumerable(Of KeyValuePair(Of String, Object)), INotifyPropertyChanged, IVsDataConnectionUIProperties

Inheritance: Object

DataSiteableObject<IVsDataProvider>
AdoDotNetConnectionProperties

Implements: IVsDataConnectionProperties IVsDataConnectionUIProperties ICollection<KeyValuePair<String,Object>> ICollection<KeyValuePair<TKey,TValue>> IDictionary<String,Object> IEnumerable<KeyValuePair<String,Object>> IEnumerable<KeyValuePair<TKey,TValue>> IEnumerable<T> IEnumerable ICustomTypeDescriptor INotifyPropertyChanged

Constructors

AdoDotNetConnectionProperties()

Initializes a new instance of the AdoDotNetConnectionProperties class.

Properties

ConnectionStringBuilder	Gets the underlying ADO.NET connection string builder object for the current connection properties instance.
Count	Gets the number of connection properties.
IsComplete	Gets a value indicating whether sufficient connection properties have been set for the connection string.
IsExtensible	Gets a value indicating whether the DDEX provider connection properties are extensible.
Item[String]	Gets or sets a value for a specified property on the DDEX provider. Raises the PropertyChanged event if the property is set.
Keys	Gets all the properties that are part of the data connection string.
Site	Gets or sets the object site. (Inherited from DataSiteableObject<T>)
Values	Gets the values of the connection string.

Methods

Add(String, Object)	Adds a new property to the current connection properties collection. Raises the PropertyChanged event.
Add(String, Type, Object)	Adds a new property to the current connection properties collection.
Contains(KeyValuePair<String,Object>)	Tests whether a specified property name and value pair is a member of the current set of connection properties.
ContainsKey(String)	Tests whether the specified property name is a member of the current set of connection properties.
CopyTo(KeyValuePair<String,Object>[], Int32)	Copies the set of connection properties to an array, starting at the specified array index.
GetSynonyms(String)	Retrieves an array list of synonyms for a specified data connection property.
IsSensitive(String)	Returns a Boolean value indicating whether a specified property contains sensitive information.
OnPropertyChanged(PropertyChangedEventArgs)	Raises the PropertyChanged event when a property changes in the data connection string.
OnSiteChanged(EventArgs)	Raises an event if the Site has changed.
Parse(String)	Disassembles the components of a connection string into a set of connection properties as set in the current AdoDotNetConnectionProperties class instance. Raises the PropertyChanged event.
Remove(String)	Removes a property from the current connection property collection.
Reset()	Resets a connection property to its initial value and raises the PropertyChanged event.
Reset(String)	Removes the given property from the connection string and raises the PropertyChanged event.
ToDisplayString()	Retrieves a string representation of the current set of data connection properties that are suitable for on-screen display.
ToSafeString()	Returns a string representation of the current set of data connection properties, excluding the sensitive properties that should be serialized.
ToString()	Returns a string representation of the current set of data connection properties.
TryGetValue(String, Object)	Retrieves a value corresponding to the supplied key by calling this method on the .NET Framework connection string builder base class (DbConnectionStringBuilder).

Events

PropertyChanged	Occurs on the occurrence of a change to a connection property.
SiteChanged	Occurs when the Site property is changed. (Inherited from DataSiteableObject<T>)

Explicit Interface Implementations

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)
ICollection<KeyValuePair<String,Object>>.Clear()
ICollection<KeyValuePair<String,Object>>.IsReadOnly
ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)
ICustomTypeDescriptor.GetAttributes()	Retrieves a collection of custom attributes for the specified object.
ICustomTypeDescriptor.GetClassName()	Retrieves the class name of the specified object.
ICustomTypeDescriptor.GetComponentName()	Retrieves the name of the specified object.
ICustomTypeDescriptor.GetConverter()	Retrieves a type converter for the specified object.
ICustomTypeDescriptor.GetDefaultEvent()	Retrieves the default event for the specified object.
ICustomTypeDescriptor.GetDefaultProperty()	Retrieves the default property for the specified object.
ICustomTypeDescriptor.GetEditor(Type)	Retrieves an editor of the specified type for this object.
ICustomTypeDescriptor.GetEvents()	For a description of this member, see GetEvents().
ICustomTypeDescriptor.GetEvents(Attribute[])	For a description of this member, see GetEvents().
ICustomTypeDescriptor.GetProperties()	For a description of this member, see GetProperties().
ICustomTypeDescriptor.GetProperties(Attribute[])	For a description of this member, see GetProperties().
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)	For a description of this member, see GetPropertyOwner(PropertyDescriptor).
IEnumerable.GetEnumerator()	Retrieves an enumerator that enumerates over all of the known connection properties and their values, if any.
IEnumerable<KeyValuePair<String,Object>>.GetEnumerator()

Extension Methods

AddRange<TKey,TValue>(IDictionary<TKey,TValue>, IDictionary<TKey,TValue>, Boolean)	Add one dictionary content to the another dictionary
GetOrDefault<TK,TV>(IDictionary<TK,TV>, TK)	Gets a value by the given key.
EmptyIfNull<T>(IEnumerable<T>)	Return this enumeration in case it is not null. In case it is null return empty enumeration.

Applies to

Share via