DataConnectionProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public ref class DataConnectionProperties : Microsoft::Data::ConnectionUI::IDataConnectionProperties, System::Collections::IDictionary, System::ComponentModel::ICustomTypeDescriptorpublic class DataConnectionProperties : Microsoft.Data.ConnectionUI.IDataConnectionProperties, System.Collections.IDictionary, System.ComponentModel.ICustomTypeDescriptortype DataConnectionProperties = class
interface IDataConnectionProperties
interface ICustomTypeDescriptor
interface IDictionary
interface ICollection
interface IEnumerablePublic Class DataConnectionProperties
Implements ICustomTypeDescriptor, IDataConnectionProperties, IDictionary- Inheritance
-
DataConnectionProperties
- Derived
- Implements
Constructors
| DataConnectionProperties() |
Class constructor. Instantiates a non-parameterized instance of the DataConnectionProperties class. |
| DataConnectionProperties(IComparer) |
Class constructor. Instantiates a parameterized instance of the DataConnectionProperties class that provides the ability to compare property names. |
| DataConnectionProperties(IComparer, Char, Char) |
Class constructor. Instantiates a parameterized instance of the DataConnectionProperties class that provides the ability to compare property names. |
Properties
| 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. |
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. |
| AddProperty(String, Type, Attribute[]) |
Dynamically adds a new property to the collection of properties natively recognized by this data connection properties instance. |
| Contains(String) |
Tests whether a specified property is a member of the current set of connection properties. |
| EquivalentTo(DataConnectionProperties) |
Retrieves a Boolean value indicating whether the current instance of the DataConnectionProperties class is equivalent to another DataConnectionProperties instance. |
| GetBasicProperties() |
Retrieves an array of property names representing the set of "basic" properties known by the current DataConnectionProperties instance. |
| GetEnumerator() |
Retrieves an enumerator that enumerates over all the known connection properties and their values, if any. |
| GetNameAsString(String) |
Formats a property name 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) |
Initializes the current DataConnectionProperties instance to its default state, 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) |
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(DataConnectionPropertyChangedEventArgs) |
Raises the PropertyChanged event. |
| Parse(String) |
Disassembles the components of a connection string into a set of properties in the current DataConnectionProperties 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. |
| 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. |
| Reset() |
Resets the values of connection properties to an initial state. |
| Reset(String) |
Resets the value of a specified connection property to its initial state. |
| ResolveSynonym(String, Boolean) |
Attempts to resolves a synonym for the PropertyDescriptor associated with a base property by returning the base property descriptor. |
| SetSynonyms(String, String[]) |
Sets a list of strings as synonyms of a specified base property name. |
| ShouldPersistProperty(String) |
Indicates whether a property should be persisted when building a connection string. |
| Test() |
Tests to assure 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. |
Events
| PropertyChanged |
Event that fires on the occurrence of a change to a connection property. |
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 ICollection. |
| 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 | |
| IDictionary.Add(Object, Object) |
Adds an element as a key/value pair to the specified IDictionary. |
| IDictionary.Clear() |
Removes all elements from the specified IDictionary. |
| IDictionary.Contains(Object) |
Determines whether the IDictionary contains an element with the specified key. |
| IDictionary.GetEnumerator() |
Retrieves an IDictionaryEnumerator for the IDictionary. |
| IDictionary.IsFixedSize |
Retrieves a Boolean value indicating whether the specified IDictionary has a fixed size. |
| IDictionary.IsReadOnly |
Retrieves a Boolean indicating whether the IDictionary is read-only. |
| IDictionary.Item[Object] |
Retrieves an item, or element, with the specified key. |
| IDictionary.Keys |
Retrieves an ICollection containing the keys for the IDictionary. |
| IDictionary.Remove(Object) |
Removes the element with the specified key from the IDictionary. |
| IDictionary.Values |
Retrieves an ICollection containing the values in the specified IDictionary. |
| IEnumerable.GetEnumerator() |
Retrieves an enumerator that is able to iterate through the connection properties collection. |