CursorPosition プロパティ (GcMask)

フォーカスを受け取ったときにキャレットを配置するフィールドを指定する値を取得または設定します。

構文

Visual Basic (宣言)
C#

Public Property CursorPosition As Integer

public int CursorPosition {get; set;}

プロパティ値

既定値：-1

例外

例外	解説
System.ArgumentOutOfRangeException	-1未満の値が設定されています。

解説

CursorPositionプロパティとHighlightTextプロパティの設定により、キャレットを配置するフィールドまたは選択状態にするフィールドを指定できます。

HighlightTextの値	キャレットまたはフィールドの状態
0 - None	キャレットは、CursorPositionプロパティで指定したフィールドの最初の桁に位置します。
1 - Field	CursorPositionプロパティで指定したフィールドが選択状態になります。
2 - All	CursorPositionプロパティの設定に関わらず、コントロール内のすべての内容が選択状態になります。

CursorPositionプロパティに「フィールド総数 - 1」よりも大きなインデックスを設定すると、"CursorPosition = 0"として扱われます。

なお、CursorPositionプロパティは、コントロールがフォーカスを受け取る前に設定する必要があります。CursorPositionプロパティをEnterイベント内で設定しても、正しく動作しません。

使用例

次のサンプルコードは、フォーカスを受け取ったときに、最初のフィールドを選択状態にする方法を示します。

Visual Basic
C#

Imports GrapeCity.Web.Input.Core

Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    GcMask1.Format.Pattern = "郵便番号：\D{3}-\D{4}"
    GcMask1.CursorPosition = 0
    GcMask1.HighlightText = HighlightText.Field
End Sub

using GrapeCity.Web.Input.Core;

private void Page_Load(object sender, System.EventArgs e)
{
    GcMask1.Format.Pattern = "郵便番号：\D{3}-\D{4}";
    GcMask1.CursorPosition = 0;
    GcMask1.HighlightText = HighlightText.Field;
}

参照

GcMask クラス
 GcMask メンバ