This documentation is archived and is not being maintained.

SettingsDescriptionAttribute Constructor

Initializes an instance of the SettingsDescriptionAttribute class.

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

public SettingsDescriptionAttribute(
	string description


Type: System.String

The String used as descriptive text.

Although the description has a theoretical maximum length of the String class, whose length is represented by a Int32, the following two practical considerations will limit the size of the description parameter:

  • Large text descriptions are difficult to display in a user interface (UI) and difficult for the user to read.

  • Settings providers may enforce overall usage quotas and are required to enforce user configuration quotas.

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0