adobe.utils

# XMLUI - AS3 Flash

Package | adobe.utils
Class | public final class XMLUI
Inheritance | XMLUI Object

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | AIR 1.0, Flash Player 9

The XMLUI class enables communication with SWF files that are used as custom user interfaces for the Flash authoring tool's extensibility features.

Macromedia Flash MX 2004 and Macromedia Flash MX Professional 2004 and later versions come with several extensibility features including Behaviors, Commands (JavaScript API), Effects, and Tools. With these features, advanced users can extend or automate the authoring tool's capabilities. The XML-to-UI engine works with each of these extensibility features to create dialog boxes that the user sees if the extension either requires or accepts parameters. You can define dialog boxes by using XML tags or by creating a SWF file to display. The XMLUI object provides a mechanism by which an advanced user can communicate with a SWF file used in such a manner.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | accept():void [static] Makes the current XMLUI dialog box close with an "accept" state. | XMLUI
|  | cancel():void [static] Makes the current XMLUI dialog box close with a "cancel" state. | XMLUI
|  | getProperty(name:String):String [static] Retrieves the value of the specified property of the current XMLUI dialog box. | XMLUI
|  | 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
|  | setProperty(name:String, value:String):void [static] Modifies the value of the specified property of the current XMLUI dialog. | XMLUI
|  | 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

Method Detail

### accept

()
method

`public static function accept():void`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | AIR 1.0, Flash Player 9

Makes the current XMLUI dialog box close with an "accept" state. This is identical to the user clicking the OK button.

### cancel

()
method

`public static function cancel():void`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | AIR 1.0, Flash Player 9

Makes the current XMLUI dialog box close with a "cancel" state. This is identical to the user clicking the Cancel button.

### getProperty

()
method

`public static function getProperty(name:String):String`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | AIR 1.0, Flash Player 9

Retrieves the value of the specified property of the current XMLUI dialog box.

Parameters

| `name:String` — The name of the XMLUI property to retrieve.

Returns

| `String` — The value of the property.

### setProperty

()
method

`public static function setProperty(name:String, value:String):void`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | AIR 1.0, Flash Player 9

Modifies the value of the specified property of the current XMLUI dialog.

Parameters

| `name:String` — The name of the XMLUI property to modify.
| `value:String` — The value to which the specified property will be set.

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