タイムスパンコントロールでは様々な視覚的な補助機能を提供しています。この章ではそれらの機能について解説します。
AlternateText プロパティを使用すれば、コントロールが未入力(Value)のときに代わりに表示するテキストを文字列として設定することができます。
(図) 代替テキストを表示したタイムスパンコントロール
AlternateText プロパティは、TimeSpanAlternateText オブジェクトを参照し、TimeSpanAlternateText クラスのプロパティを使用して以下の代替テキストを設定できます。
プロパティ | 代替テキストの内容 |
---|---|
DisplayNull | コントロールにフォーカスがなく、未入力のときの代替テキスト |
DisplayZero | コントロールにフォーカスがなく、値が0のときの代替テキスト |
Null | コントロールにフォーカスがあり、未入力のときの代替テキスト |
Zero | コントロールにフォーカスがあり、値が0のときの代替テキスト |
これらのプロパティはAlternateText クラスを参照し、次の2つを設定することができます。
次のサンプルコードは、代替テキストを設定する例です。
' フォーカスがないときの代替テキスト GcTimeSpan1.AlternateText.DisplayNull.Text = "日数を入力してください" GcTimeSpan1.AlternateText.DisplayNull.ForeColor = Color.Gray GcTimeSpan1.AlternateText.DisplayZero.Text = "0日は無効です" GcTimeSpan1.AlternateText.DisplayZero.ForeColor = Color.Pink ' フォーカスがあるときの代替テキスト GcTimeSpan1.AlternateText.Null.Text = "実施期間を入力してください" GcTimeSpan1.AlternateText.Null.ForeColor = Color.Red GcTimeSpan1.AlternateText.Zero.Text = "1日以上を入力してください" GcTimeSpan1.AlternateText.Zero.ForeColor = Color.Red
// フォーカスがないときの代替テキスト gcTimeSpan1.AlternateText.DisplayNull.Text = "日数を入力してください"; gcTimeSpan1.AlternateText.DisplayNull.ForeColor = Color.Gray; gcTimeSpan1.AlternateText.DisplayZero.Text = "0日は無効です"; gcTimeSpan1.AlternateText.DisplayZero.ForeColor = Color.Pink; // フォーカスがあるときの代替テキスト gcTimeSpan1.AlternateText.Null.Text = "実施期間を入力してください"; gcTimeSpan1.AlternateText.Null.ForeColor = Color.Red; gcTimeSpan1.AlternateText.Zero.Text = "1日以上を入力してください"; gcTimeSpan1.AlternateText.Zero.ForeColor = Color.Red;
ShowRecommendedValue プロパティを使用すると、タイムスパンコントロールで値が未入力のとき、入力候補となる値をグレー表示することができます。
入力候補として表示されたタイムスパンの値は、表示された候補値のまま適用するか、その一部もしくは全ての値を変更して入力値として適用することができます。
入力候補として表示される値は、RecommendedValue プロパティで設定します。
候補として表示された値を確定するには、ショートカットコンポーネントのショートカットキーとして定義されている[Ctrl]+[Enter]キーを押下します。
ApplyRecommendedValue メソッドを使って入力値として適用することもできます。
(図) 入力候補値を変更せずに値を確定
(図) 入力候補値から値の一部を変更して値を確定
HighlightText プロパティを使用すると、フォーカスを受け取ったときのテキストの選択状態を設定することができます。HighlightText.All の場合は、コントロールのすべてのテキストが選択状態になります。HighlightText.Field の場合は、コントロール内のフィールドの1つを選択状態にすることができます。
HighlightText の値 | キャレットまたはフィールドの状態 |
---|---|
None | キャレットは、DefaultActiveField プロパティで指定したフィールドの最初に位置します。DefaultActiveField プロパティが既定値のときは、キャレットの位置は、SelectionStart プロパティとSelectionLength プロパティの設定で決まります。 |
Field | DefaultActiveField プロパティで指定したフィールドが選択状態になります。DefaultActiveField プロパティが既定値のときは、SelectionStart プロパティで設定された文字以降の最初のフィールドが選択状態になります。SelectionStart以降がすべてリテラル文字の場合は、前のフィールドが選択状態になります。 |
All | DefaultActiveField プロパティの設定に関わらず、コントロール内のすべての内容が選択状態になります。 |
コントロールからフォーカスが移動した後もコントロールのハイライト表示を保持するには、HideSelection プロパティを使用します。
コントロールの一部分のみ選択状態にするには、SelectionStart プロパティとSelectionLength プロパティを組み合わせて使用します。
次のサンプルコードは、コントロールがフォーカスを受け取った時にコントロール内の最初の文字列から3文字を選択する例です。
Private Sub GcTimeSpan1_Enter(ByVal sender As Object, ByVal e As System.EventArgs) Handles GcTimeSpan1.Enter GcTimeSpan1.SelectionStart = 0 GcTimeSpan1.SelectionLength = 3 End Sub
private void gcTimeSpan1_Enter(object sender, EventArgs e) { gcTimeSpan1.SelectionStart = 0; gcTimeSpan1.SelectionLength = 3; }
Enterイベント内でのSelectionStartとSelectionLengthの各プロパティを使ってテキスト選択した場合は、これらのプロパティの設定がHighlightTextプロパティの設定よりも優先されます。 |
PlaceHolderプロパティを使用することで、テキストボックスなどの入力エリア内にラベルを表示できる「フローティングラベル」を設定できます。コントロールが未入力の場合、このラベルはプレースホルダーとして機能します。また、テキスト入力に応じてラベルは縮小され、コントロール内の上部に移動します。
AlternateTextプロパティが設定されている場合には、コントロールが未入力であってもフローティングラベルは上部に表示されます。 |