OnAfterLocateFoundTextResult Method (OperationBase)

Top  Previous  Next

This method can be overridden to perform some action after the user has located a node of the kind 'found text' in the result window. Typically this is done in operations that are reviews and that want to offer to the user a way to correct the result after it has been located.

Signature

[VB.NET]

Sub OnAfterLocateFoundTextResult(ByVal adminOptions As AdminOptionsBase, ByVal userOptions As UserOptions, ByVal textDocument As EnvDTE.TextDocument, ByVal foundText As String, ByVal startLineNumber As Integer, ByVal startOfftset As Integer, ByVal endLineNumber As Integer, ByVal endOffset As Integer, ByVal customValue As Object)

[C#]

void OnAfterLocateFoundTextResult(AdminOptionsBase adminOptions, UserOptions userOptions, EnvDTE.TextDocument textDocument, string foundText, int startLineNumber, int startOfftset, int endLineNumber, int endOffset, object customValue)

Parameters

  • adminOptions: the admin options used by the operation, if any.
  • userOptions: the user options used by the operation.
  • textDocument: the document text where the found text has been located.
  • foundText: the text that has been found.
  • startLineNumber: the number of the first line of the paragraph with the found text.
  • startOffset: the offset of the first character of the paragraph with the found text.
  • endLineNumber: the number of the last line of the paragraph with the found text.
  • endOffset: the offset of the last character of the paragraph with the found text.
  • customValue: a custom, user-defined value stored in the result node, that was added in the call to the AddNodeToResultsTree method.