TextSnapshot.getText()

Disponibilidad

Edición: Flash MX 2004.

Reproducción: los archivos SWF publicados para FlashPlayer 6 o posterior, que se reproducen en Flash Player 7 o posterior.

Sintaxis

mySnapshot.getText(from, to [, includeLineEndings ] )

Parámetros

from Número entero que indica la posición del primer carácter de my_snap que debe incluirse en la cadena devuelta. Los valores válidos para from van de 0 a TextSnapshot.getCount() -1. Si from es un valor negativo, se utiliza 0.

to Número entero que es 1+ el índice del último carácter de my_snap que debe examinarse. Los valores válidos para to van de 0 a TextSnapshot.getCount(). El carácter indexado por el parámetro to no se incluye en la cadena extraída. Si el parámetro se omite, se utiliza TextSnapshot.getCount(). Si este valor es inferior o igual al valor de from, se utiliza from+1.

includeLineEndings Valor booleano opcional que especifica si se insertan caracteres newline en la cadena devuelta donde corresponda. El valor predeterminado es false.

Valor devuelto

Una cadena que contiene los caracteres del rango especificado o una cadena vacía en caso de que no haya caracteres en el rango especificado.

Descripción

Método; devuelve una cadena que contiene todos los caracteres especificados por los parámetros from y to. Si no se ha seleccionado ningún carácter, se devuelve una cadena vacía.

Para devolver todos los caracteres, pase un valor de 0 para from y TextSnapshot.getCount() (o cualquier número grande) para to. Para devolver un solo carácter, pase un valor de from+1 para to.

Si pasa un valor de true para includeLineEndings, se insertan caracteres newline en la cadena devuelta donde corresponda. En este caso, la cadena devuelta puede ser más larga que el rango de entrada. Si includeLineEndings es false o está omitido, el texto seleccionado se devuelve sin caracteres añadidos.

Véase también

TextSnapshot.getSelectedText()