Setting Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Extensibility.Settings
Assembly:
Microsoft.VisualStudio.Extensibility.Contracts.dll
Package:
Microsoft.VisualStudio.Extensibility.Contracts v17.11.350

Configuration of a VisualStudio.Extensibility setting.

[Microsoft.VisualStudio.Extensibility.CompileTimeEvaluation]
[System.Runtime.Serialization.DataContract]
public abstract class Setting : IEquatable<Microsoft.VisualStudio.Extensibility.Settings.Setting>, Microsoft.VisualStudio.Extensibility.IVisualStudioContributionProperty
[<Microsoft.VisualStudio.Extensibility.CompileTimeEvaluation>]
[<System.Runtime.Serialization.DataContract>]
type Setting = class
    interface IEquatable<Setting>
    interface IVisualStudioContributionProperty
Public MustInherit Class Setting
Implements IEquatable(Of Setting), IVisualStudioContributionProperty
Inheritance
Object
Setting
Derived
Attributes
CompileTimeEvaluationAttribute DataContractAttribute
Implements
IVisualStudioContributionProperty IEquatable<Setting>

Properties

Description

Gets the verbose description of the setting.
DisplayName

Gets the display name of the setting.
EnabledWhen

Gets the rule that determines if this setting is enabled in the UI.
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.
FullId

Gets the full id of the setting.
HelpUri

Gets the URI of a help page.
Id

Gets the identifier of the setting.
ParentCategory

Gets the parent category.
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.
Tags

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

Gets type identifier of the setting.
UnsupportedMessage

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

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

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.
Equals(Setting)

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

Serves as the default hash function.

Applies to