Setting<T> Class

Definition

Configuration of a VisualStudio.Extensibility setting.

[System.Runtime.Serialization.DataContract]
public abstract class Setting<T> : Microsoft.VisualStudio.Extensibility.Settings.Setting, IEquatable<Microsoft.VisualStudio.Extensibility.Settings.Setting<T>>
[<System.Runtime.Serialization.DataContract>]
type Setting<'T> = class
    inherit Setting
    interface IEquatable<Setting<'T>>
Public MustInherit Class Setting(Of T)
Inherits Setting
Implements IEquatable(Of Setting(Of T))

Type Parameters

T

The value type of the setting.

Inheritance
Setting<T>
Derived
Attributes
Implements

Properties

DefaultValue

Gets the default value of the setting.

Description

Gets the verbose description of the setting.

(Inherited from Setting)
DisplayName

Gets the display name of the setting.

(Inherited from Setting)
EnabledWhen

Gets the rule that determines if this setting is enabled in the UI.

(Inherited from Setting)
EnvironmentVariableDefault

Gets the environment variable from which the default value is parsed. If it is not defined or cannot be parsed, the value specified in DefaultValue is used instead.

(Inherited from Setting)
FullId

Gets the full id of the setting.

HelpUri

Gets the URI of a help page.

(Inherited from Setting)
Id

Gets the identifier of the setting.

(Inherited from Setting)
Messages

Gets a list of messages shown next to the setting in the UI.

(Inherited from Setting)
ParentCategory

Gets the parent category.

(Inherited from Setting)
SearchKeywords

Gets a list of keywords to associate with this setting. When searching using the Visual Studio UI, words in DisplayName, Description, and SearchKeywords can be used to find a setting.

(Inherited from Setting)
Tags

Gets a list of tags to associate with the registration. Used when filtering the settings window.

(Inherited from Setting)
Type

Gets type identifier of the setting.

(Inherited from Setting)
UnsupportedMessage

Gets the message to display if the setting is not supported.

(Inherited from Setting)
VisibleWhen

Gets the rule that determines if this setting is visible in the UI.

(Inherited from Setting)

Methods

Equals(Object)
Equals(Setting) (Inherited from Setting)
Equals(Setting<T>)

Indicates whether the current object is equal to another object of the same type.

GetHashCode()

Serves as the default hash function.

Applies to