EditorOptionDefinition<T> Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.Logic.dll

Package:: Microsoft.VisualStudio.Text.Logic v17.11.260

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.

Represents the definition of an editor option.

generic <typename T>
public ref class EditorOptionDefinition abstract : Microsoft::VisualStudio::Text::Editor::EditorOptionDefinition

template <typename T>
[Windows::Foundation::Metadata::WebHostHidden]
class EditorOptionDefinition abstract : Microsoft::VisualStudio::Text::Editor::EditorOptionDefinition

public abstract class EditorOptionDefinition<T> : Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition

type EditorOptionDefinition<'T> = class
    inherit EditorOptionDefinition

Public MustInherit Class EditorOptionDefinition(Of T)
Inherits EditorOptionDefinition

Type Parameters

T

The type of the option.

Inheritance: Object

EditorOptionDefinition
EditorOptionDefinition<T>

Derived: Microsoft.VisualStudio.Text.Differencing.DifferenceBufferOption<T>

Microsoft.VisualStudio.Text.Differencing.DifferenceViewerOption<T>

Microsoft.VisualStudio.Text.Editor.AutoDetectUtf8Option

Microsoft.VisualStudio.Text.Editor.AutomaticDelimiterHighlightingOption

Microsoft.VisualStudio.Text.Editor.CaretWidthOption

More…

Remarks

This is a MEF component part, and should be exported with:

[Export(typeof(EditorOptionDefinition))]

Constructors

EditorOptionDefinition<T>()

Initializes a new instance of EditorOptionDefinition<T>.

Properties

Default	Gets the default value of this option.
DefaultValue	Gets the default value of the option.
Key	Gets the key of this option.
Name	Gets the name of the option.
ValueType	Gets the actual type of the option.

Methods

Equals(Object)	Determines whether two EditorOptionDefinition objects are the same. (Inherited from EditorOptionDefinition)
GetHashCode()	Gets the hash code of this type. (Inherited from EditorOptionDefinition)
IsApplicableToScope(IPropertyOwner)	Determines whether this option is applicable for the given scope (for example, a text buffer). The default implementation returns `true`. An option, by default, is applicable to any scope. (Inherited from EditorOptionDefinition)
IsValid(Object)	Determines whether the proposed value is valid.
IsValid(T)	Determines whether the proposed value is valid.

Applies to

Share via