Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
FormatDescriptor

Package | flashx.textLayout.conversion
Class | public class FormatDescriptor
Inheritance | FormatDescriptor Object

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10.0, AIR 2.0

Contains information about a format.

Public Properties

| Property | Defined By
--- | --- | ---
|  | clipboardFormat : String [read-only] Descriptor used when matching this format to the formats posted on the external clipboard. | FormatDescriptor
|  | exporterClass : Class [read-only] Returns the class used for converting to the format. | FormatDescriptor
|  | format : String [read-only] Returns the data format used by the converter. | FormatDescriptor
|  | importerClass : Class [read-only] Returns the class used for converting data from the format. | FormatDescriptor

Public Methods

| Method | Defined By
--- | --- | ---
|  | FormatDescriptor(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String) Constructor. | FormatDescriptor

Property Detail

clipboardFormat | property

`clipboardFormat:String` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10.0, AIR 2.0

Descriptor used when matching this format to the formats posted on the external clipboard. If the format supports importing, (it's importerClass is not null), it will be called when pasting from the clipboard, if the clipboard contents include data in this format. If the format supports exporting, it will be called when copying to the clipboard, and the output it creates will be posted to the clipboard with this clipboardFormat.

Implementation
`public function get clipboardFormat():String`

See also

flash.desktop.Clipboard
flash.desktop.ClipboardFormats

exporterClass | property |

`exporterClass:Class` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10.0, AIR 2.0

Returns the class used for converting to the format.

Implementation
`public function get exporterClass():Class`

format | property |

`format:String` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10.0, AIR 2.0

Returns the data format used by the converter.

Implementation
`public function get format():String`

importerClass | property |

`importerClass:Class` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10.0, AIR 2.0

Returns the class used for converting data from the format.

Implementation
`public function get importerClass():Class`
Constructor Detail

FormatDescriptor | () | Constructor

`public function FormatDescriptor(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10.0, AIR 2.0

Constructor.

Parameters

| `format:String`
| `importerClass:Class`
| `exporterClass:Class`
| `clipboardFormat:String`

Sun Mar 5 2017, 03:42 PM +11:00