Clase TextFormat

Disponibilidad

Flash Player 6.

Descripción

La clase TextFormat representa la información de formato de caracteres.

Antes de llamar a sus métodos, debe utilizar el constructor new TextFormat() para crear un objeto TextFormat.

Puede establecer los parámetros TextFormat en null para indicar que no están definidos. Al aplicar un objeto TextFormat a un campo de texto con el método TextField.setTextFormat(), sólo se aplican sus propiedades definidas, como ocurre en el ejemplo siguiente:

my_fmt = new TextFormat();
my_fmt.bold = true;
my_txt.setTextFormat(my_fmt);

Primero, este código crea un objeto TextFormat vacío con todas sus propiedades sin definir y, a continuación, establece la propiedad bold en un valor definido.

El código my_txt.setTextFormat(my_fmt) sólo cambia la propiedad bold del formato de texto predeterminado del campo de texto, ya que la propiedad bold es la única definida de my_fmt. Todos los demás aspectos del formato de texto predeterminado del campo de texto permanecen iguales.

Cuando se invoca TextField.getTextFormat(), se devuelve un objeto TextFormat con todas sus propiedades definidas; ninguna propiedad tiene el valor null.

Resumen de métodos para la clase TextFormat

Método	Descripción
`TextFormat.getTextExtent()`	Devuelve información sobre medidas del texto correspondiente a una cadena de texto.

Resumen de propiedades para la clase TextFormat

Propiedad	Descripción
`TextFormat.align`	Indica la alineación de un párrafo.
`TextFormat.blockIndent`	Indica la sangría de bloque, expresada en puntos.
`TextFormat.bold`	Indica si el texto está en negrita.
`TextFormat.bullet`	Indica si el texto se encuentra en una lista con viñetas.
`TextFormat.color`	Indica el color del texto.
`TextFormat.font`	Indica el nombre de fuente del texto con un formato de texto.
`TextFormat.indent`	Indica la sangría desde el margen izquierdo al primer carácter del párrafo.
`TextFormat.italic`	Indica si el texto está en cursiva.
`TextFormat.leading`	Indica la cantidad de espacio vertical (interlineado) entre las líneas.
`TextFormat.leftMargin`	Indica el margen izquierdo del párrafo, en puntos.
`TextFormat.rightMargin`	Indica el margen derecho del párrafo, en puntos.
`TextFormat.size`	Indica el tamaño del texto en puntos.
`TextFormat.tabStops`	Especifica tabulaciones personalizadas.
`TextFormat.target`	Indica la ventana de un navegador en la que aparece un hipervínculo.
`TextFormat.underline`	Indica si el texto está subrayado.
`TextFormat.url`	Indica la URL a la que se vincula el texto.

Constructor para la clase TextFormat

Disponibilidad

Flash Player 6.

Sintaxis

new TextFormat([font, [size, [color, [bold, [italic, [underline, [url, [target, [align, [leftMargin, [rightMargin, [indent, [leading]]]]]]]]]]]]])

Parámetros

font Nombre de una fuente para el texto en forma de cadena.

size Número entero que indica el tamaño en puntos.

color Color de texto que utiliza este formato de texto. Número que contiene tres componentes RGB de 8 bits; por ejemplo, 0xFF0000 es rojo y 0x00FF00 es verde.

bold Valor booleano que indica si el texto está en negrita.

italic Valor booleano que indica si el texto está en cursiva.

underline Valor booleano que indica si el texto está subrayado.

url URL con la que el texto de este formato tiene un hipervínculo. Si url es una cadena vacía, el texto no tiene hipervínculo.

target Ventana de destino en la que se muestra el hipervínculo. Si la ventana de destino es una cadena vacía, el texto se muestra en la ventana de destino predeterminada _self. Si se establece el parámetro url en una cadena vacía o en el valor null, puede obtener o establecer esta propiedad, pero la propiedad no tendrá ningún efecto.

align Alineación del párrafo, representado como una cadena. Si su valor es "left", el párrafo se alinea a la izquierda. Si su valor es "center", el párrafo se centra. Si su valor es "right", el párrafo se alinea a la derecha.

leftMargin Indica el margen izquierdo del párrafo, expresado en puntos.

rightMargin Indica el margen derecho del párrafo, expresado en puntos.

indent Número entero que indica la sangría desde el margen izquierdo al primer carácter del párrafo.

leading Número que indica la cantidad de espacio vertical entre líneas.

Valor devuelto

Ninguno.

Descripción

Constructor; crea un objeto TextFormat con las propiedades especificadas. A continuación, puede cambiar las propiedades del objeto TextFormat para cambiar el formato de los campos de texto.

Cualquier parámetro puede establecerse en el valor null para indicar que no está definido. Todos los parámetros son opcionales; todos los parámetros omitidos se tratarán como si tuvieran el valor null.