AdoDotNetConnectionProperties Class

Definition

Namespace:

Microsoft.VisualStudio.Data.AdoDotNet

Assembly:

Microsoft.VisualStudio.Data.dll

Package:

Microsoft.VisualStudio.Data v17.10.40170

Provides an implementation of the DataConnectionProperties class using the ADO.NET connection string builder base class (DbConnectionStringBuilder).

public ref class AdoDotNetConnectionProperties : Microsoft::VisualStudio::Data::DataConnectionProperties, System::Collections::IDictionary, System::ComponentModel::ICustomTypeDescriptor

public class AdoDotNetConnectionProperties : Microsoft.VisualStudio.Data.DataConnectionProperties, System.Collections.IDictionary, System.ComponentModel.ICustomTypeDescriptor

type AdoDotNetConnectionProperties = class
    inherit DataConnectionProperties
    interface ICustomTypeDescriptor
    interface IDictionary
    interface ICollection
    interface IEnumerable

Public Class AdoDotNetConnectionProperties
Inherits DataConnectionProperties
Implements ICustomTypeDescriptor, IDictionary

Inheritance

Object

DataConnectionProperties

AdoDotNetConnectionProperties

Implements

ICollection IDictionary IEnumerable ICustomTypeDescriptor

Constructors

AdoDotNetConnectionProperties(String, String)	Parameterized class constructor. Instantiates a parameterized instance of the AdoDotNetConnectionProperties class that provides the ADO.NET provider invariant name and a provider connection string.
AdoDotNetConnectionProperties(String)	Class constructor. Instantiates a parameterized instance of the AdoDotNetConnectionProperties class that provides the ADO.NET provider name.

Properties

ConnectionStringBuilder	Retrieves the underlying ADO.NET connection string builder object for the current connection properties instance.
IsComplete	Retrieves a Boolean value indicating whether a given connection string is complete.
IsExtensible	Retrieves or sets a Boolean value indicating whether the DDEX Provider connection properties are extensible.
Item[String]	Retrieves or sets a value for a specified property on the DDEX Provider.
OrderedProperties	Retrieves a collection of property names specifying a reasonable (or necessary) order for the properties when represented in string form. (Inherited from DataConnectionProperties)

Methods

