GetCharacterIndex Method

Returns the index of a character block, which contains a character with the specified index in the text string of the shape.

Applies to: Shape object

Syntax

[[Let] indexRet = ] object.GetCharacterIndex ( iSymbol )

The GetCharacterIndex method syntax has these parts:

Part Description
object

Required. An expression that returns a Shape object.

iSymbol Required. An expression that returns a Long value. The character index in the text string of the shape.
indexRet Optional. A Long type variable.

Remarks

If index is less than 1 or greater than the number of character in the text string of the shape, the GetCharacterIndex method returns 0.

 

See Also

Character method, CharactersNum method, RemoveCharacter method, SetCharColor method, SetCharFont method, SetCharHyperlink method, SetCharLanguage method, SetCharPos method, SetCharSize method, SetCharSpacing method, SetCharStyle method, Character object