Searches document for start position of a word.

Namespace: Sgry.Azuki
Assembly: Azuki (in Azuki.dll) Version: 1.7.13.40248

Syntax

C#
int NextWordStart(
	Document doc,
	int startIndex
)
Visual Basic
Function NextWordStart ( 
	doc As Document,
	startIndex As Integer
) As Integer

Parameters

doc
Type: Sgry.Azuki..::..Document
The document in which to search.
startIndex
Type: System..::..Int32
The index to start the search from.

Return Value

Type: Int32
Index of start position of a word if found, or length of the document if no word was found.

Remarks

This method searches doc for a word between startIndex and the end of document. If a word was found, this method returns the start position of the word, or returns the length of the document if no word was found.

All word processor implementations must meet the requirements next.

  • returns startIndex if a word starts at startIndex.
  • returns the length of document if no word was found.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptiondoc is null.
System..::..ArgumentOutOfRangeExceptionstartIndex is less than 0 or greater than length of the document.

See Also