This documentation is archived and is not being maintained.

SettingsDescriptionAttribute.SettingsDescriptionAttribute Constructor

Initializes an instance of the SettingsDescriptionAttribute class.

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

public SettingsDescriptionAttribute (
	string description
public SettingsDescriptionAttribute (
	String description
public function SettingsDescriptionAttribute (
	description : String
Not applicable.



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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0