Share via


HighlightCurrentLineOption Class

Represents the option to highlight the current line.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition
    Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<Boolean>
      Microsoft.VisualStudio.Text.Editor.WpfViewOptionDefinition<Boolean>
        Microsoft.VisualStudio.Text.Editor.HighlightCurrentLineOption

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

Syntax

'Declaration
<NameAttribute("Adornments/HighlightCurrentLine/Enable")> _
<ExportAttribute(GetType(EditorOptionDefinition))> _
Public NotInheritable Class HighlightCurrentLineOption _
    Inherits WpfViewOptionDefinition(Of Boolean)
[NameAttribute("Adornments/HighlightCurrentLine/Enable")]
[ExportAttribute(typeof(EditorOptionDefinition))]
public sealed class HighlightCurrentLineOption : WpfViewOptionDefinition<bool>
[NameAttribute(L"Adornments/HighlightCurrentLine/Enable")]
[ExportAttribute(typeof(EditorOptionDefinition))]
public ref class HighlightCurrentLineOption sealed : public WpfViewOptionDefinition<bool>
[<Sealed>]
[<NameAttribute("Adornments/HighlightCurrentLine/Enable")>]
[<ExportAttribute(typeof(EditorOptionDefinition))>]
type HighlightCurrentLineOption =  
    class 
        inherit WpfViewOptionDefinition<bool>
    end
public final class HighlightCurrentLineOption extends WpfViewOptionDefinition<boolean>

The HighlightCurrentLineOption type exposes the following members.

Constructors

  Name Description
Public method HighlightCurrentLineOption Initializes a new instance HighlightCurrentLineOption.

Top

Properties

  Name Description
Public property Default Gets the default value, which is false. (Overrides EditorOptionDefinition<T>.Default.)
Public property DefaultValue Gets the default value of the option. (Inherited from EditorOptionDefinition<T>.)
Public property Key Gets the key for the highlight current line option. (Overrides EditorOptionDefinition<T>.Key.)
Public property Name Gets the name of the option. (Inherited from EditorOptionDefinition<T>.)
Public property ValueType Gets the actual type of the option. (Inherited from EditorOptionDefinition<T>.)

Top

Methods

  Name Description
Public method Equals Determines whether two EditorOptionDefinition objects are the same. (Inherited from EditorOptionDefinition.)
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 definition is applicable only to text views. (Inherited from WpfViewOptionDefinition<T>.)
Public method IsValid(Object%) Determines whether the proposed value is valid. (Inherited from EditorOptionDefinition<T>.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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