Highlight Method

Finds all occurrences of the specified text and highlights them. If there is an active selection only the selection is searched, otherwise the entire document is searched.

Syntax

Visual Basic

'Declaration
 
Public Function Highlight( _
   ByVal textToHighlight As String, _
   ByRef error As String, _
   Optional ByVal findCriteria As Infragistics.Documents.RichText.FindCriteria _
) As Integer

C#

public int Highlight( 
   string textToHighlight,
   out string error,
   Infragistics.Documents.RichText.FindCriteria findCriteria
)

Parameters

textToHighlight

The text to highlight.

error

An error message if an error was encountered.

findCriteria

The Infragistics.Documents.RichText.FindCriteria to use for the operation.

Return Value

The number of occurrences of the specified text found.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2