Referencia de ActionScript® 3.0 para la plataforma de Adobe® Flash®
Inicio  |  Ocultar lista de paquetes y clases |  Paquetes  |  Clases  |  Novedades  |  Índice  |  Apéndices  |  ¿Por qué hay texto en inglés?
Filtros: Recuperando datos del servidor...
Recuperando datos del servidor...
flashx.textLayout.conversion 

ITextExporter  - AS3

Paqueteflashx.textLayout.conversion
Interfazpublic interface ITextExporter

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Interfaz para exportar contenido de texto desde una instancia de TextFlow a un formato determinado, por ejemplo formato de cadena o XML, o un formato definido por el usuario. Los exportadores admiten la obtención y ajuste de propiedades para controlar la exportación de datos. Estas propiedades se implementan como propiedades públicas, pero el acceso directo de estas propiedades debe evitarse, ya que un usuario podría reemplazar la clase converter en el registro TextConverter registro, provocando fallos importantes.



Propiedades públicas
 PropiedadDefinido por
  errors : Vector.<String>
[solo lectura] Esta propiedad contiene un vector de mensajes de error como cadenas después de una llamada a método exportador y la propiedad throwOnError se establece como false, que es el valor predeterminado.
ITextExporter
  throwOnError : Boolean
La propiedad throwOnError controla el modo en que exportador maneja los errores.
ITextExporter
  useClipboardAnnotations : Boolean
La propiedad useClipboardAnnotations controla si el importador debe manejar o no la información adicional necesaria para el portapapeles.
ITextExporter
Métodos públicos
 MétodoDefinido por
  
Exporta contenido de texto desde una instancia de TextFlow en cadena, XML, o formato definido por el usuario.
ITextExporter
Información sobre propiedades

errors

propiedad
errors:Vector.<String>  [solo lectura]

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10.2, AIR 2.0

Esta propiedad contiene un vector de mensajes de error como cadenas después de una llamada a método exportador y la propiedad throwOnError se establece como false, que es el valor predeterminado. Si no se han producido errores, la propiedad devuelve null. La propiedad se restablece en cada llamada al método.



Implementación
    public function get errors():Vector.<String>

throwOnError

propiedad 
throwOnError:Boolean

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10.2, AIR 2.0

La propiedad throwOnError controla el modo en que exportador maneja los errores. Si se establece en true, los métodos emiten una instancia de Error sobre los errores. Si se establece en false, que es el valor predeterminado, los errores se recopilan en un vector de cadenas y se almacenan en la propiedad errors, y el exportador no emite nada.



Implementación
    public function get throwOnError():Boolean
    public function set throwOnError(value:Boolean):void

useClipboardAnnotations

propiedad 
useClipboardAnnotations:Boolean

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

La propiedad useClipboardAnnotations controla si el importador debe manejar o no la información adicional necesaria para el portapapeles. Cuando los datos se encuentran en un objeto TextFlow, los párrafos siempre están completos y se incluye un carácter de terminación. Cuando un rango de texto se pega en el portapapeles, formará párrafos, pero el rango puede que no se incluya en el terminador final. En este caso, el párrafo debe estar marcado como un párrafo parcial si está destinado al portapapeles, de manera que, si más adelante se pegan, se fusionarán correctamente en el nuevo texto. Si el contenido está pensado para el portapapeles, useClipboardAnnotations será true.



Implementación
    public function get useClipboardAnnotations():Boolean
    public function set useClipboardAnnotations(value:Boolean):void
Información sobre métodos

export

()método
public function export(source:flashx.textLayout.elements:TextFlow, conversionType:String):Object

Versión del lenguaje: ActionScript 3.0
Versiones de motor de ejecución: Flash Player 10, AIR 1.5

Exporta contenido de texto desde una instancia de TextFlow en cadena, XML, o formato definido por el usuario.

Define el parámetro conversionType en cualquiera de los siguientes valores o un formato definido por el usuario en exportadores definidos por el usuario.

  • flashx.textLayout.conversion.ConversionType.STRING_TYPE;
  • flashx.textLayout.conversion.ConversionType.XML_TYPE.

Parámetros

source:flashx.textLayout.elements:TextFlow — Objeto TextFlow que se va a exportar
 
conversionType:String — Devuelve una cadena (STRING_TYPE) o XML (XML_TYPE), o cualquier formato definido por el usuario

Valor devuelto
Object — Objeto Contenido exportado

Elementos de API relacionados


Ejemplo  ( Cómo utilizar este ejemplo )

Este fragmento de código muestra un uso del método export para llevar a cabo exportaciones repetidas de texto con formato.

package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ConversionType;
    import flashx.textLayout.conversion.ITextExporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class ITextExporterExample 
    {
        // Serialize the TextFlow into a String
        static public function export(textFlow:TextFlow):String
        {
            var exporter:ITextExporter = TextConverter.getExporter(TextConverter.TEXT_LAYOUT_FORMAT);
            return exporter.export(textFlow, ConversionType.STRING_TYPE) as String;
        }
    }
}




[ X ]¿Por qué hay texto en inglés?
Cierto contenido de la Referencia de ActionScript 3.0 se muestra en inglés

No todo el contenido de la Referencia de ActionScript 3.0 se traduce a todos los idiomas. Si un elemento del lenguaje no se traduce, aparecerá en inglés. Por ejemplo, la clase ga.controls.HelpBox no está traducida en ningún idioma. Por lo tanto, en la versión en español de la referencia, la clase ga.controls.HelpBox aparecerá en inglés.