IDataConnectionProperties.IsExtensible Property

 

Retrieves a Boolean value indicating whether the specified set of connection properties is extensible; that is, whether it is possible to add and remove custom properties to the set of connection properties.

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

Syntax

bool IsExtensible { get; }

property bool IsExtensible {
    bool get();
}

abstract IsExtensible : bool with get

ReadOnly Property IsExtensible As Boolean

Property Value

Type: System.Boolean

true if the connection properties are extensible; otherwise, false.

Remarks

To illustrate the use of this property, consider that SQL Server has a fixed (non-extensible) set of properties, such that it would be a mistake to try setting values for properties not native to SQL Server. For a SQL data provider, then, you would want to set this property to false. On the other hand, ODBC is a more dynamic provider that does not natively know all allowed keywords. This enables extensibility for an ODBC provider, and such a provider should have this property set to true.

In cases where this property is false, the Add and Remove methods on this interface do not work, while if the property is true they will work.

Note

You must go to the Advanced Connection Properties dialog box to set this property.

See Also

IVsDataConnectionProperties
Add
Remove
IDataConnectionProperties Interface
Microsoft.Data.ConnectionUI Namespace

Return to top