RecommendedValue プロパティ (GcDateTime)

入力候補値とコントロールの非表示フィールドのデフォルト値を取得または設定します。

構文

Visual Basic (宣言)
C#

Public Property RecommendedValue As Nullable(Of Date)

public Nullable<DateTime> RecommendedValue {get; set;}

プロパティ値

入力候補値、およびコントロールの非表示フィールドのデフォルト値を示すSystem.DateTime値。

例外

例外	解説
System.ArgumentException	値が有効ではありません。

解説

RecommendedValue プロパティには、値が完全に入力されていないときにユーザーに提示するヒントを設定します。値の入力中に特定のショートカットキーまたはキーの組み合わせを押すと、入力候補値を取得できます。RecommendedValue プロパティで設定した値を有効にするには、ShowRecommendedValue プロパティをTrueに設定する必要があります。ShowRecommendedValue プロパティがFalseの場合には、設定した入力候補値は表示されません。

また、日付時刻コントロールでは、RecommendedValue プロパティはコントロールの非表示フィールドのデフォルト値としても利用されます。デフォルト値として利用する場合、ShowRecommendedValue プロパティをTrueに設定する必要はありません。Value プロパティが設定されている場合には、非表示フィールドにも Value プロパティの値が設定されますが、Value プロパティがnull 参照 (Visual Basic では Nothing)の場合には RecommendedValue プロパティで設定した値が設定されます。RecommendedValue プロパティがnull 参照 (Visual Basic では Nothing)のときは、非表示フィールドのデフォルト値にはクリアメソッドによって値がクリアされた日付、時刻が設定されます。

使用例

入力候補値を設定した GcDateTime コントロールを作成するコード例を次に示します。この例では他に RecommendedValue と ShowRecommendedValue プロパティを使用しています。

C#
Visual Basic

//  Please use the following namespace
//  using System.Windows.Forms;
//  using GrapeCity.Win.Editors;

public void SetRecommendedValueSettings()
{
    // Creates an instance of a GcDateTime control.
    GcDateTime GcDateTime1 = new GcDateTime();
    // Sets the RecommendedValue to 2009/08/31.
    GcDateTime1.RecommendedValue = new DateTime(2009, 8, 31);
    // Sets the ShowRecommendedValue to true, the control will display the RecommendedValue if the value is null.
    GcDateTime1.ShowRecommendedValue = true;
    // Clears the value of the GcDateTime to null.
    GcDateTime1.Clear();
}

'  Please use the following namespace
'  Imports System.Windows.Forms;
'  Imports GrapeCity.Win.Editors;

Public Sub SetRecommendedValueSettings()
    ' Creates an instance of a GcDateTime control.
    Dim GcDateTime1 As New GcDateTime()
    ' Sets the RecommendedValue to 2009/08/31.
    GcDateTime1.RecommendedValue = New DateTime(2009, 8, 31)
    ' Sets the ShowRecommendedValue to true, the control will display the RecommendedValue if the value is null.
    GcDateTime1.ShowRecommendedValue = True
    ' Clears the value of the GcDateTime to null.
    GcDateTime1.Clear()
End Sub

参照

GcDateTime クラス
 GcDateTime メンバ