Share via


DataConnectionProperties.OrderedProperties Property

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

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

Syntax

'Declaration
Protected Overridable ReadOnly Property OrderedProperties As IList(Of String)
    Get
protected virtual IList<string> OrderedProperties { get; }
protected:
virtual property IList<String^>^ OrderedProperties {
    IList<String^>^ get ();
}
abstract OrderedProperties : IList<string>
override OrderedProperties : IList<string>
function get OrderedProperties () : IList<String>

Property Value

Type: System.Collections.Generic.IList<String>
A collection of property names indicating a reasonable (or necessary) order for the properties.

Remarks

The base class implementation of ToDisplayString and ToSafeString use the value of this property to determine the order of properties when creating 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 because 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.

.NET Framework Security

See Also

Reference

DataConnectionProperties Class

Microsoft.VisualStudio.Data.Framework Namespace