Format プロパティ (GcTime)

入力用の時刻書式を示すTimeFormatオブジェクトを取得または設定します。

構文

Visual Basic (宣言)
C#

Public Shadows Property Format As TimeFormat

public new TimeFormat Format {get; set;}

プロパティ値

既定値：GrapeCity.Web.Input.IMDate.TimeFormat("HH:mm:ss")

例外

例外	解説
System.ArgumentException	無効な時刻書式が設定されています。

解説

時刻コントロールの入力書式は、Formatプロパティが参照するTimeFormatオブジェクトを使って設定します。このオブジェクトのTimeFormat.Patternプロパティにキーワードとリテラル文字列を設定することで、入力書式を作成します。

TimeFormat.Patternプロパティを空の文字列（""またはString.Empty）に設定すると、自由書式入力が可能になります。

TimeFormat.Patternプロパティでは、以下のキーワードが使えます。

時刻に関するキーワード

キーワード	説明
t	12時間制で時刻を表示するときに午前（AMDesignatorプロパティで設定）または午後（PMDesignatorプロパティで設定）を表す文字列の最初の１文字を表示
tt	12時間制で時刻を表示するときに午前（AMDesignatorプロパティで設定）または午後（PMDesignatorプロパティで設定）を表す文字列を表示
hh	時を12時間制で表示（先頭に0を付ける）
HH	時を24時間制で表示（先頭に0を付ける）
mm	分を表示（先頭に0を付ける）
ss	秒を表示（先頭に0を付ける）
\(Chr(92))	キーワードをリテラル文字として表示

午前または午後を表す文字列をキーボードから入力するには、以下のキーを押下します。

区分	午前	午後
数値入力	1	2
文字入力	a	p

旧式のプロパティ

TimeFormatオブジェクトのNullプロパティは、8.0J以降で旧式（obsolate）のメンバとなりました。これらのプロパティと同等の機能を実現するには、Watermarkプロパティを使用して、未入力時の表示文字を設定します。

自由書式入力

TimeFormatオブジェクトのPatternプロパティに空の文字列（""またはString.Empty）を設定すると、自由書式入力が可能になります。文字列を時刻に変換できなかった場合は、コントロールがフォーカスを失ったときにInvalidValueイベントが発生します。

自由書式入力に設定した場合は、次の各プロパティが無効になります。

CurrentField
PromptChar
ShowLiterals
Spin

使用例

最初のサンプルコードは、FormatプロパティとDisplayFormatプロパティを使って時刻の書式を設定する方法を示します。

下のサンプルコードは、同様の設定をTimeFormatオブジェクトとTimeDisplayFormatオブジェクトを明示的に生成することで行います。

Visual Basic
C#

' 時刻の書式を設定します。
GcTime1.AMDesignator = "午前"
GcTime1.PMDesignator = "午後"
GcTime1.Format.Pattern = "tt hh時 mm分"
GcTime1.DisplayFormat.Pattern = "tt hh時 mm分"

// 時刻の書式を設定します。
GcTime1.AMDesignator = "午前";
GcTime1.PMDesignator = "午後";
GcTime1.Format.Pattern = "tt hh時 mm分";
GcTime1.DisplayFormat.Pattern = "tt hh時 mm分";

Visual Basic
C#

Imports GrapeCity.Web.Input.IMDate

' 時刻の書式を設定します。
GcTime1.AMDesignator = "午前"
GcTime1.PMDesignator = "午後"
GcTime1.Format = New TimeFormat("tt hh時 mm分")
GcTime1.DisplayFormat = New TimeDisplayFormat("tt hh時 mm分")

using GrapeCity.Web.Input.IMDate;

// 時刻の書式を設定します。
GcTime1.AMDesignator = "午前";
GcTime1.PMDesignator = "午後";
GcTime1.Format = new TimeFormat("tt hh時 mm分");
GcTime1.DisplayFormat = new TimeDisplayFormat("tt hh時 mm分");

参照

GcTime クラス
 GcTime メンバ
 TimeFormat クラス
 DisplayFormat プロパティ
 AMDesignator プロパティ
 PMDesignator プロパティ