EditorOptionDefinition Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

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

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.

The definition of an editor option.

public ref class EditorOptionDefinition abstract

[Windows::Foundation::Metadata::WebHostHidden]
public ref class EditorOptionDefinition abstract

[Windows::Foundation::Metadata::WebHostHidden]
class EditorOptionDefinition abstract

public abstract class EditorOptionDefinition

type EditorOptionDefinition = class

Public MustInherit Class EditorOptionDefinition

Inheritance: Object
EditorOptionDefinition

Derived: Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<T>

Remarks

This is a MEF component part, and should be exported with: [Export(typeof(EditorOptionDefinition))]

Constructors

EditorOptionDefinition()

Initializes a new instance of EditorOptionDefinition.

Properties

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.

Methods

Equals(Object)	Determines whether two EditorOptionDefinition objects are the same.
GetHashCode()	Gets the hash code of this type.
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.
IsValid(Object)	Determines whether the proposed value is valid.

Applies to