Selection.getCaretIndex()

Availability

Flash Player 5.

Usage

Selection.getCaretIndex()

Parameters

None.

Returns

An integer.

Description

Method; returns the index of the blinking insertion point (caret) position. If there is no blinking insertion point displayed, the method returns -1. Selection span indexes are zero-based (for example, the first position is 0, the second position is 1, and so on).