Share via

SearchServiceApplication.HighlightStringValueQuerySuggestions Method

  • Article

Highlights all the occurrences of the specified query terms in a specified string value.

Namespace:  Microsoft.Office.Server.Search.Administration
Assembly:  Microsoft.Office.Server.Search (in Microsoft.Office.Server.Search.dll)

Syntax

'Declaration
Public Function HighlightStringValueQuerySuggestions ( _
    properties As QueryProperties, _
    strValue As String, _
    fLastTermByPrefix As Boolean _
) As HighlightedString
'Usage
Dim instance As SearchServiceApplication
Dim properties As QueryProperties
Dim strValue As String
Dim fLastTermByPrefix As Boolean
Dim returnValue As HighlightedString

returnValue = instance.HighlightStringValueQuerySuggestions(properties, _
    strValue, fLastTermByPrefix)

public HighlightedString HighlightStringValueQuerySuggestions(
    QueryProperties properties,
    string strValue,
    bool fLastTermByPrefix
)

Parameters

  • strValue
    Type: System.String

    The value of the string that is to be highlighted.

  • fLastTermByPrefix
    Type: System.Boolean

    true if any token in the strValue element that matches the prefix of the last token in the query will be highlighted; otherwise, false.

Return Value

Type: Microsoft.Office.Server.Search.Query.HighlightedString
The string in which all the occurrences of the query terms are highlighted.

Remarks

This method highlights all the occurrences of the specified query terms by enclosing them in open (<b>) and close (</b>) tags.

See Also

Reference

SearchServiceApplication Class

SearchServiceApplication Members

Microsoft.Office.Server.Search.Administration Namespace