Flash CS3 Documentation

ActionScript 2.0 Language Reference > ActionScript language elements > Global Properties > _accProps property

_accProps property

_accProps.propertyName
instanceName._accProps.propertyName

Lets you control screen reader accessibility options for SWF files, movie clips, buttons, dynamic text fields, and input text fields at runtime. These properties override the corresponding settings available in the Accessibilitypanel during authoring. For changes to these properties to take effect, you must call Accessibility.updateProperties().

For information on the Accessibility panel, see "The Flash Accessibility panel" in Using Flash.

To determine whether the player is running in an environment that supports accessibility aids, use the System.capabilities.hasAccessibility property .

The following table lists the name and data type of each _accProps property , its equivalent setting in the Accessibility panel, and the kinds of objects to which the property can be applied. The term inverse logic means that the property setting is the inverse of the corresponding setting in the Accessibility panel. For example, setting the silent property to true is equivalent to deselecting the Make Movie Accessible or Make Object Accessible option.

For the Shortcut field, use names of the form Control+A. Adding a keyboard shortcut to the Accessibility panel doesn't create a keyboard shortcut; it merely advises screen readers of an existing shortcut. For information on assigninga keyboard shortcut to an accessible object, see Key.addListener().

To specify settings that correspond to the Tab index setting in the Accessibility panel, use the Button.tabIndex, MovieClip.tabIndex, or TextField.tabIndex properties.

There is no way to specify an Auto Label setting at runtime.

To refer to the _accProps object that represents the entire Flash document, omit the instanceName parameter. The value of _accProps must be an object. This means that if no _accProps object already exists, you must create one, as shown in the following example, before you can assign values to the properties of the _accProps object:

if ( _accProps == undefined ) 
{ 
 _accProps = new Object(); 
} 
_accProps.name = "My SWF file";

When _accProps is used without the instanceName parameter, changes made to _accProps properties apply to the whole SWF file. For example, the following code sets the Accessibility name property for the whole SWF file to the string "Pet Store" and then calls Accessibility.updateProperties() to cause that change:

_accProps.name = "Pet Store"; 
Accessibility.updateProperties(); 

In contrast, the following code sets the name property for a movie clip with the instance name price_mc to the string "Price":

price_mc._accProps.name = "Price";
Accessibility.updateProperties(); 

If you are specifying several accessibility properties, make as many changes as you can before calling Accessibility.updateProperties(), instead of calling it after each property statement, as shown in the following example:

_accProps.name = "Pet Store";

animal_mc._accProps.name = "Animal"; 
animal_mc._accProps.description = "Cat, dog, fish, etc.";

price_mc._accProps.name = "Price";
price_mc._accProps.description = "Cost of a single item";

Accessibility.updateProperties(); 

If you don't specify an accessibility property for a document or an object, any values set in the Accessibility panel are implemented.

After you specify an accessibility property, you can't revert its value to avalue set in the Accessibility panel. However, you can set the property to itsdefault value (false for Boolean values; empty strings for stringvalues) by deleting the property from the _accProps object, as shownin the following example:

 my_mc._accProps.silent = true; // set a property 
// other code here 
delete my_mc._accProps.silent; // revert to default value 

Availability: ActionScript 1.0; Flash Player 6,0,65,0

Parameters

propertyName:Boolean or String - An accessibility property name (see the following description for valid names). instanceName

instanceName:String - The instance name assigned to an instance of a movie clip, button, dynamic text field, or input text field. To refer to the _accProps object that represents the entire Flash document, omit instanceName.

Example

If you change an image and want to update its accessibility description, you can use the following ActionScript code:

my_mc.gotoAndStop(2);

if (my_mc._accProps == undefined ) {
 my_mc._accProps = new Object();
}

my_mc._accProps.name = "Photo of Mount Rushmore";
Accessibility.updateProperties();

See also

isActive (Accessibility.isActive method), updateProperties (Accessibility.updateProperties method), hasAccessibility (capabilities.hasAccessibility property)

Flash CS3