flashx.textLayout.conversion

# FormatDescriptor - AS3

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

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | clipboardFormat : String [read-only] Descriptor used when matching this format to the formats posted on the external clipboard. | FormatDescriptor
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | FormatDescriptor(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String) Constructor. | FormatDescriptor
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### clipboardFormat

property

`clipboardFormat:String` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

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`

Related API Elements

flash.desktop.Clipboard
flash.desktop.ClipboardFormats

### exporterClass

property

`exporterClass:Class` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

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, AIR 1.5

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, AIR 1.5

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, AIR 1.5

Constructor.

Parameters

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00