ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage properties / Properties associated with windows, pages and controls
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
The Accessibility property gets and sets the accessibility properties of a control. These properties are as follows:
  • Decorative: indicates whether the field is a decorative field, i.e. whether it should be ignored by the reading system..
  • Description: describes the contents of the field.
  • Action description: describes the field action. This description is only taken into account for controls with a simple, clearly identified action.
  • Reading order: specify the order in which fields are read by the screen reader.
The Accessibility property allows you to personalize and change the settings defined in the control description window ("Help" tab, "Include this control in the accessibility system", "Customize").
Remarks:
  • In Android, this feature is referred to as TalkBack.
  • In iOS, this feature is referred to as VoiceOver.
Example
// Define accessibility attributes for the Name Edit control
EDT_Name.Accessibility.Description = "User name"
EDT_Name.Accessibility.ActionDescription = "Enter your name"
EDT_Name.Accessibility.DecorativeContent = False
EDT_Name.Accessibility.ReadOrder = 1
// Define accessibility attributes for the Address Edit control
EDT_Address.Accessibility.Description = "Delivery address"
EDT_Address.Accessibility.ActionDescription = "Enter your delivery address"
EDT_Address.Accessibility.DecorativeContent = False
EDT_Address.Accessibility.ReadOrder = 3
Syntax

Getting accessibility property values Hide the details

<Result> = <Control used>.Accessibility.<Property name>
<Result>: Type corresponding to the property
Result corresponding to the property used.
<Control used>: Control name
Name of the control used.
<Property name>:
Accessibility property applied:
PropertyTypeDescription
ActionDescriptionCharacter stringDescription of the action of the control. This description is taken into account only on fields with a simple, clearly identified action: click on Button control fields, click on Clickable Image control fields, select an option in a Check Box control or Picker field, select in a Combo control field, a List control field, a Table control field or a RepeatString field..
DecorativeContentBoolean
  • True, if the control is used as decorative content and should be ignored by the screen reader,
  • False otherwise.
DescriptionCharacter stringDescription of the content of the control.
ReadOrderIntegerOrder in which the screen reader will read the controls. Simply specify the number. Controls will be read in ascending order.

Setting the values of accessibility properties Hide the details

<Control used>.Accessibility.<Property name> = <New value>
<Control used>: Control name
Name of the control used.
<Property name>:
Name of the property to be applied:
PropertyTypeDescription
ActionDescriptionCharacter stringDescription of the action of the control. This description is taken into account only on fields with a simple, clearly identified action: click on Button control fields, click on Clickable Image control fields, select an option in a Check Box control or Picker field, select in a Combo control field, a List control field, a Table control field or a RepeatString field..
DecorativeContentBoolean
  • True, if the control is used as decorative content and should be ignored by the screen reader,
  • False otherwise.
DescriptionCharacter stringDescription of the content of the control.
ReadOrderIntegerOrder in which the screen reader will read the controls. Simply specify the number. Controls will be read in ascending order.
<New value>: Type corresponding to the property
New value of the property.
Remarks
iPhone/iPad The Accessibility property can be used on the following controls:
  • Static Text control
  • Button control
  • Edit control
  • Image control
  • Switch control
  • Slider control (native or external)
  • Progress Bar control. Please note: the description corresponds to the option label (cannot be modified)..
  • Check Box control (external):
    • Please note: the description corresponds to the option label (cannot be modified)..
    • The "undefined" state is not supported.
  • Check Box control field (native): the description corresponds to the option label (cannot be modified)..
  • Flexbox control
  • Cell control
Android The Accessibility property can be used on all types of controls.
In advanced controls (Table, Looper, Scheduler, Planning, etc.), TalkBack only reads the details of the container, not the rows or cells.
Minimum version required
  • Version 2024
Comments
Click [Add] to post a comment

Last update: 12/08/2024

Send a report | Local help