スピン機能

日付コントロールには、書式に設定した各フィールドの値を増減できるスピン機能が搭載されています。このトピックでは、このスピン機能について説明します。

スピン機能を有効にする

スピン機能は、スピンボタン、［↑］キー、［↓］キー、あるいはマウスホイールによる操作が可能です。

スピン機能を有効にするには、コントロールの AllowSpin プロパティを True に設定します。次に、スピンボタンを表示させる場合は SpinButtonVisibility プロパティを ButtonVisibility.ShowAlways（常に表示）あるいは ButtonVisibility.ShowOnFocus（フォーカスを受け取ったときに表示）のいずれかに設定します。スピンボタンはマウスを使って操作できます。

以下のサンプルコードは、日付コントロールのスピン機能を有効にし、フォーカスを受け取ったときにスピンボタンが表示されるように設定します。

Visual Basic
C#
XAML

Imports GrapeCity.Windows.InputMan

GcDateTime1.AllowSpin = True
GcDateTime1.SpinButtonVisibility = ButtonVisibility.ShowOnFocus

using GrapeCity.Windows.InputMan;

GcDateTime1.AllowSpin = true;
GcDateTime1.SpinButtonVisibility = ButtonVisibility.ShowOnFocus;

<im:GcDateTime SpinButtonVisibility="ShowOnFocus" AllowSpin="True" />

スピンモードと増減値の設定

スピン機能による値の増減は、フィールド単位あるいは値全体のいずれかに対して行うことができます。SpinMode プロパティを DateSpinMode.Field に設定すればフィールド単位で、DateSpinMode.Value に設定すれば値全体に対して値の増減が行われます。

SpinMode プロパティ	説明
DateSpinMode.Field	キャレットの位置に存在するフィールドに対して値の増減を行います。増減値は SpinIncrement プロパティで設定します。なお、リテラルフィールド上にキャレットがある場合、スピン機能は無効になります。
DateSpinMode.Value	キャレットの位置に関わらず、値全体に対して値の増減を行います。増減値は SpinIncrementValue プロパティで設定します。

以下のサンプルコードは、値全体に対してスピン機能を有効にし、増減値を30分に設定して、フォーカスを受け取ったときにスピンボタンが表示されるように設定します。

Visual Basic
C#
XAML

Imports GrapeCity.Windows.InputMan

GcDateTime1.AllowSpin = True
GcDateTime1.SpinButtonVisibility = ButtonVisibility.ShowOnFocus
GcDateTime1.SpinMode = DateSpinMode.Value
GcDateTime1.SpinIncrementValue = New TimeSpan(0, 30, 0)

using GrapeCity.Windows.InputMan;

GcDateTime1.AllowSpin = true;
GcDateTime1.SpinButtonVisibility = ButtonVisibility.ShowOnFocus;
GcDateTime1.SpinMode = DateSpinMode.Value;
GcDateTime1.SpinIncrementValue = new TimeSpan(0, 30, 0);

<im:GcDateTime AllowSpin="True" SpinMode="Value" SpinIncrementValue="00:30:00" SpinButtonVisibility="ShowOnFocus" />

値のループ

SpinAllowWrap プロパティを True に設定すると、値が最大値に達した場合は最小値に、最小値に達した場合は最大値に、それぞれ自動的に値を変更します。SpinAllowWrap プロパティのデフォルト値は True です。