Control.AccessibleDescription プロパティ

.NET Framework クラス ライブラリ リファレンス

Control.AccessibleDescription プロパティ

ユーザー補助クライアント アプリケーションによって使用される、コントロールの説明を取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

<LocalizableAttribute(True)> _
Public Property AccessibleDescription As
 String

Visual Basic (使用法)

Dim instance As Control
Dim value As String

value = instance.AccessibleDescription

instance.AccessibleDescription = value

C#

[LocalizableAttribute(true)] 
public string AccessibleDescription { get;
 set; }

C++

[LocalizableAttribute(true)] 
public:
property String^ AccessibleDescription {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_AccessibleDescription ()

/** @property */
public void set_AccessibleDescription (String
 value)

JScript

public function get AccessibleDescription
 () : String

public function set AccessibleDescription
 (value : String)

プロパティ値
ユーザー補助クライアント アプリケーションによって使用されるコントロールの説明。既定値は null 参照 (Visual Basic では Nothing) です。

解説

オブジェクトの AccessibleDescription プロパティは、オブジェクトの外観に関するテキストによる説明を提供します。この説明は、主に、視力の弱いユーザーや視覚障害があるユーザーのために大きなコンテキストを提供するために使用しますが、コンテキスト検索やその他のアプリケーションでも使用できます。

AccessibleDescription プロパティは、説明が明白でない場合や、オブジェクトの AccessibleName、AccessibleRole、State、Value の各プロパティでは説明が冗長な場合に必要です。たとえば、"OK" のボタンは追加情報を必要としませんが、サボテンの絵柄のボタンの場合は必要になります。サボテンのボタンでは、AccessibleName プロパティと AccessibleRole プロパティによって (必要に応じて Help プロパティでも) その用途を説明できますが、"サボテンの絵が表示されたボタン" のような実用性の低い情報は、AccessibleDescription プロパティによって伝えます。

ユーザー補助オブジェクトのプロパティの詳細については、MSDN ライブラリ (http://msdn.microsoft.com/library) の「Content of Descriptive Properties」を参照してください。

使用例

CheckBox 派生クラス MyCheckBox のインスタンスを作成し、その Image プロパティに Image を割り当て、Text プロパティが null 参照 (Visual Basic では Nothing) であるため AccessibleName プロパティと AccessibleDescription プロパティを設定するコード例を次に示します。この例では、MyForm という名前の Form が存在している必要があります。

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 = 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 );
   }

J#

public MyForm()
{
    // Create a 'MyCheckBox' control and 
    // display an image on it.
    MyCustomControls.MyCheckBox myCheckBox = 
        new MyCustomControls.MyCheckBox();
    myCheckBox.set_Location(new Point(5, 5));
    myCheckBox.set_Image(Image.FromFile(Application.get_CommonAppDataPath() 
        + "\\Preview.jpg"));
    // Set the AccessibleName property
    // since there is no Text displayed.
    myCheckBox.set_AccessibleName("Preview");
    myCheckBox.set_AccessibleDescription(
        "A toggle button used to show the document preview.");
    this.get_Controls().Add(myCheckBox);
} //MyForm

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
Control クラス
Control メンバ
System.Windows.Forms 名前空間
AccessibleName
AccessibleRole
Control.AccessibleDefaultActionDescription プロパティ
AccessibleObject.Description プロパティ