DataConnectionProperties.OrderedProperties Property

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

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

Syntax

Protected Overridable ReadOnly Property OrderedProperties As StringCollection

Dim value As StringCollection

value = Me.OrderedProperties
protected virtual StringCollection OrderedProperties { get; }
protected:
virtual property StringCollection^ OrderedProperties {
    StringCollection^ get ();
}
protected function get OrderedProperties () : StringCollection

Property Value

Type: System.Collections.Specialized.StringCollection

A collection of property names indicating a reasonable (or necessary) order to the properties.

Remarks

The base class implementation of ToDisplayString and ToFullString use the value of this property to determine the order of properties when building the properties order string. The default value is nulla null reference (Nothing in Visual Basic), indicating no order to the properties.

It is recommended that a data provider implement this property, as doing so helps make the connection string more user friendly.

As a general rule, more important, or basic, properties should occur earlier in the string, and more advanced properties should appear later in the string.

Permissions

See Also

Reference

DataConnectionProperties Class

DataConnectionProperties Members

Microsoft.VisualStudio.Data Namespace