Packageflashx.textLayout.conversion
Interfacepublic interface IPlainTextExporter extends ITextExporter
Implementors PlainTextExporter

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.0, AIR 2.0

This interface should be implemented by converters that export plain text. Clients that have explicitly created an exporter using TextConverter.getExporter may control the export process by calling into these methods on the exporter.



Public Properties
 PropertyDefined By
 Inheritedconfig : ImportExportConfiguration
Accesses the config options for the exporter.
ITextExporter
 Inheritederrors : Vector.<String>
[read-only] 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.
ITextExporter
  paragraphSeparator : String
Specifies the character sequence used (in a text flow's plain-text equivalent) to separate paragraphs.
IPlainTextExporter
  stripDiscretionaryHyphens : Boolean
This property indicates whether discretionary hyphens in the text should be stripped during the export process.
IPlainTextExporter
 InheritedthrowOnError : Boolean
The throwOnError property controls how the exporter handles errors.
ITextExporter
 InheriteduseClipboardAnnotations : Boolean
The useClipboardAnnotations property controls whether or not the importer should handle the extra information necessary for the clipboard.
ITextExporter
Public Methods
 MethodDefined By
 Inherited
export(source:TextFlow, conversionType:String):Object
Export text content from a TextFlow instance in String, or XML, or a user defined format.
ITextExporter
Property Detail
paragraphSeparatorproperty
paragraphSeparator:String

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Specifies the character sequence used (in a text flow's plain-text equivalent) to separate paragraphs. The paragraph separator is not added after the last paragraph.

This property applies to the PLAIN_TEXT_FORMAT exporter.

The default value is "\n".


Implementation
    public function get paragraphSeparator():String
    public function set paragraphSeparator(value:String):void
stripDiscretionaryHyphensproperty 
stripDiscretionaryHyphens:Boolean

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

This property indicates whether discretionary hyphens in the text should be stripped during the export process. Discretionary hyphens, also known as "soft hyphens", indicate where to break a word in case the word must be split between two lines. The Unicode character for discretionary hyphens is \u00AD.

If this property is set to true, discretionary hyphens that are in the original text will not be in the exported text, even if they are part of the original text. If false, discretionary hyphens will be in the exported text.


Implementation
    public function get stripDiscretionaryHyphens():Boolean
    public function set stripDiscretionaryHyphens(value:Boolean):void