Declarations::IsMatch Method (String^, Int32)

 

Determines whether the specified text matches some or all of the specified item.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

public:
virtual bool IsMatch(
	String^ textSoFar,
	int index
)

Parameters

textSoFar
Type: System::String^

[in] A string containing the text typed by the user and to be matched.

index
Type: System::Int32

[in] The index of the item to compare against.

Return Value

Type: System::Boolean

Returns true if the specified text is at the beginning of the specified item; otherwise, returns false.

This method is typically called by the GetBestMatch method to help find the best match for the text typed by the user.

The base method does a case-insensitive compare (using the String::Compare method) between the given text and the name of the given list item (as returned from a call to the GetName method), returning true if the item in the list begins with or exactly matches the given text.

Return to top
Show: