Control.AccessibleDescription Property

Definition

Obtém ou define a descrição do controle usada pelos aplicativos cliente de acessibilidade.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

Property Value

String

A descrição do controle usada pelos aplicativos cliente de acessibilidade.The description of the control used by accessibility client applications. O padrão é null.The default is null.

Examples

O exemplo de código a seguir cria uma instância de uma classe derivada CheckBox, MyCheckBox, atribui uma Image à sua propriedade Image e define as propriedades AccessibleName e AccessibleDescription, porque a propriedade 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. Este exemplo requer que você tenha um Form chamado MyForm.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

A propriedade AccessibleDescription de um objeto fornece uma descrição textual sobre a aparência visual de um objeto.An object's AccessibleDescription property provides a textual description about an object's visual appearance. A descrição é usada principalmente para fornecer um contexto maior para usuários com deficiência visual ou cegas, mas também pode ser usada para pesquisa de contexto ou outros aplicativos.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.

A propriedade AccessibleDescription será necessária se a descrição não for óbvia ou se for redundante com base nas propriedades AccessibleName, AccessibleRole, Statee Value do objeto.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. Por exemplo, um botão com "OK" não precisará de informações adicionais, mas um botão que mostra uma imagem de um cacto faria.For example, a button with "OK" would not need additional information, but a button that shows a picture of a cactus would. As propriedades AccessibleNamee AccessibleRole (e talvez Help) do botão cacto descreveriam sua finalidade, mas a propriedade AccessibleDescription transmitiria informações que são menos tangíveis, como "um botão que mostra uma imagem de um cacto".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."

Para obter mais informações sobre propriedades de objetos acessíveis, consulte conteúdo de propriedades descritivas.For more information about properties of accessible objects, see Content of Descriptive Properties.

Applies to

See also