Export (0) Print
Expand All
Expand Minimize

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)

'Declaration
Public Property AccessibleName As String

Property Value

Type: System.String
The name of the control used by accessibility client applications. The default is Nothing.

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 Nothing. 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

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft