AccessibleName Property
TOC
Collapse the table of content
Expand the table of content

Control.AccessibleName Property

 

Gets or sets the name of the control used by accessibility client applications.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

Public Property AccessibleName As String

Property Value

Type: System.String

The name of the control used by accessibility client applications. The default is null.

The AccessibleName property is a label that briefly describes and identifies the object within its container, such as the text in a Button, the name of a MenuItem, or a label displayed next to a TextBox control.

For more information about properties of accessible objects, see the "Content of Descriptive Properties.

The following code example creates an instance of a CheckBox derived class, MyCheckBox, assigns it an Image to its Image property and sets the AccessibleName and AccessibleDescription properties since the Text property is null. This example requires that you have a Form named MyForm.

Public Sub New()
   ' Create a 'MyCheckBox' control and 
   ' display an image on it. 
   Dim myCheckBox As New MyCustomControls.MyCheckBox()
   myCheckBox.Location = New Point(5, 5)
   myCheckBox.Image = Image.FromFile( _
     Application.CommonAppDataPath + "\Preview.jpg")

   ' Set the AccessibleName property
   ' since there is no Text displayed. 
   myCheckBox.AccessibleName = "Preview"

   ' Set the AccessibleDescription text.
   myCheckBox.AccessibleDescription = _
     "A toggle button used to show the document preview."
   Me.Controls.Add(myCheckBox)
End Sub

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft