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

'Declaration
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
	EditorOptionDefinition	Initializes a new instance of EditorOptionDefinition.

Top

Properties

	Name	Description
	DefaultValue	Gets the default value of the option.
	Name	Gets the name of the option from the options registry.
	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
	Equals	Determines whether two EditorOptionDefinition objects are the same. (Overrides Object.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Gets the hash code of this type. (Overrides Object.GetHashCode().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsApplicableToScope	Determines whether this option is applicable for the given scope (for example, a text buffer).
	IsValid	Determines whether the proposed value is valid.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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