EditorOptionDefinition Class

The definition of an editor option.

Inheritance Hierarchy

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

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

Syntax

声明
Public MustInherit Class EditorOptionDefinition
public abstract class EditorOptionDefinition
public ref class EditorOptionDefinition abstract
[<AbstractClass>]
type EditorOptionDefinition =  class end
public abstract class EditorOptionDefinition

The EditorOptionDefinition type exposes the following members.

Constructors

  Name Description
Protected method EditorOptionDefinition Initializes a new instance of EditorOptionDefinition.

Top

Properties

  Name Description
Public property DefaultValue Gets the default value of the option.
Public property Name Gets the name of the option from the options registry.
Public property ValueType Gets the actual type of the option. This is used to ensure that setting the option by using the editor options registry is type-safe.

Top

Methods

  Name Description
Public method Equals Determines whether two EditorOptionDefinition objects are the same. (Overrides Object.Equals(Object).)
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. (Overrides Object.GetHashCode().)
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).
Public method IsValid 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