ClientEvents プロパティ (GcFunctionKey)

クライアント側のイベントを処理するJavaScriptイベントハンドラを表すFunctionKeyClientEventsオブジェクトを取得します。

構文

Visual Basic (宣言)
C#

Public Shadows ReadOnly Property ClientEvents As FunctionKeyClientEvents

public new FunctionKeyClientEvents ClientEvents {get;}

解説

ClientEventsプロパティは、ファンクションキーコントロールのクライアント側のイベントをラップするFunctionKeyClientEventsオブジェクトを参照します。

サーバーコードからクライアントイベントハンドラを作成する場合、ClientEventsプロパティを使用します。尚、クライアント側のスクリプトはJavaScriptによって記述し、ASPXページに実装します。

次のFunctionKeyClientEventsオブジェクトの各プロパティが、ショートカットエクステンダで設定可能なクライアント側イベントとなります。

イベント名	説明
FunctionKeyDown	設定されたファンクションキーが押下されたときに発生します。

使用例

次のサンプルコードでは、［F1］キーが押されたとき、メッセージを表示する例を示します。

Visual Basic
C#

Imports GrapeCity.Web.Input.IMFunctionKey

' ファンクションボタンに［F1］キーを設定します。
Dim fb1 As New FunctionKeyButton
fb1.FunctionKey = FunctionKeys.F1
fb1.ForbidReservedKeyBehavior = True
fb1.Text = "F1キー"

' ファンクションキーコントロールにファンクションボタンを追加します。
GcFunctionKey1.FunctionKeyButtons.Add(fb1)

' FunctionKeyClientEventsクライアントイベントを設定します。
GcFunctionKey1.ClientEvents.FunctionKeyDown = "GcFunctionKey1_FunctionKeyDown"

using GrapeCity.Web.Input.IMFunctionKey;

// ファンクションボタンに［F1］キーを設定します。
FunctionKeyButton fb1 As new FunctionKeyButton()
fb1.FunctionKey = FunctionKeys.F1;
fb1.ForbidReservedKeyBehavior = true;
fb1.Text = "F1キー";

//' ファンクションキーコントロールにファンクションボタンを追加します。
GcFunctionKey1.FunctionKeyButtons.Add(fb1);

// FunctionKeyClientEventsクライアントイベントを設定します。
GcFunctionKey1.ClientEvents.FunctionKeyDown = "GcFunctionKey1_FunctionKeyDown";

JavaScript

function GcFunctionKey1_FunctionKeyDown(sender, eArgs)
{
   if(eArgs.FunctionKey == FunctionKeys.F1)
   {
       // ［F1］キーが押されたとき、アラートを表示します。
       alert("ヘルプは表示されません。");
   }
}

参照

GcFunctionKey クラス
 GcFunctionKey メンバ