ITextExporter  - AS3

This property contains a vector of error messages as strings after a call to an exporter method is the throwOnError property is set to false, which is the default. If there were no errors, the property returns null. The property is reset on each method call.

The throwOnError property controls how the exporter handles errors. If set to true, methods throw an Error instance on errors. If set to false, which is the default, errors are collected into a vector of strings and stored in the errors property, and the exporter does not throw.

The useClipboardAnnotations property controls whether or not the importer should handle the extra information necessary for the clipboard. When data is in a TextFlow, paragraphs are always complete, and include a terminator character. When a range of text is pasted to the clipboard, it will form paragraphs, but the range may not include in the final terminator. In this case, the paragraph needs to be marked as a partial paragraph if it is intended for the clipboard, so that if it is later pasted it will merge into the new text correctly. If the content is intended for the clipboard, useClipboardAnnotations will be true.

Export text content from a TextFlow instance in String, or XML, or a user defined format.

Set the conversionType parameter to either of the following values, or a user defined format in user-defined exporters.

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

Parameters

Related API Elements

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;
        }
    }
}