M

FormattedText.Find

Description:
Returns a text range identifying the first occurrence of the given string within the text, starting from a given index.

Remarks:
Returns an empty text range:

if the given string cannot be found in the text.
if the given start index is beyond the length of the entire text.

The search can be case-sensitive or case-insensitive. The search can be set to match whole words or part of words.

public TextRange Find(
	string searchString,
	int startIndex,
	bool matchCase,
	bool matchWholeWord
)

Public Function Find ( 
	searchString As String,
	startIndex As Integer,
	matchCase As Boolean,
	matchWholeWord As Boolean
) As TextRange

public:
TextRange^ Find(
	String^ searchString, 
	int startIndex, 
	bool matchCase, 
	bool matchWholeWord
)

member Find : 
        searchString : string * 
        startIndex : int * 
        matchCase : bool * 
        matchWholeWord : bool -> TextRange

String

searchString

The text to search for.
Int32

startIndex

The start index to search within the text.
Boolean

matchCase

True if the case must match when searching the formatted text, false to search in a case-insensitive manner.
Boolean

matchWholeWord

True if the match must be a whole word when searching the formatted text, false otherwise.

Return Value TextRange The text range identified.

#region Autodesk.Revit.DB.FormattedText.#ctor(System.String)
public void ReformatText(TextNote textNote, string textToChange)
{
    String plainText = textNote.Text;
    FormattedText formattedText = new FormattedText(plainText);

    TextRange foundRange = formattedText.Find(textToChange, 0, false, true);
    while (foundRange.Length > 0)
    {
        formattedText.SetBoldStatus(foundRange, true);
        foundRange = formattedText.Find(textToChange, foundRange.End, false, true);
    }

    textNote.SetFormattedText(formattedText);
}
#endregion

ArgumentException

searchString is an empty string. -or- searchString contains invalid characters such as a newline character.
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

The given value for startIndex is negative.