DelimiterAutoCompleter Class

public class DelimiterAutoCompleter : IDelimiterAutoCompleter, IEditorDocumentTextChangeEventSink, IEditorViewSelectionChangeEventSink, IEditorViewTextInputEventSink

public DelimiterAutoCompleter()

public bool CanCompleteAngleBraces { get; set; }

Property Value

bool:

true if angle braces can be completed; otherwise, false. The default value is false.

public bool CanCompleteCurlyBraces { get; set; }

Property Value

bool:

true if curly braces can be completed; otherwise, false. The default value is true.

public bool CanCompleteDoubleQuotes { get; set; }

Property Value

bool:

true if double quotes can be completed; otherwise, false. The default value is true.

public bool CanCompleteParentheses { get; set; }

Property Value

bool:

true if parentheses can be completed; otherwise, false. The default value is true.

public bool CanCompleteSingleQuotes { get; set; }

Property Value

bool:

true if single quotes can be completed; otherwise, false. The default value is false.

public bool CanCompleteSquareBraces { get; set; }

Property Value

bool:

true if square braces can be completed; otherwise, false. The default value is true.

public int? OpenAngleBraceTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open angle brace character is valid for auto-completion.

Remarks

Leave the value null if token validation is not required for angle braces.

public int? OpenCurlyBraceTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open curly brace character is valid for auto-completion.

Remarks

Leave the value null if token validation is not required for curly braces.

public int? OpenDoubleQuoteTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open double quote character is valid for auto-completion.

Remarks

Leave the value null if token validation is not required for double quotes.

public int? OpenParenthesisTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open parenthesis character is valid for auto-completion.

Remarks

Leave the value null if token validation is not required for parentheses.

public int? OpenSingleQuoteTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open single quote character is valid for auto-completion.

Remarks

Leave the value null if token validation is not required for single quotes.

public int? OpenSquareBraceTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open square brace character is valid for auto-completion.

Remarks

Leave the value null if token validation is not required for square braces.

protected virtual bool IsValidForEndDelimiterAutoComplete(TextSnapshotOffset snapshotOffset, char endDelimiter)

Parameter	Type	Description
snapshotOffset	TextSnapshotOffset	The TextSnapshotOffset at which to possibly auto-insert the delimiter.
endDelimiter	char	The end delimiter.

Returns

bool:

true if the end delimiter is valid to be auto-inserted at the specified TextSnapshotOffset; otherwise, false.

protected virtual bool IsValidStartDelimiter(ITextSnapshotReader reader, char startDelimiter)

Parameter	Type	Description
reader	ITextSnapshotReader	The ITextSnapshotReader to examine.
startDelimiter	char	The start delimiter.

Returns

bool:

true if the ITextSnapshotReader's current offset is immediately after the specified start delimiter; otherwise, false.

protected virtual bool IsValidStartDelimiter(IToken token, char startDelimiter)

Parameter	Type	Description
token	IToken	The IToken to examine.
startDelimiter	char	The start delimiter.

Returns

bool:

true if the IToken represents the specified start delimiter; otherwise, false.

Remarks

The default implementation of this method compares the token ID to the IDs specified in the OpenAngleBraceTokenId, OpenCurlyBraceTokenId, OpenParenthesisTokenId, and OpenSquareBraceTokenId properties. This method is called by the default implementation of the IsValidForEndDelimiterAutoComplete(TextSnapshotOffset, char) method.

protected virtual void OnDocumentTextChanged(SyntaxEditor editor, EditorSnapshotChangedEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument is changed.
e	EditorSnapshotChangedEventArgs	The EditorSnapshotChangedEventArgs that contains the event data.

protected virtual void OnDocumentTextChanging(SyntaxEditor editor, EditorSnapshotChangingEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument is changed.
e	EditorSnapshotChangingEventArgs	The EditorSnapshotChangingEventArgs that contains the event data.

protected virtual void OnViewSelectionChanged(IEditorView view, EditorViewSelectionEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	EditorViewSelectionEventArgs	The EditorViewSelectionEventArgs that contains the event data.

protected virtual void OnViewTextInput(IEditorView view, TextCompositionEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	TextCompositionEventArgs	The TextCompositionEventArgs that contains the event data.