ProviderBase.Description Property (System.Configuration.Provider)

Description Property

.NET Framework Class Library

ProviderBase..::.Description Property

Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

Namespace: System.Configuration.Provider
Assembly: System.Configuration (in System.Configuration.dll)

Syntax

Visual Basic (Declaration)

Public Overridable ReadOnly Property Description As String

Visual Basic (Usage)

Dim instance As ProviderBase
Dim value As String

value = instance.Description

public virtual string Description { get; }

Visual C++

public:
virtual property String^ Description {
    String^ get ();
}

JScript

public function get Description () : String

Property Value

Type: System..::.String
A brief, friendly description suitable for display in administrative tools or other UIs.

Remarks

If a configured provider does not supply a description, the value of the Name property is returned as a default.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

ProviderBase Class

ProviderBase Members

System.Configuration.Provider Namespace