書式の設定

日付時刻コントロールの特長的な機能である日付書式の設定と活用について解説します。 概要の説明 日付時刻コントロールの書式は、setFormatPatternメソッドとsetDisplayFormatPatternメソッドを使って設定します。 1.リテラル文字列 日付時刻コントロールには、キーワード以外の文字列をリテラル文字列として表示させることができます。ただし、リテラル文字列のみをsetFormatPatternメソッドまたはsetDisplayFormatPatternメソッドに設定することはできません。 また、キーワードをリテラル文字として表示させるには、キーワードの前に円記号(\、Chr(92))を付けます。円記号を表示させる場合は \ とします。 なお、setShowLiteralsメソッドを使えば、入力中にリテラル文字列を表示するかどうかを指定できます。 2. フィールド 日付時刻コントロールのフィールドには、次の8種類があります。どのフィールドが表示されるかは、書式の定義に依存します。なお、リテラル文字列の領域は、フィールドとは解釈されません。 年号 ('A.D.'を含む) 年 月 日 午前/午後 時 分 秒 3. 時刻の基点 日付時刻コントロールでは、時刻を表示するときの基点をsetHour12ModeメソッドとsetMidnightAs24メソッドで設定することができます。 setHour12ModeメソッドをHour12Mode.Hour12As0に設定すると、表示範囲を 「00:00:00 ~ 11:59:59」 にし、Hour12Mode.Hour0As12にすると、表示範囲を 「01:00:00 ~ 12:59:59」 にします。 また、setMidnightAs24メソッドをtrueに設定すると、真夜中(深夜0時)を「24時」として表示し、falseにすると、真夜中(深夜0時)を「0時」として表示することができます。 入力書式 日付時刻コントロールの入力書式は、setFormatPatternメソッドを使って設定します。setFormatPatternメソッドでは、以下のキーワードが使えます。 日付に関するキーワード キーワード 説明 g 年号の頭文字をアルファベットで表示(M、T、S、H) gg 年号の頭文字を漢字で表示(明、大、昭、平) ggg 年号の正式名称を漢字で表示(明治、大正、昭和、平成) e 和暦年を2桁で表示(先頭に0を付けない) ee 和暦年を2桁で表示(先頭に0を付ける) yy 年を2桁で表示(先頭に0を付ける) yyyy 年を4桁で表示(先頭に0を付ける) MM 月を2桁の数字で表示(先頭に0を付ける) MMM 月を省略形で表示 MMMM 月を正式名称で表示 dd 日を2桁で表示(先頭に0を付ける) \(Chr(92)) キーワードをリテラル文字として表示 元号をキーボードから入力するには、以下のキーを押下します。 元号 明治 大正 昭和 平成 数値入力 1 2 3 4 文字入力 m t s h ※ キーワード'e'または'ee'を使用する場合は、元号を表すキーワード'g'、'gg'、または'ggg'を必ず併用してください。元号の設定を省くと、日付時刻コントロールは年を特定できず、正常に動作できなくなります。 時刻に関するキーワード キーワード 説明 t 12時間制で時刻を表示するときに午前(setAMDesignatorメソッドで設定)または午後(setPMDesignatorメソッドで設定)を表す文字列の最初の1文字を表示 tt 12時間制で時刻を表示するときに午前(setAMDesignatorメソッドで設定)または午後(setPMDesignatorメソッドで設定)を表す文字列を表示 hh 時を12時間制で表示(先頭に0を付ける) HH 時を24時間制で表示(先頭に0を付ける) mm 分を表示(先頭に0を付ける) ss 秒を表示(先頭に0を付ける) \(Chr(92)) キーワードをリテラル文字として表示 午前または午後を表す文字列をキーボードから入力するには、以下のキーを押下します。 区分 午前 午後 数値入力 1 2 文字入力 a p 自由書式入力 setFormatPatternメソッドに空の文字列('')を設定すると、自由書式入力が可能になります。自由書式入力では、日付に変換可能なあらゆる値を受けつけますが、無効な文字が入力されてもonInvalidInputイベントは発生しません。 自由書式入力に設定した場合は、次の各メソッドが無効になります。 setPromptChar setShowLiterals setSpinOnKeys ※ 自由書式入力で日付に変換可能な値は、JavaScriptにおけるDateオブジェクトのparseメソッドが日付と認識する文字列に限られます。 西暦2桁入力 通常、西暦2桁で入力すると、コントロールパネルの設定に従って4桁の西暦に変換されます。日付時刻コントロールでは、次の2つのメソッドを使って、コントロールパネルの設定に影響を与えることなく、独自の変換ルールを設定することが可能です。 setTwoDigitYearMax setUseTwoDigitYearMax setTwoDigitYearMaxメソッドは、Windowsのコントロールパネルの設定に影響を与えないで、西暦2桁入力時の有効期間を設定します。例えば、setTwoDigitYearMaxメソッドに'2029'を設定した場合、2桁の入力数値は、1930年~2029年の間の年を表すものと解釈されます。つまり、年フィールドに'29'が入力された場合は'2029年'、'30'が入力された場合は'1930年'というふうに解釈されます。 setUseTwoDigitYearMaxメソッドは、setTwoDigitYearMaxメソッドで設定した西暦解釈のルールを使用するのか、またはコントロールパネルで設定したルールを使用するのかを指定します。 setTwoDigitYearMaxメソッドは、入力された2桁の数値を4桁の西暦に変換するときのルールを設定するためのもので、入力日付の範囲を制限するものではありません。つまり、setMaxDateとsetMinDateの各メソッドで設定した入力範囲は、setTwoDigitYearMaxメソッドの設定に関わらず、常に有効です。また、setValueメソッドには任意の日付を設定できます。 setTwoDigitYearMaxメソッドの有効な設定値は'199~9999'です。 西暦4桁入力では、setTwoDigitYearMaxメソッドの設定は無視されます。 表示書式 日付時刻コントロールの表示書式は、setDisplayFormatPatternメソッドを使って設定します。キーワードはカスタム書式を設定するときに使用し、書式指定子は既定の書式を呼び出すときに使用します。 プロパティを空の文字列('')に設定すると、setFormatPatternメソッドに設定された入力書式が適用されます。 日付に関するキーワード キーワード 説明 A 紀元後を表す'A.D.(Anno Domini)'を表示 g 年号の頭文字をアルファベットで表示(M、T、S、H) gg 年号の頭文字を漢字で表示(明、大、昭、平) ggg 年号の正式名称を漢字で表示(明治、大正、昭和、平成) e 和暦年を2桁で表示(先頭に0を付けない) ee 和暦年を2桁で表示(先頭に0を付ける) E 和暦年を2桁で表示し開始年を元と表示(先頭に0を付けない)(例:平成元年) EE 和暦年を2桁で表示し開始年を元と表示(先頭に0を付ける)(例:平成元年) y 年を2桁で表示(先頭に0を付けない) yy 年を2桁で表示(先頭に0を付ける) yyy 年を4桁で表示(先頭に0を付けない) yyyy 年を4桁で表示(先頭に0を付ける) M 月を2桁の数字で表示(先頭に0を付けない) MM 月を2桁の数字で表示(先頭に0を付ける) MMM 月を省略形で表示 MMMM 月を正式名称で表示 d 日を表示(先頭に0を付けない) dd 日を表示(先頭に0を付ける) ddd 曜日を省略形で表示 dddd 曜日を正式名称で表示 \(Chr(92)) キーワードをリテラル文字として表示 時刻に関するキーワード キーワード 説明 t 12時間制で時刻を表示するときに午前(setAMDesignatorメソッドで設定)または午後(setPMDesignatorメソッドで設定)を表す文字列の最初の1文字を表示 tt 12時間制で時刻を表示するときに午前(setAMDesignatorメソッドで設定)または午後(setPMDesignatorメソッドで設定)を表す文字列を表示 h 時を12時間制で表示(先頭に0を付けない) hh 時を12時間制で表示(先頭に0を付ける) H 時を24時間制で表示(先頭に0を付けない) HH 時を24時間制で表示(先頭に0を付ける) m 分を表示(先頭に0を付けない) mm 分を表示(先頭に0を付ける) s 秒を表示(先頭に0を付けない) ss 秒を表示(先頭に0を付ける) \(Chr(92)) キーワードをリテラル文字として表示 書式指定子 書式指定子 説明 d 短い形式の日付(例:2015/3/01) D 長い形式の日付(例:2015年3月1日) t 短い形式の時刻(例:10:30) T 長い形式の時刻(例:10:30:00) f 長い形式の日付と短い形式の時刻(例:2015年3月1日 10:30) F 長い形式の日付と長い形式の時刻(例:2015年3月1日10:30:00) g 短い形式の日付と短い形式の時刻(例:2015/3/01 10:30) G 短い形式の日付と長い形式の時刻(例:2015/3/01 10:30:00) Mまたはm 月日の表示(例:3月1日) Rまたはr RFC1123の形式(例:Fri, 01 Mar 2015 10:30:00 GMT) S ISO 8601準拠の形式(例:2015-03-01T10:30:00) u ユニバーサル形式(例:2015-03-01 10:30:00Z) U 世界協定時刻(例:2015年3月1日1:30:00) Yまたはy 年月の表示(例:2015年3月) 書式指定子による書式は、コントロールパネルの[地域のオプション]の設定やスレッドに関連付けられているカルチャによって異なります。カルチャに依存しない書式を設定するには、上記のキーワードを使ってカスタム書式を作成します。 書式指定子の中には、キーワードとしても定義されている文字があります。これらを1文字だけ設定すると、書式指定子と解釈されます。キーワードとして認識させる場合は、エスケープ文字である「\(Chr(92))」をその文字の前に配置します。 サンプルコード 次のサンプルコードは、setFormatPatternメソッドとsetDisplayFormatPatternメソッドを使って日付と時刻を入力するための書式を設定する方法を示します。
import '@grapecity/inputman/CSS/gc.inputman-js.css'; import './styles.css'; import { InputMan } from '@grapecity/inputman'; const gcDateTime = new InputMan.GcDateTime(document.getElementById('gcDateTime')); const displayFormatPattern = new InputMan.GcComboBox(document.getElementById('displayFormatPattern'), { items: [ { value: 'yyy/M/d H:m:s', desc: '日付と時刻(2018/1/1 13:30:1)' }, { value: 'yyy年M月d日 H時m分s秒', desc: '日付と時刻(2018年1月1日 13時30分1秒)' }, { value: 'y/M/d', desc: '日付(18/1/1)' }, { value: 'y年M月d日(ddd)', desc: '日付(18年1月1日(木))' }, { value: 'gggE年M月d日 dddd', desc: '日付(平成元年12月1日 金曜日)' }, { value: 'gg e年M月d日', desc: '日付(平 1年12月1日)' }, { value: 'g. e/M/d', desc: '日付(H. 1/12/1)' }, { value: 'H:m:s', desc: '時刻(13:30:1)' }, { value: 'tt h時m分s秒', desc: '時刻(午後 1時30分1秒)' }, ], displayMemberPath: 'value', valueMemberPath: 'value', dropDownWidth: 'auto', columns: [ { name: 'value', label: '書式', width: 200 }, { name: 'desc', label: '説明', width: 320 }, ] }); displayFormatPattern.addEventListener(InputMan.GcComboBoxEvent.SelectedChanged, (control, args) => { if (displayFormatPattern.getSelectedValue()) { gcDateTime.setDisplayFormatPattern(displayFormatPattern.getSelectedValue()); } }); displayFormatPattern.addEventListener(InputMan.GcComboBoxEvent.TextChanged, (control, args) => { gcDateTime.setDisplayFormatPattern(displayFormatPattern.getDisplayText()); }); const formatPattern = new InputMan.GcComboBox(document.getElementById('formatPattern'), { items: [ { value: 'yyyy/MM/dd HH:mm:ss', desc: '日付と時刻(2018/01/01 13:30:01)' }, { value: 'yyyy年MM月dd日 HH時mm分ss秒', desc: '日付と時刻(2018年01月01日 13時30分01秒)' }, { value: 'yyyy/MM/dd', desc: '日付(2018/01/01)' }, { value: 'yy年MM月dd日', desc: '日付(18年01月01日)' }, { value: 'gggee年MM月dd日 HH時mm分ss秒', desc: '日付と時刻(平成01年12月01日 13時30分01秒)' }, { value: 'gg ee年MM月dd日', desc: '日付(平 01年12月01日)' }, { value: 'g. ee/MM/dd', desc: '日付(H. 01/12/01)' }, { value: 'HH:mm:ss', desc: '時刻(13:30:01)' }, { value: 'tt hh時mm分ss秒', desc: '時刻(午後 01時30分01秒)' }, ], displayMemberPath: 'value', valueMemberPath: 'value', dropDownWidth: 'auto', columns: [ { name: 'value', label: '書式', width: 260 }, { name: 'desc', label: '説明', width: 360 }, ] }); formatPattern.addEventListener(InputMan.GcComboBoxEvent.SelectedChanged, (control, args) => { if (formatPattern.getSelectedValue()) { gcDateTime.setFormatPattern(formatPattern.getSelectedValue()); } }); formatPattern.addEventListener(InputMan.GcComboBoxEvent.TextChanged, (control, args) => { gcDateTime.setFormatPattern(formatPattern.getDisplayText()); });
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>日付時刻コントロール - 書式の設定</title> <!-- SystemJS --> <script src="node_modules/systemjs/dist/system.src.js"></script> <script src="systemjs.config.js"></script> <script> System.import('./src/app'); </script> </head> <body> <input id="gcDateTime" style="width: 300px;"> <table class="sample"> <tr> <th>表示書式</th> <td> <select id="displayFormatPattern"></select> </td> </tr> <tr> <th>入力書式</th> <td> <select id="formatPattern"></select> </td> </tr> </table> </body> </html>
body { padding-bottom: 12rem; } .combobox-input.gcim-layout { width: 250px; }
System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true }, meta: { '*.css': { loader: 'css' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { '@grapecity/inputman': 'npm:@grapecity/inputman/index.js', '@grapecity/inputman/CSS': 'npm:@grapecity/inputman/CSS', 'css': 'npm:systemjs-plugin-css/css.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel/systemjs-babel-browser.js' }, // packages tells the System loader how to load when no filename and/or no extension packages: { src: { defaultExtension: 'js' }, "node_modules": { defaultExtension: 'js' }, } });