SettingsDescriptionAttribute Constructor (String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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.

.NET Framework
Available since 2.0
Return to top