EditorOptionDefinition<T> Class

Represents the definition of an editor option.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition
    Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<T>
      More...

Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.Logic (in Microsoft.VisualStudio.Text.Logic.dll)

Syntax

'Declaration
Public MustInherit Class EditorOptionDefinition(Of T) _
    Inherits EditorOptionDefinition
public abstract class EditorOptionDefinition<T> : EditorOptionDefinition
generic<typename T>
public ref class EditorOptionDefinition abstract : public EditorOptionDefinition
[<AbstractClass>]
type EditorOptionDefinition<'T> =  
    class
        inherit EditorOptionDefinition
    end
JScript does not support generic types or methods.

Type Parameters

  • T
    The type of the option.

The EditorOptionDefinition<T> type exposes the following members.

Constructors

  Name Description
Protected method EditorOptionDefinition<T> Initializes a new instance of EditorOptionDefinition<T>.

Top

Properties

  Name Description
Public property Default Gets the default value of this option.
Public property DefaultValue Gets the default value of the option. (Overrides EditorOptionDefinition.DefaultValue.)
Public property Key Gets the key of this option.
Public property Name Gets the name of the option. (Overrides EditorOptionDefinition.Name.)
Public property ValueType Gets the actual type of the option. (Overrides EditorOptionDefinition.ValueType.)

Top

Methods

  Name Description
Public method Equals Determines whether two EditorOptionDefinition objects are the same. (Inherited from EditorOptionDefinition.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Gets the hash code of this type. (Inherited from EditorOptionDefinition.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsApplicableToScope Determines whether this option is applicable for the given scope (for example, a text buffer). (Inherited from EditorOptionDefinition.)
Public method IsValid(Object%) Determines whether the proposed value is valid. (Overrides EditorOptionDefinition.IsValid(Object%).)
Public method IsValid(T%) Determines whether the proposed value is valid.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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

[Export(typeof(EditorOptionDefinition))]

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Text.Editor Namespace

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition
    Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<T>
      Microsoft.VisualStudio.Text.Editor.ConvertTabsToSpaces
      Microsoft.VisualStudio.Text.Editor.DisplayUrlsAsHyperlinks
      Microsoft.VisualStudio.Text.Editor.IndentSize
      Microsoft.VisualStudio.Text.Editor.NewLineCharacter
      Microsoft.VisualStudio.Text.Editor.OutliningUndoEnabled
      Microsoft.VisualStudio.Text.Editor.ReplicateNewLineCharacter
      Microsoft.VisualStudio.Text.Editor.TabSize
      Microsoft.VisualStudio.Text.Editor.ViewOptionDefinition<T>
      Microsoft.VisualStudio.Text.Editor.WpfViewOptionDefinition<T>