Add(String)	Adds a new property to the current connection properties collection.
AddProperty(PropertyDescriptor, Attribute[])	Dynamically adds a new property to the collection of properties natively recognized by the current instance of the DataConnectionProperties class. (Inherited from DataConnectionProperties)
AddProperty(String, Type, Attribute[])	Dynamically adds a new property to the collection of properties natively recognized by this data connection properties instance. (Inherited from DataConnectionProperties)
Contains(String)	Tests whether a specified property is a member of the current set of connection properties.
EquivalentTo(DataConnectionProperties)	Tests whether the current instance of the class is equivalent to another class instance.
GetBasicProperties()	Retrieves an array of property name values representing the set of "basic" properties recognizable by the current AdoDotNetConnectionProperties class instance.
GetEnumerator()	Retrieves an enumerator that enumerates over all of the known connection properties and their values, if any.
GetNameAsString(String)	Formats a property name for placement in a connection string. (Inherited from DataConnectionProperties)
GetProperties()	Retrieves the collection of descriptors of all currently known properties. (Inherited from DataConnectionProperties)
GetProperties(Attribute[])	Retrieves the collection of descriptors of currently known properties that match a specified set of attributes. (Inherited from DataConnectionProperties)
GetProperty(String)	Retrieves the descriptor of a property with the specified property name. (Inherited from DataConnectionProperties)
GetSynonyms(String)	Retrieves an array list of synonyms for a specified data connection property.
GetValueAsString(String)	Formats a property value for placement in a connection string. (Inherited from DataConnectionProperties)
Initialize(IDictionary)	Initializes the current DataConnectionProperties instance to its default state, then sets each property in the specified dictionary. (Inherited from DataConnectionProperties)
InitializeProperties()	Initializes the set of natively recognized properties for the current DataConnectionProperties instance. (Inherited from DataConnectionProperties)
InitializeSynonyms()	Initializes the set of synonyms available for each natively recognized property in the current DataConnectionProperties instance. (Inherited from DataConnectionProperties)
InitializeValue(String, Object)	Initializes the value of a specified connection property. (Inherited from DataConnectionProperties)
InitializeValues(IDictionary)	Initializes values for a specified set of properties using a dictionary of name/value pairs. (Inherited from DataConnectionProperties)
IsSensitive(String)	Returns a Boolean value indicating whether a specified property contains sensitive information.
ModifyProperty(String, Attribute[])	Modifies an existing property of which the current DataConnectionProperties instance is natively aware. (Inherited from DataConnectionProperties)
OnPropertyChanged(DataConnectionPropertyChangedEventArgs)	Raises the PropertyChanged event. (Inherited from DataConnectionProperties)
Parse(String)	Disassembles the components of a connection string into a set of connection properties as set in the current AdoDotNetConnectionProperties class instance.
ReadNameFromString(String, Int32)	Reads a property name from a connection string starting at a specified index, then updates the index to point to a position immediately following the property name. (Inherited from DataConnectionProperties)
ReadValueFromString(String, String, Int32)	Reads a property value from a connection string starting at a specified index, converts it to the correct type, and updates the index to point to a position following the property name. (Inherited from DataConnectionProperties)
Remove(String)	Removes a property from the current connection property collection.
RemoveProperty(String)	Removes a natively recognized property. (Inherited from DataConnectionProperties)
Reset()	Resets a connection property to its initial value.
Reset(String)	Reverts a property value to its initial value.
ResolveSynonym(String, Boolean)	Attempts to resolves a synonym for the PropertyDescriptor associated with a base property by returning the base property descriptor. (Inherited from DataConnectionProperties)
SetSynonyms(String, String[])	Sets a list of strings as synonyms of a specified base property name. (Inherited from DataConnectionProperties)
ShouldPersistProperty(String)	Indicates whether a property should be persisted when building a connection string. (Inherited from DataConnectionProperties)
Test()	Tests that the current set of connection properties will successfully open a connection.
ToDisplayString()	Retrieves a string representation of the current set of data connection properties that are suitable for on-screen display.
ToFullString()	Retrieves a string representation of the current set of data connection properties for this instance.
ToString()	Retrieves a full string representation of the current connection properties. (Inherited from DataConnectionProperties)
ToTestString()	Retrieves a form of the connection string that can be used for testing the connection.

Events

PropertyChanged

Event that fires on the occurrence of a change to a connection property. (Inherited from DataConnectionProperties)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	Copies the set of connection properties to an array, starting at the specified array index.
ICollection.Count	Retrieves the number of elements contained in the current ICollection instance.
ICollection.IsSynchronized	Retrieves a value that indicates whether access to the connection properties collection is synchronized (thread safe).
ICollection.SyncRoot	Retrieves an object that can be used to synchronize access to the connection properties collection.
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()	Retrieves the events for the specified instance of a component.
ICustomTypeDescriptor.GetEvents(Attribute[])	Retrieves the events for this instance of a component using the specified attribute array as a filter.
ICustomTypeDescriptor.GetProperties()	Retrieves the properties for the specified instance of a component.
ICustomTypeDescriptor.GetProperties(Attribute[])	Retrieves the properties for the specified instance of a component using the attribute array as a filter.
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)	Retrieves an object that contains the property described by the specified property descriptor.
IDataConnectionProperties.PropertyChanged	(Inherited from DataConnectionProperties)
IDictionary.Add(Object, Object)	Adds an element as a key/value pair to the specified IDictionary instance.
IDictionary.Clear()	Removes all elements from the specified IDictionary instance.
IDictionary.Contains(Object)	Determines whether the current IDictionary instance contains an element with the specified key.
IDictionary.GetEnumerator()	Returns an IDictionaryEnumerator object for the IDictionary instance.
IDictionary.IsFixedSize	Retrieves a Boolean value indicating whether the specified IDictionary instance has a fixed size.
IDictionary.IsReadOnly	Retrieves a Boolean indicating whether the IDictionary instance is read-only.
IDictionary.Item[Object]	Retrieves an item, or element, with the specified key from the current IDictionary instance.
IDictionary.Keys	Retrieves an ICollection object containing the keys for the IDictionary instance.
IDictionary.Remove(Object)	Removes the element with the specified key from the IDictionary instance.
IDictionary.Values	Retrieves an ICollection object containing the values in the specified IDictionary instance.
IEnumerable.GetEnumerator()	Retrieves an enumerator that is able to iterate through the connection properties collection.