Accessibility.updateProperties()

Availability

Flash Player 6 version 65.

Usage

Accessibility.updateProperties()

Parameters

None.

Returns

Nothing.

Description

Method; causes Flash Player to reexamine all accessibility properties, update its description of objects for screen readers, and, if necessary, send events to screen readers to indicate that changes have occurred. For information on setting accessibility properties, see _accProps.

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

If you modify the accessibility properties for multiple objects, only one call to Accessibility.updateProperties() is necessary; multiple calls can result in reduced performance and unintelligible screen reader results.

Example

The following ActionScript code takes advantage of dynamic accessibility properties. This example is from a nontextual button that can change which icon it displays.

function setIcon( newIconNum, newTextEquivalent )
{
   this.iconImage = this.iconImages[ newIconNum ];
   if ( newTextEquivalent != undefined )
   {
      if ( this._accProps == undefined )
         this._accProps = new Object();
      this._accProps.name = newTextEquivalent;
      Accessibility.updateProperties();
   }
}