| パッケージ | flashx.textLayout.conversion |
| インターフェイス | public interface ITextExporter |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
| プロパティ | 定義元 | ||
|---|---|---|---|
| errors : Vector.<String> [読み取り専用]
throwOnError プロパティが false(デフォルト値)に設定されている場合、このプロパティには、エクスポーターメソッドへの呼び出し後に、エラーメッセージのベクトルがストリングとして含まれます。 | ITextExporter | ||
| throwOnError : Boolean
throwOnError プロパティは、エクスポーターでのエラーの処理方法を制御します。 | ITextExporter | ||
| useClipboardAnnotations : Boolean
useClipboardAnnotations プロパティは、インポーターがクリップボードに必要な特別な情報を処理するかどうかを制御します。 | ITextExporter | ||
| メソッド | 定義元 | ||
|---|---|---|---|
TextFlow インスタンスのテキストコンテンツを String 形式、XML 形式、またはユーザー定義の形式で書き出します。 | ITextExporter | ||
errors | プロパティ |
errors:Vector.<String> [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.2, AIR 2.0 |
throwOnError プロパティが false(デフォルト値)に設定されている場合、このプロパティには、エクスポーターメソッドへの呼び出し後に、エラーメッセージのベクトルがストリングとして含まれます。 エラーが存在しない場合、プロパティは null を返します。 プロパティはメソッド呼び出しごとにリセットされます。
実装
public function get errors():Vector.<String>throwOnError | プロパティ |
throwOnError:Boolean| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.2, AIR 2.0 |
throwOnError プロパティは、エクスポーターでのエラーの処理方法を制御します。true に設定されている場合、メソッドはエラー時に Error インスタンスをスローします。 false(デフォルト値)に設定されている場合、エラーはストリングのベクトルとしてまとめられ、errors プロパティに格納されます。エクスポーターがエラーをスローすることはありません。
実装
public function get throwOnError():Boolean public function set throwOnError(value:Boolean):voiduseClipboardAnnotations | プロパティ |
useClipboardAnnotations:Boolean| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
useClipboardAnnotations プロパティは、インポーターがクリップボードに必要な特別な情報を処理するかどうかを制御します。 データが TextFlow 内にある場合、段落は常に完全であり、終了文字が含まれます。 テキストの範囲がクリップボードにペーストされると、そのテキストによって段落が形成されますが、その範囲には最終的な終了文字が含まれない可能性があります。 この場合、段落がクリップボードを対象としているときは、その段落を部分的な段落としてマークして、後でペーストされたときに新しいテキストに正しくマージされるようにする必要があります。 コンテンツがクリップボードを対象としている場合、useClipboardAnnotations は true になります。
実装
public function get useClipboardAnnotations():Boolean public function set useClipboardAnnotations(value:Boolean):voidexport | () | メソッド |
public function export(source:flashx.textLayout.elements:TextFlow, conversionType:String):Object| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
TextFlow インスタンスのテキストコンテンツを String 形式、XML 形式、またはユーザー定義の形式で書き出します。
conversionType パラメーターを次の値のいずれか、またはユーザー定義のエクスポーターのユーザー定義の形式に設定します。
flashx.textLayout.conversion.ConversionType.STRING_TYPEflashx.textLayout.conversion.ConversionType.XML_TYPE
パラメーター
source:flashx.textLayout.elements:TextFlow — エクスポートする TextFlow
| |
conversionType:String — String (STRING_TYPE)、XML (XML_TYPE)、またはユーザー定義の形式を返します。
|
Object — Object。エクスポートされたコンテンツ
|
関連する API エレメント
例 ( この例の使用方法 )
次のコードスニペットは、export メソッドを使用して、フォーマットされたテキストの繰り返しエクスポートを実行する方法を示しています。
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;
}
}
}
Tue Jun 12 2018, 10:34 AM Z