Help Center
/
Help Center›AfxNova›CTextRange2 Class

CTextRange2.GetIndexmethod

Retrieves the story index of the *Unit* parameter at the specified range Start character position.

Windowsmethoddocumented

Syntax

FUNCTION GetIndex (BYVAL Unit AS LONG = tomWord) AS LONG

Parameters

NameDescription
UnitUnit to include, if it is partially within the range. The default value is tomWord.
For a list of Unit values, see the table below.

Return value

The index value. The value is zero if Unit does not exist.

Description

Retrieves the story index of the Unit parameter at the specified range Start character position. The first Unit in a story has an index value of 1. The index of a Unit is the same for all character positions from that immediately preceding the Unit up to the last character in the Unit.

Reference

  • Defined in AfxNova/CTextRange2.inc:398
  • Documented in Windows/WIndows Controls/RichEdit/CTextRange2 Class.md
  • Topic: CTextRange2 Class