DataConnectionProperties Class

 

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.

Namespace:   Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

System.Object
  Microsoft.VisualStudio.Data.Framework.DataConnectionProperties

public abstract class DataConnectionProperties : IVsDataConnectionProperties, 
	IDictionary<stringobject>, ICollection<KeyValuePair<stringobject>>, 
	IEnumerable<KeyValuePair<stringobject>>, IEnumerable, IVsDataConnectionUIProperties, 
	ICustomTypeDescriptor, INotifyPropertyChanged

NameDescription
System_CAPS_protmethodDataConnectionProperties()

Initializes a non-parameterized instance of the DataConnectionProperties class.

System_CAPS_protmethodDataConnectionProperties(IEqualityComparer<String>)

Initializes a parameterized instance of the DataConnectionProperties class that provides the ability to compare property names.

System_CAPS_protmethodDataConnectionProperties(IEqualityComparer<String>, Char, Char)

Initializes a parameterized instance of the DataConnectionProperties class that provides the ability to compare property names.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of existing data connection properties.

System_CAPS_pubpropertyIsComplete

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

System_CAPS_pubpropertyIsExtensible

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

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyKeys

Gets a collection of the current property key names.

System_CAPS_protpropertyOrderedProperties

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

System_CAPS_pubpropertyValues

Retrieves a collection of the current property values.

NameDescription
System_CAPS_pubmethodAdd(String, Object)

Adds a new property to the current connection properties collection.

System_CAPS_pubmethodAdd(String, Type, Object)

Adds a new property to the current connection properties collection.

System_CAPS_protmethodAddProperty(PropertyDescriptor, Attribute[])

Dynamically adds a new property to the collection of properties natively recognized by the current instance of the DataConnectionProperties class.

System_CAPS_protmethodAddProperty(String, Type, Attribute[])

Dynamically adds a new property to the collection of properties natively recognized by this data connection properties instance.

System_CAPS_pubmethodContains(KeyValuePair<String, Object>)

Tests whether a specified property and its values are present in the current set of connection properties.

System_CAPS_pubmethodContainsKey(String)

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

System_CAPS_pubmethodCopyTo(KeyValuePair<String, Object>[], Int32)

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

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetKeyAsString(String)

Formats a property key for placement in a connection string.

System_CAPS_protmethodGetProperties()

Retrieves the collection of descriptors of all currently known properties.

System_CAPS_protmethodGetProperties(Attribute[])

Retrieves the collection of descriptors of currently known properties that match a specified set of attributes.

System_CAPS_protmethodGetProperty(String)

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

System_CAPS_pubmethodGetSynonyms(String)

Retrieves an array list of synonyms for a specified property.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetValueAsString(String)

Formats a property value for placement in a connection string.

System_CAPS_protmethodInitialize(IDictionary<String, Object>)

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

System_CAPS_protmethodInitializeProperties()

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

System_CAPS_protmethodInitializeSynonyms()

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

System_CAPS_protmethodInitializeValue(String, Object)

Initializes the value of a specified connection property.

System_CAPS_protmethodInitializeValues(IDictionary<String, Object>)

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

System_CAPS_pubmethodIsSensitive(String)

Indicates whether a property contains sensitive information.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodModifyProperty(String, Attribute[])

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

System_CAPS_protmethodOnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event.

System_CAPS_pubmethodParse(String)

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

System_CAPS_protmethodReadKeyFromString(String, Int32)

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.

System_CAPS_protmethodReadValueFromString(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.

System_CAPS_pubmethodRemove(String)

Removes a property from the current connection property collection.

System_CAPS_protmethodRemoveProperty(String)

Removes a natively recognized property from the current collection of properties.

System_CAPS_pubmethodReset()

Resets the values of connection properties to an initial state.

System_CAPS_pubmethodReset(String)

Removes the specified property from the current set of data connection properties.

System_CAPS_protmethodResolveProperty(String, Boolean)

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.

System_CAPS_protmethodSetPropertySynonyms(String, String[])

Sets or clears the synonyms for the specified property.

System_CAPS_protmethodShouldPersistProperty(String)

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

System_CAPS_pubmethodToDisplayString()

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

System_CAPS_pubmethodToSafeString()

Retrieves a string representation of the current set of data connection properties that excludes sensitive properties or properties that should not be persisted.

System_CAPS_pubmethodToString()

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

System_CAPS_pubmethodTryGetValue(String, Object)

Retrieves the value of the specified property.

NameDescription
System_CAPS_pubeventPropertyChanged

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

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection<KeyValuePair<String, Object>>.Add(KeyValuePair<String, Object>)

System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection<KeyValuePair<String, Object>>.Clear()

System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection<KeyValuePair<String, Object>>.Remove(KeyValuePair<String, Object>)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable<KeyValuePair<String, Object>>.GetEnumerator()

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Retrieves an IEnumerator.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetAttributes()

Retrieves a collection of custom attributes for the specified object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetClassName()

Retrieves the class name of the specified object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetComponentName()

Retrieves the name of the specified object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetConverter()

Retrieves a type converter for the specified object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetDefaultEvent()

Retrieves the default event for the specified object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetDefaultProperty()

Retrieves the default property for the specified object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetEditor(Type)

Retrieves an editor of the specified type for this object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetEvents()

Retrieves the events for the specified instance of a component.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetEvents(Attribute[])

Retrieves the events for this instance of a component, using the specified attribute array as a filter.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetProperties()

Retrieves the properties for the specified instance of a component.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetProperties(Attribute[])

Retrieves the properties for the specified instance of a component, using the attribute array as a filter.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)

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

In the simplest case, a derived class should add properties to its class and place component attributes on these properties to customize their behavior. In the more advanced case, a derived class can override the parsing and formatting code, and dynamically change any of the properties based on specific actions, such as setting the value of a property.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: