CaretWidthOption Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.UI.dll

Package:: Microsoft.VisualStudio.Text.UI v17.11.260

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 option definition that determines how wide the caret should be rendered.

public ref class CaretWidthOption sealed : Microsoft::VisualStudio::Text::Editor::EditorOptionDefinition<double>

[Microsoft.VisualStudio.Utilities.Name("TextView/CaretWidth")]
[System.ComponentModel.Composition.Export(typeof(Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition))]
public sealed class CaretWidthOption : Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<double>

[<Microsoft.VisualStudio.Utilities.Name("TextView/CaretWidth")>]
[<System.ComponentModel.Composition.Export(typeof(Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition))>]
type CaretWidthOption = class
    inherit EditorOptionDefinition<double>

Public NotInheritable Class CaretWidthOption
Inherits EditorOptionDefinition(Of Double)

Inheritance: Object

EditorOptionDefinition

EditorOptionDefinition<Double>
CaretWidthOption

Attributes: NameAttribute ExportAttribute

Constructors

CaretWidthOption()

Properties

Default	Gets the default value `1.0`.
DefaultValue	Gets the default value of the option. (Inherited from EditorOptionDefinition<T>)
Key	Gets the editor option key.
Name	Gets the name of the option. (Inherited from EditorOptionDefinition<T>)
ValueType	Gets the actual type of the option. (Inherited from EditorOptionDefinition<T>)

Methods

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

Applies to

Partager via