Share via


Setting.String Class

Definition

Configuration of a string VisualStudio.Extensibility setting.

[System.Runtime.Serialization.DataContract]
public class Setting.String : Microsoft.VisualStudio.Extensibility.Settings.SimpleSetting<string>, IEquatable<Microsoft.VisualStudio.Extensibility.Settings.Setting.String>
[<System.Runtime.Serialization.DataContract>]
type Setting.String = class
    inherit SimpleSetting<string>
    interface IEquatable<Setting.String>
Public Class Setting.String
Inherits SimpleSetting(Of String)
Implements IEquatable(Of Setting.String)
Inheritance
Attributes
Implements

Constructors

Setting.String(String, String, SettingCategory, String)

Initializes a new instance of the Setting.String class.

Properties

DefaultValue

Gets the default value of the setting.

(Inherited from Setting<T>)
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.

(Inherited from Setting<T>)
HelpUri

Gets the URI of a help page.

(Inherited from Setting)
Id

Gets the identifier of the setting.

(Inherited from Setting)
MaxStringLength

Gets the maximum string length.

MinStringLength

Gets the minimum string length.

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.

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)

Determines whether the specified object is equal to the current object.

Equals(Setting) (Inherited from Setting)
Equals(Setting+String)

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

Equals(Setting<T>) (Inherited from Setting<T>)
Equals(SimpleSetting<T>) (Inherited from SimpleSetting<T>)
GetHashCode()

Serves as the default hash function.

Applies to