IOvertypeManager.TryStartOvertypeSessionAtCaretLocation Method

Definition

Overloads

TryStartOvertypeSessionAtCaretLocation()

Starts a new overtype session at the caret location.

TryStartOvertypeSessionAtCaretLocation(Boolean)

Starts a new overtype session at the caret location.

TryStartOvertypeSessionAtCaretLocation()

Starts a new overtype session at the caret location.

public bool TryStartOvertypeSessionAtCaretLocation ();
abstract member TryStartOvertypeSessionAtCaretLocation : unit -> bool
Public Function TryStartOvertypeSessionAtCaretLocation () As Boolean

Returns

Returns True if the session has been created.

Remarks

A session will be created only if the characters around the caret correspond to a brace pair supported by IBraceCompletionManagerFactory in the current content type or document.

If all the characters of the opening and closing brace pair are identical (for example, "|"), then all the characters on the left and right of the caret can be overtyped.

If the brace pair has different opening and closing brace characters, then only characters to the right of the caret can be overtyped. For example, creating a session on `` will only allow to overtype `-->`.

Applies to

TryStartOvertypeSessionAtCaretLocation(Boolean)

Starts a new overtype session at the caret location.

public bool TryStartOvertypeSessionAtCaretLocation (bool allowOvertypeCaretPrefix);
abstract member TryStartOvertypeSessionAtCaretLocation : bool -> bool
Public Function TryStartOvertypeSessionAtCaretLocation (allowOvertypeCaretPrefix As Boolean) As Boolean

Parameters

allowOvertypeCaretPrefix
Boolean

(optional) Indicates whether the span before the caret can be overtyped.

Returns

Returns True if the session has been created.

Remarks

A session will be created only if the characters around the caret correspond to a brace pair supported by IBraceCompletionManagerFactory in the current content type or document.

If all the characters of the opening and closing brace pair are identical (for example, "|") and that allowOvertypeCaretPrefix is true, then all the characters on the left and right of the caret can be overtyped.

If the brace pair has different opening and closing brace characters, then only characters to the right of the caret can be overtyped. For example, creating a session on `` will only allow to overtype `-->`.

Applies to