Setting.FormattedString Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Settings

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

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

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.

Configuration of a string VisualStudio.Extensibility setting with format validation.

[System.Runtime.Serialization.DataContract]
public sealed class Setting.FormattedString : Microsoft.VisualStudio.Extensibility.Settings.SimpleSetting<string>, IEquatable<Microsoft.VisualStudio.Extensibility.Settings.Setting.FormattedString>

[<System.Runtime.Serialization.DataContract>]
type Setting.FormattedString = class
    inherit SimpleSetting<string>
    interface IEquatable<Setting.FormattedString>

Public NotInheritable Class Setting.FormattedString
Inherits SimpleSetting(Of String)
Implements IEquatable(Of Setting.FormattedString)

Inheritance: Object

Setting

Setting<T>

SimpleSetting<String>
Setting.FormattedString

Attributes: DataContractAttribute

Implements: IEquatable<Setting.FormattedString>

Constructors

Setting.FormattedString(String, String, SettingCategory, SettingStringFormat, String)

Initializes a new instance of the Setting.FormattedString 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)
Format	Gets the format used to validate this 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)
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+FormattedString)	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

Share via