SearchServiceApplicationProxy.HighlightStringValue 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 HighlightStringValue ( _
    properties As QueryProperties, _
    strValue As String, _
    fLastTermByPrefix As Boolean _
) As HighlightedString
'Usage
Dim instance As SearchServiceApplicationProxy
Dim properties As QueryProperties
Dim strValue As String
Dim fLastTermByPrefix As Boolean
Dim returnValue As HighlightedString

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

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

Parameters

  • strValue
    Type: System.String

    The value of the string to be highlighted.

  • fLastTermByPrefix
    Type: System.Boolean

    true to indicate that any token in the strValue parameter 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 value in which all the occurrences of the specified query terms are highlighted.

Exceptions

Exception Condition
Exception

An error, such as a SearchServiceApplicationFault, occurred during application execution.

Remarks

This method highlights all of the occurrences of the specified query terms by enclosing each term in opening (<b>) and closing (</b>) tags.

See also

Reference

SearchServiceApplicationProxy class

SearchServiceApplicationProxy members

Microsoft.Office.Server.Search.Administration namespace