mx.automation

# IAutomationClass - AS3 Flex

Package | mx.automation
Interface | public interface IAutomationClass

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The IAutomationClass interface defines the interface for a component class descriptor.

Learn more

Understanding the automation framework

Public Properties

| Property | Defined By
--- | --- | ---
|  | name : String [read-only] The class name. | IAutomationClass
|  | propertyNameMap : Object [read-only] An Object containing a map to map a property name to descriptor. | IAutomationClass
|  | superClassName : String [read-only] The name of the class's superclass. | IAutomationClass

Public Methods

| Method | Defined By
--- | --- | ---
|  | getDescriptorForEvent(event:Event):IAutomationEventDescriptor Returns an IAutomationEventDescriptor object for the specified event object. | IAutomationClass
|  | getDescriptorForEventByName(eventName:String):IAutomationEventDescriptor Returns an IAutomationEventDescriptor object from the event's name. | IAutomationClass
|  | getDescriptorForMethodByName(methodName:String):IAutomationMethodDescriptor Returns an IAutomationMethodDescriptorfrom object from the method's name. | IAutomationClass
|  | getPropertyDescriptors(objForInitialization:Object = null, forVerification:Boolean = true, forDescription:Boolean = true):Array Returns the list of properties this class supports. | IAutomationClass

Property Detail

### name

property

`name:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The class name.

Implementation
`public function get name():String`

### propertyNameMap

property

`propertyNameMap:Object` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

An Object containing a map to map a property name to descriptor. The following example uses this property:

    var descriptor:IAutomationPropertyDescriptor = map[propertyNameMap];

Implementation
`public function get propertyNameMap():Object`

### superClassName

property

`superClassName:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The name of the class's superclass.

Implementation
`public function get superClassName():String`
Method Detail

### getDescriptorForEvent

()
method

`public function getDescriptorForEvent(event:Event):IAutomationEventDescriptor`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns an `IAutomationEventDescriptor` object for the specified event object.

Parameters

| `event:Event` — The event for which the descriptor is required.

Returns

| `IAutomationEventDescriptor`

### getDescriptorForEventByName

()
method

`public function getDescriptorForEventByName(eventName:String):IAutomationEventDescriptor`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns an `IAutomationEventDescriptor` object from the event's name.

Parameters

| `eventName:String` — The event name for which the descriptor is required.

Returns

| `IAutomationEventDescriptor` — The event descriptor for the name passed if one is available. Otherwise null.

### getDescriptorForMethodByName

()
method

`public function getDescriptorForMethodByName(methodName:String):IAutomationMethodDescriptor`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns an `IAutomationMethodDescriptorfrom` object from the method's name.

Parameters

| `methodName:String` — The method name for which the descriptor is required.

Returns

| `IAutomationMethodDescriptor` — The method descriptor for the name passed if one is available. Otherwise, null.

### getPropertyDescriptors

()
method

`public function getPropertyDescriptors(objForInitialization:Object = null, forVerification:Boolean = true, forDescription:Boolean = true):Array`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the list of properties this class supports.

Parameters

| `objForInitialization:Object` (default = `null`)`` — Object which can be used to find the ActionScript type of the properties.
| `forVerification:Boolean` (default = `true`)`` — If `true`, indicates that properties used for verification should be included in the return value.
| `forDescription:Boolean` (default = `true`)`` — If `true`, indicates that properties used for object identitication should be included in the return value.

Returns

| `Array` — Array containing property descriptions.

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