Control.AccessibleName Property
Definition
Gets or sets the name of the control used by accessibility client applications.
public:
property System::String ^ AccessibleName { System::String ^ get(); void set(System::String ^ value); };
public string AccessibleName { get; set; }
member this.AccessibleName : string with get, set
Public Property AccessibleName As String
Property Value
The name of the control used by accessibility client applications. The default is null
.
Examples
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:
MyForm()
{
// Create a 'MyCheckBox' control and
// display an image on it.
MyCustomControls::MyCheckBox^ myCheckBox = gcnew MyCustomControls::MyCheckBox;
myCheckBox->Location = Point(5,5);
myCheckBox->Image = Image::FromFile( String::Concat( 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 );
}
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);
}
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
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.