Share via


ITextCaret.OverwriteMode Property

Determines whether the caret is in overwrite mode.

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

Syntax

'Declaration
ReadOnly Property OverwriteMode As Boolean
bool OverwriteMode { get; }
property bool OverwriteMode {
    bool get ();
}
abstract OverwriteMode : bool with get
function get OverwriteMode () : boolean

Property Value

Type: System.Boolean
true if the caret is in overwrite mode.

Remarks

When the caret is in overwrite mode, typed characters replace the character under the caret, and a block is drawn instead of a vertical line. This is distinct from the OverwriteModeId, since the caret can switch modes based on its position in the view.

The caret is not in overwrite mode when it is positioned at the end of the line in a view, or when there is a non-empty selection, even if OverwriteModeId is true.

.NET Framework Security

See Also

Reference

ITextCaret Interface

Microsoft.VisualStudio.Text.Editor Namespace