WebControl.AccessKey プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls
アセンブリ:
System.Web.dll

Web サーバー コントロールにすばやく移動できるアクセス キーを取得または設定します。

public:
 virtual property System::String ^ AccessKey { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Bindable(true)]
public virtual string AccessKey { get; set; }
public virtual string AccessKey { get; set; }
[<System.ComponentModel.Bindable(true)>]
member this.AccessKey : string with get, set
member this.AccessKey : string with get, set
Public Overridable Property AccessKey As String

プロパティ値

String

Web サーバー コントロールにすばやく移動できるアクセス キー。 既定値は Empty で、このプロパティが設定されていないことを示します。

属性
BindableAttribute

例外

ArgumentOutOfRangeException

指定されたアクセス キーが null、Empty、または単一の文字列のいずれでもありません。

例

次の例は、コントロールの プロパティを設定して使用する AccessKey 方法を TextBox 示しています。

重要

この例には、ユーザー入力を受け付けるテキスト ボックスがあります。これにより、セキュリティが脆弱になる可能性があります。 既定では、ASP.NET Web ページによって、ユーザー入力にスクリプトまたは HTML 要素が含まれていないかどうかが検証されます。 詳細については、「スクリプトによる攻略の概要」を参照してください。

<%@ Page Language="C#" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
 <head>
    <title>AccessKey Property of a Web Control</title>
</head>
 <body>
 
   <h3>AccessKey Property of a Web Control</h3>
 
 <form id="form1" runat="server">
 
   <asp:TextBox id="TextBox1" 
     AccessKey="Y" 
     Text="Press Alt-Y to get focus here" 
     Columns="45"
     runat="server"/>
 
   <br />
 
   <asp:TextBox id="TextBox2" 
     AccessKey="Z" 
     Text="Press Alt-Z to get focus here" 
     Columns="45"
     runat="server"/>
 
 </form>
 
 </body>
 </html>

<%@ Page Language="VB" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
 <head>
    <title>AccessKey Property of a Web Control</title>
</head>
 <body>
 
   <h3>AccessKey Property of a Web Control</h3>
 
 <form id="form1" runat="server">
 
   <asp:TextBox id="TextBox1" 
     AccessKey="Y" 
     Text="Press Alt-Y to get focus here" 
     Columns="45"
     runat="server"/>
 
   <br />
 
   <asp:TextBox id="TextBox2" 
     AccessKey="Z" 
     Text="Press Alt-Z to get focus here" 
     Columns="45"
     runat="server"/>
 
 </form>
 
 </body>
 </html>

注釈

プロパティを AccessKey 使用して、Web サーバー コントロールのキーボード ショートカットを指定します。 これにより、Alt キーとキーボードの指定した文字のキーを押すと、コントロールにすばやく移動できます。 たとえば、コントロールのアクセス キーを文字列 "D" に設定すると、ユーザーは Alt キーを押しながら D キーを押してコントロールに移動できます。

プロパティには、1 つの文字列のみを使用できます AccessKey 。 このプロパティを、または 1 つの文字列でないnullEmpty値に設定しようとすると、例外がスローされます。

注意

このプロパティは、Internet Explorer 4.0 以降でのみサポートされています。

適用対象

こちらもご覧ください