User Guide

236 Chapter 6: ActionScript Core Classes
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();
In the following example, to revert a property to its default value (false for Boolean values,
empty strings for String values), delete the property from the
_accProps object:
my_mc._accProps.silent = true; // set a property
// other code here
delete my_mc._accProps.silent; // revert to default value
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
Accessibility.isActive()
, Accessibility.updateProperties(),
System.capabilities.hasAccessibility