Control.AccessibleDescription Control.AccessibleDescription Control.AccessibleDescription Control.AccessibleDescription Property

定义

获取或设置辅助功能客户端应用程序使用的控件说明。Gets or sets the description of the control used by accessibility client applications.

public:
 property System::String ^ AccessibleDescription { System::String ^ get(); void set(System::String ^ value); };
public string AccessibleDescription { get; set; }
member this.AccessibleDescription : string with get, set
Public Property AccessibleDescription As String

属性值

辅助功能客户端应用程序使用的控件说明。The description of the control used by accessibility client applications. 默认值为 nullThe default is null.

示例

下面的代码示例创建的实例CheckBox派生的类, MyCheckBox,将其分配Image到其Image属性,并设置AccessibleNameAccessibleDescription属性,因为Text属性是nullThe 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, because the Text property is null. 此示例要求具有Form名为MyFormThis 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

注解

对象的AccessibleDescription属性提供了有关对象的可视外观的文本说明。An object's AccessibleDescription property provides a textual description about an object's visual appearance. 描述主要用来为视力较差或盲人用户,提供更大的上下文,但也可以使用上下文搜索或其他应用程序。The description is primarily used to provide greater context for low-vision or blind users, but can also be used for context searching or other applications.

AccessibleDescription需要在说明不明显,或如果它是冗余的基于对象的属性AccessibleNameAccessibleRoleState,和Value属性。The AccessibleDescription property is needed if the description is not obvious, or if it is redundant based on the object's AccessibleName, AccessibleRole, State, and Value properties. 例如,一个具有"确定"按钮不需要的其他信息,但显示了兰图片的按钮将。For example, a button with "OK" would not need additional information, but a button that shows a picture of a cactus would. AccessibleName,并AccessibleRole(但也可能Help) 兰按钮的属性描述其用途,但AccessibleDescription属性传达信息不太明确,例如"显示图片兰的按钮。"The AccessibleName, and AccessibleRole (and perhaps Help) properties for the cactus button would describe its purpose, but the AccessibleDescription property would convey information that is less tangible, such as "A button that shows a picture of a cactus."

有关辅助性对象的属性的详细信息,请参阅内容的描述性属性For more information about properties of accessible objects, see Content of Descriptive Properties.

适用于

另请参阅