Control.AccessibleDescription 属性

定义

获取或设置辅助功能客户端应用程序使用的控件说明。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 属性是 null的。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, because the Text property is null. 此示例要求你有一个名为 MyFormFormThis 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.

如果说明不明显,或者根据对象的 AccessibleNameAccessibleRoleStateValue 属性,则需要 AccessibleDescription 属性。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.

适用于

另请参阅