SettingsDescriptionAttribute(String) Constructor

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-preview.3.24172.9

Source:

SettingsDescriptionAttribute.cs

Initializes an instance of the SettingsDescriptionAttribute class.

public:
 SettingsDescriptionAttribute(System::String ^ description);

public SettingsDescriptionAttribute (string description);

new System.Configuration.SettingsDescriptionAttribute : string -> System.Configuration.SettingsDescriptionAttribute

Public Sub New (description As String)

Parameters

description

String

The String used as descriptive text.

Remarks

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.

See also

• Description