HighlightCurrentLineOption Class

Article
06/27/2014

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
	HighlightCurrentLineOption	Initializes a new instance HighlightCurrentLineOption.

Top

Properties

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

Top

Methods

	Name	Description
	Equals	Determines whether two EditorOptionDefinition objects are the same. (Inherited from EditorOptionDefinition.)
	GetHashCode	Gets the hash code of this type. (Inherited from EditorOptionDefinition.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsApplicableToScope	Determines whether this definition is applicable only to text views. (Inherited from WpfViewOptionDefinition<T>.)
	IsValid(Object%)	Determines whether the proposed value is valid. (Inherited from EditorOptionDefinition<T>.)
	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.

Share via