DataConnectionProperties Class

Definition

Namespace:

Microsoft.VisualStudio.Data.Framework

Assembly:

Microsoft.VisualStudio.Data.Framework.dll

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.

public ref class DataConnectionProperties abstract : 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 abstract class DataConnectionProperties : 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 DataConnectionProperties = class
    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 MustInherit Class DataConnectionProperties
Implements ICollection(Of KeyValuePair(Of String, Object)), ICustomTypeDescriptor, IDictionary(Of String, Object), IEnumerable(Of KeyValuePair(Of String, Object)), INotifyPropertyChanged, IVsDataConnectionUIProperties

Inheritance

Object

DataConnectionProperties

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

DataConnectionProperties()	Initializes a non-parameterized instance of the DataConnectionProperties class.
DataConnectionProperties(IEqualityComparer<String>)	Initializes a parameterized instance of the DataConnectionProperties class that provides the ability to compare property names.
DataConnectionProperties(IEqualityComparer<String>, Char, Char)	Initializes a parameterized instance of the DataConnectionProperties class that provides the ability to compare property names.

Properties

Count	Gets the number of existing data connection properties.
IsComplete	Gets a Boolean value indicating whether a given connection string is complete.
IsExtensible	Gets or sets a Boolean value indicating whether the DDEX provider connection properties are extensible.
Item[String]	Gets or sets a value for a specified property of the DDEX provider.
Keys	Gets a collection of the current property key names.
OrderedProperties	Gets a collection of property names specifying a reasonable (or necessary) order for the properties when represented in string form.
Values	Retrieves a collection of the current property values.

Methods

Add(String, Object)	Adds a new property to the current connection properties collection.
Add(String, Type, Object)	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.
AddProperty(String, Type, Attribute[])	Dynamically adds a new property to the collection of properties natively recognized by this data connection properties instance.
Contains(KeyValuePair<String,Object>)	Tests whether a specified property and its values are present in the current set of connection properties.
ContainsKey(String)	Tests whether a specified property is a member of the current set of connection properties.
CopyTo(KeyValuePair<String,Object>[], Int32)	Copies the current set of connection properties and their values to the specified array, starting at the specified array index.
GetKeyAsString(String)	Formats a property key for placement in a connection string.
GetProperties()	Retrieves the collection of descriptors of all currently known properties.
GetProperties(Attribute[])	Retrieves the collection of descriptors of currently known properties that match a specified set of attributes.
GetProperty(String)	Retrieves the descriptor of a property with the specified property name.
GetSynonyms(String)	Retrieves an array list of synonyms for a specified property.
GetValueAsString(String)	Formats a property value for placement in a connection string.
Initialize(IDictionary<String,Object>)	Initializes the current DataConnectionProperties instance to its default state, and then sets each property in the specified dictionary.
InitializeProperties()	Initializes the set of natively recognized properties for the current DataConnectionProperties instance.
InitializeSynonyms()	Initializes the set of synonyms available for each natively recognized property in the current DataConnectionProperties instance.
InitializeValue(String, Object)	Initializes the value of a specified connection property.
InitializeValues(IDictionary<String,Object>)	Initializes values for a specified set of properties, using a dictionary of name/value pairs.
IsSensitive(String)	Indicates whether a property contains sensitive information.
ModifyProperty(String, Attribute[])	Modifies an existing property of which the current DataConnectionProperties instance is natively aware.
OnPropertyChanged(PropertyChangedEventArgs)	Raises the PropertyChanged event.
Parse(String)	Disassembles the components of a connection string into a set of properties in the current DataConnectionProperties instance.
ReadKeyFromString(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.
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.
Remove(String)	Removes a property from the current connection property collection.
RemoveProperty(String)	Removes a natively recognized property from the current collection of properties.
Reset()	Resets the values of connection properties to an initial state.
Reset(String)	Removes the specified property from the current set of data connection properties.
ResolveProperty(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.
SetPropertySynonyms(String, String[])	Sets or clears the synonyms for the specified property.
ShouldPersistProperty(String)	Indicates whether a property should be persisted when building a connection string.
ToDisplayString()	Retrieves a string representation of the current set of data connection properties that are suitable for on-screen display.
ToSafeString()	Retrieves a string representation of the current set of data connection properties that excludes sensitive properties or properties that should not be persisted.
ToString()	Retrieves the default string representation of the current connection properties.
TryGetValue(String, Object)	Retrieves the value of the specified property.

Events

PropertyChanged

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

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()	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.
IEnumerable.GetEnumerator()	Retrieves an IEnumerator.
IEnumerable<KeyValuePair<String,Object>>.GetEnumerator()

Extension Methods