Share via


DataConnectionProperties Members

Include Protected Members
Include Inherited Members

Provides support for the parsing and formatting of connection strings containing these properties, as well as for strongly typed property storage, custom attributes, and synonyms.

The DataConnectionProperties type exposes the following members.

Constructors

 

Name

Description

Public method

DataConnectionProperties

Overloaded. Class constructor. Instantiates a nonparameterized instance of the DataConnectionProperties class.

Top

Methods

 

Name

Description

Public method

Add

Adds a new property to the current connection properties collection.

Protected method

AddProperty

Overloaded. Adds a property to the set of connection properties.

Public method

Contains

Tests whether a specified property is a member of the current set of connection properties.

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Public method

EquivalentTo

Retrieves a Boolean value indicating whether the current instance of the DataConnectionProperties class is equivalent to another DataConnectionProperties instance.

Protected method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Public method

GetBasicProperties

Retrieves an array of property names representing the set of "basic" properties known by the current DataConnectionProperties instance.

Public method

GetEnumerator

Retrieves an enumerator that enumerates over all the known connection properties and their values, if any.

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Protected method

GetNameAsString

Formats a property name for placement in a connection string.

Protected method

GetProperties

Overloaded. Retrieves a set of connection properties for the specified DDEX Provider.

Protected method

GetProperty

Retrieves the descriptor of a property with the specified property name.

Public method

GetSynonyms

Retrieves an array list of synonyms for a specified property.

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Protected method

GetValueAsString

Formats a property value for placement in a connection string.

Protected method

Initialize

Initializes the current DataConnectionProperties instance to its default state, then sets each property in the specified dictionary.

Protected method

InitializeProperties

Initializes the set of natively recognized properties for the current DataConnectionProperties instance.

Protected method

InitializeSynonyms

Initializes the set of synonyms available for each natively recognized property in the current DataConnectionProperties instance.

Protected method

InitializeValue

Initializes the value of a specified connection property.

Protected method

InitializeValues

Initializes values for a specified set of properties using a dictionary of name/value pairs.

Public method

IsSensitive

Indicates whether a property contains sensitive information.

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Protected method

ModifyProperty

Modifies an existing property of which the current DataConnectionProperties instance is natively aware.

Protected method

OnPropertyChanged

Raises the PropertyChanged event.

Public method

Parse

Disassembles the components of a connection string into a set of properties in the current DataConnectionProperties instance.

Protected method

ReadNameFromString

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.

Protected method

ReadValueFromString

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.

Public method

Remove

Removes a property from the current connection property collection.

Protected method

RemoveProperty

Removes a natively recognized property.

Public method

Reset

Overloaded. Resets the values of connection properties to an initial state.

Protected method

ResolveSynonym

Attempts to resolves a synonym for the PropertyDescriptor associated with a base property by returning the base property descriptor.

Protected method

SetSynonyms

Sets a list of strings as synonyms of a specified base property name.

Protected method

ShouldPersistProperty

Indicates whether a property should be persisted when building a connection string.

Public method

Test

Tests to assure that the current set of connection properties will successfully open a connection.

Public method

ToDisplayString

Retrieves a string representation of the current set of data connection properties that are suitable for on-screen display.

Public method

ToFullString

Retrieves a string representation of the current set of data connection properties for this instance.

Public method

ToString

Retrieves a full string representation of the current connection properties. (Overrides Object.ToString().)

Top

Properties

 

Name

Description

Public property

IsComplete

Retrieves a Boolean value indicating whether a given connection string is complete.

Public property

IsExtensible

Retrieves or sets a Boolean value indicating whether the DDEX Provider connection properties are extensible.

Public property

Item

Retrieves or sets a value for a specified property on the DDEX Provider.

Protected property

OrderedProperties

Retrieves a collection of property names specifying a reasonable (or necessary) order for the properties when represented in string form.

Top

Events

 

Name

Description

Public event

PropertyChanged

Event that fires on the occurrence of a change to a connection property.

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IDictionary.Add

Adds an element as a key/value pair to the specified IDictionary.

Explicit interface implemetationPrivate method

IDictionary.Clear

Removes all elements from the specified IDictionary.

Explicit interface implemetationPrivate method

IDictionary.Contains

Determines whether the IDictionary contains an element with the specified key.

Explicit interface implemetationPrivate method

ICollection.CopyTo

Copies the set of connection properties to an array, starting at the specified array index.

Explicit interface implemetationPrivate property

ICollection.Count

Retrieves the number of elements contained in the ICollection.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetAttributes

Retrieves a collection of custom attributes for the specified object.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetClassName

Retrieves the class name of the specified object.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetComponentName

Retrieves the name of the specified object.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetConverter

Retrieves a type converter for the specified object.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetDefaultEvent

Retrieves the default event for the specified object.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetDefaultProperty

Retrieves the default property for the specified object.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetEditor

Retrieves an editor of the specified type for this object.

Explicit interface implemetationPrivate method

IDictionary.GetEnumerator

Retrieves an IDictionaryEnumerator for the IDictionary.

Explicit interface implemetationPrivate method

IEnumerable.GetEnumerator

Retrieves an enumerator that is able to iterate through the connection properties collection.

Public method

GetEvents

Overloaded. Retrieves the events for this instance of a component.

Public method

GetProperties

Overloaded. Retrieves the properties for this instance of a component.

Explicit interface implemetationPrivate method

ICustomTypeDescriptor.GetPropertyOwner

Retrieves an object that contains the property described by the specified property descriptor.

Explicit interface implemetationPrivate property

IDictionary.IsFixedSize

Retrieves a Boolean value indicating whether the specified IDictionary has a fixed size.

Explicit interface implemetationPrivate property

IDictionary.IsReadOnly

Retrieves a Boolean indicating whether the IDictionary is read-only.

Explicit interface implemetationPrivate property

ICollection.IsSynchronized

Retrieves a value that indicates whether access to the connection properties collection is synchronized (thread safe).

Explicit interface implemetationPrivate property

IDictionary.Item

Retrieves an item, or element, with the specified key.

Explicit interface implemetationPrivate property

IDictionary.Keys

Retrieves an ICollection containing the keys for the IDictionary.

Explicit interface implemetationPrivate event

IDataConnectionProperties.PropertyChanged

Event that fires on the occurrence of a change to a connection property.

Explicit interface implemetationPrivate method

IDictionary.Remove

Removes the element with the specified key from the IDictionary.

Explicit interface implemetationPrivate property

ICollection.SyncRoot

Retrieves an object that can be used to synchronize access to the connection properties collection.

Explicit interface implemetationPrivate property

IDictionary.Values

Retrieves an ICollection containing the values in the specified IDictionary.

Top

See Also

Reference

DataConnectionProperties Class

Microsoft.VisualStudio.Data Namespace