Setting.Description Property

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Settings

Assembly:: Microsoft.VisualStudio.Extensibility.Contracts.dll

Package:: Microsoft.VisualStudio.Extensibility.Contracts v17.14.2088

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the verbose description of the setting.

[System.Runtime.Serialization.DataMember]
public string? Description { get; init; }

[<System.Runtime.Serialization.DataMember>]
member this.Description : string with get, set

Public Property Description As String

Property Value

String

Attributes: DataMemberAttribute

Remarks

This property supports embedded links using markdown syntax. Links can point to a setting, file, or URL:

        <ul><li><code data-dev-comment-type="c">"Clicking [here](config:environment.visualExperience.colorTheme) will move focus to the theme setting."</code>

(this format uses the FullId of the setting, which includes the identifiers of the the categories

        the setting is nested under).</li><li><code data-dev-comment-type="c">"Clicking [here](file:%windir%\system.ini) will open your SYSTEM.INI file."</code></li><li><code data-dev-comment-type="c">"Clicking [here](https://www.bing.com/) will open the Bing home page in your browser."</code></li></ul>

Applies to