Share via


DataConnectionProperties Members

Include Protected Members
Include Inherited Members

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

The DataConnectionProperties type exposes the following members.

Constructors

 

Name

Description

Protected method

DataConnectionProperties

Overloaded. Initializes a non-parameterized instance of the DataConnectionProperties class.

Top

Methods

 

Name

Description

Public method

Add

Overloaded. 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 and its values are present in the current set of connection properties.

Public method

ContainsKey

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

Public method

CopyTo

Copies the current set of connection properties and their values to the specified array, starting at the specified array index.

Public method

Equals

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

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

GetHashCode

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

Protected method

GetKeyAsString

Formats a property key 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, and 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

ReadKeyFromString

Reads a property key name from a connection string starting at a specified index, and then updates the index to point to a position immediately following the property key 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 from the current collection of properties.

Public method

Reset

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

Protected method

ResolveProperty

Looks up the specified property in the list of synonyms and optionally makes this property the primary name for the synonyms collection, if it is not already so.

Protected method

SetPropertySynonyms

Sets or clears the synonyms for the specified property.

Protected method

ShouldPersistProperty

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

Public method

ToDisplayString

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

Public method

ToSafeString

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

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

Public method

TryGetValue

Retrieves the value of the specified property.

Top

Properties

 

Name

Description

Public property

Count

Gets the number of existing data connection properties.

Public property

IsComplete

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

Public property

IsExtensible

Gets or sets a Boolean value indicating whether the DDEX provider connection properties are extensible.

Public property

Item

Gets or sets a value for a specified property of the DDEX provider.

Public property

Keys

Gets a collection of the current property key names.

Protected property

OrderedProperties

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

Public property

Values

Retrieves a collection of the current property values.

Top

Events

 

Name

Description

Public event

PropertyChanged

Occurs on the occurrence of a change to a connection property.

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

ICollection<KeyValuePair<String, Object>>.Add

Explicit interface implemetationPrivate method

ICollection<KeyValuePair<String, Object>>.Clear

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

IEnumerable<KeyValuePair<String, Object>>.GetEnumerator

Explicit interface implemetationPrivate method

IEnumerable.GetEnumerator

Retrieves an IEnumerator.

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

ICollection<KeyValuePair<String, Object>>.IsReadOnly

Explicit interface implemetationPrivate method

ICollection<KeyValuePair<String, Object>>.Remove

Top

See Also

Reference

DataConnectionProperties Class

Microsoft.VisualStudio.Data.Framework Namespace