Share via


DataSourceInformation.AddProperty Method (String)

Adds a property to the list of supported properties.

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

Syntax

'Declaration
Protected Sub AddProperty ( _
    propertyName As String _
)
protected void AddProperty(
    string propertyName
)
protected:
void AddProperty(
    String^ propertyName
)
member AddProperty : 
        propertyName:string -> unit
protected function AddProperty(
    propertyName : String
)

Parameters

  • propertyName
    Type: System.String

    The name of a data source information property.

Exceptions

Exception Condition
ArgumentNullException

The propertyName parameter is null.

Remarks

This method informs the base class that the property exists, but does not supply it with a value. The base class notes that no value has been provided and on first request calls the RetrieveValue method to obtain the value. Subsequent calls return a cached copy of the value, so RetrieveValue is not called again for this property.

This method should be called by derived classes, normally in their constructor, to indicate that a particular property is supported. Without calling this the Contains method returns false for this property name (unless it was already specified in one of the constructors).

.NET Framework Security

See Also

Reference

DataSourceInformation Class

AddProperty Overload

Microsoft.VisualStudio.Data Namespace