Export (0) Print
Expand All
Expand Minimize

Control.AccessibleName Property

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

[Visual Basic]
Public Property AccessibleName As String
[C#]
public string AccessibleName {get; set;}
[C++]
public: __property String* get_AccessibleName();
public: __property void set_AccessibleName(String*);
[JScript]
public function get AccessibleName() : String;
public function set AccessibleName(String);

Property Value

The name of the control used by accessibility client applications. The default is a null reference (Nothing in Visual Basic).

Remarks

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 topic in the Active Accessibility section of the MSDN Library.

Example

[Visual Basic, C#, C++] The following 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 a null reference (Nothing in Visual Basic). This example assumes you have a Form named MyForm.

[Visual Basic] 
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

[C#] 
public MyForm()
{
   // Create a 'MyCheckBox' control and 
   // display an image on it.
   MyCustomControls.MyCheckBox myCheckBox = 
      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";
   myCheckBox.AccessibleDescription =
     "A toggle button used to show the document preview.";
   this.Controls.Add(myCheckBox);
}

[C++] 
public:
   MyForm() {
      // Create a 'MyCheckBox' control and
      // display an image on it.
      MyCustomControls::MyCheckBox* myCheckBox = new MyCustomControls::MyCheckBox();
      myCheckBox->Location =  Point(5, 5);
      myCheckBox->Image = Image::FromFile(String::Concat(Application::CommonAppDataPath, S"\\Preview.jpg"));

      // Set the AccessibleName property
      // since there is no Text displayed.
      myCheckBox->AccessibleName = S"Preview";
      myCheckBox->AccessibleDescription =
         S"A toggle button used to show the document preview.";
      this->Controls->Add(myCheckBox);
   }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Control Class | Control Members | System.Windows.Forms Namespace | AccessibleDescription | AccessibleRole | AccessibleDefaultActionDescription | Name

Show:
© 2014 Microsoft