フィールドオブジェクトによる書式設定(GcNumber型セル)

ここでは、フィールドオブジェクトによる書式設定について説明します。

入力時の書式を設定する入力フィールドには、次の4種類のフィールドが提供されており、これらのフィールドオブジェクトを使って書式を設定することができます。

フィールド（クラス）	説明
NumberSignFieldInfo	接頭語／接尾語のフィールド
NumberIntegerPartFieldInfo	整数入力フィールド
NumberDecimalPartFieldInfo	小数入力フィールド
NumberDecimalSeparatorFieldInfo	小数点フィールド

また、表示フィールドでは、次の7種類のフィールドが提供されています。

フィールド（クラス）	説明
NumberLiteralDisplayFieldInfo	リテラル文字表示フィールド
NumberSignDisplayFieldInfo	接頭語／接尾語の表示フィールド
NumberIntegerPartDisplayFieldInfo	整数表示フィールド
NumberDecimalSeparatorDisplayFieldInfo	小数点フィールド
NumberDecimalPartDisplayFieldInfo	小数表示フィールド
NumberDecimalGeneralFormatDisplayFieldInfo	漢数字の表示フィールド
NumberMoneyPatternDisplayFieldInfo	下の桁をリテラル文字に置き換えるフィールド

フィールドオブジェクトをNumberDisplayFieldCollectionInfoに追加することで数値の表示書式を作成します。また、NumberFieldsInfoクラスに追加されている各入力フィールドを設定することでフィールドのスタイルを変更することができます。

フィールドの追加と削除

数値の入力書式を設定するNumberFieldsコレクションではコレクションのアイテムを追加または削除できません。表示書式は、表示用のNumberDisplayFieldCollectionInfoに、前項で解説したフィールドオブジェクトを組み合わせて作成します。

表示書式を設定するNumberDisplayFieldCollectionInfoにフィールドオブジェクトを追加するにはAddメソッドまたは、AddRangeメソッドを使用します。

サンプルコード

次のサンプルコードは、以下の図のようにGcNumber型セルに表示書式を設定する例です。

表示書式入力書式

C#	コードのコピー
GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType gcNumberCell1 = new GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType(); // フィールドをクリア gcNumberCell1.DisplayFields.Clear(); // 表示フィールドのオブジェクトを作成 GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo numberSignDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("\\", "\\-"); GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberIntegerPartDisplayFieldInfo numberIntegerPartDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberIntegerPartDisplayFieldInfo(); GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalSeparatorDisplayFieldInfo numberDecimalSeparatorDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalSeparatorDisplayFieldInfo(); GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalPartDisplayFieldInfo numberDecimalPartDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalPartDisplayFieldInfo(); GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo numberSignDisplayField2 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("（税込）", "（税込）"); // フィールドをコレクションに追加してセルに表示書式を設定 gcNumberCell1.DisplayFields.AddRange(new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDisplayFieldInfo[] { numberSignDisplayField1, numberIntegerPartDisplayField1, numberDecimalSeparatorDisplayField1, numberDecimalPartDisplayField1, numberSignDisplayField2 }); fpSpread1.ActiveSheet.Cells[0, 0].CellType = gcNumberCell1;

コードのコピー

GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType gcNumberCell1 = new GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType();
// フィールドをクリア
gcNumberCell1.DisplayFields.Clear();
// 表示フィールドのオブジェクトを作成
GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo numberSignDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("\\", "\\-");
GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberIntegerPartDisplayFieldInfo numberIntegerPartDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberIntegerPartDisplayFieldInfo();
GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalSeparatorDisplayFieldInfo numberDecimalSeparatorDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalSeparatorDisplayFieldInfo();
GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalPartDisplayFieldInfo numberDecimalPartDisplayField1 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalPartDisplayFieldInfo();
GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo numberSignDisplayField2 = new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("（税込）", "（税込）");
// フィールドをコレクションに追加してセルに表示書式を設定
gcNumberCell1.DisplayFields.AddRange(new GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDisplayFieldInfo[] { numberSignDisplayField1, numberIntegerPartDisplayField1, numberDecimalSeparatorDisplayField1, numberDecimalPartDisplayField1, numberSignDisplayField2 });
fpSpread1.ActiveSheet.Cells[0, 0].CellType = gcNumberCell1;

Visual Basic	コードのコピー
Dim gcNumberCell1 As New GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType() ' フィールドをクリア gcNumberCell1.DisplayFields.Clear() ' 表示フィールドのオブジェクトを作成 Dim numberSignDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("\", "\-") Dim numberIntegerPartDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberIntegerPartDisplayFieldInfo() Dim numberDecimalSeparatorDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalSeparatorDisplayFieldInfo() Dim numberDecimalPartDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalPartDisplayFieldInfo() Dim numberSignDisplayField2 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("（税込）", "（税込）") ' フィールドをコレクションに追加してセルに表示書式を設定 gcNumberCell1.DisplayFields.AddRange(New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDisplayFieldInfo() {numberSignDisplayField1, numberIntegerPartDisplayField1, numberDecimalSeparatorDisplayField1, numberDecimalPartDisplayField1, numberSignDisplayField2}) FpSpread1.ActiveSheet.Cells(0, 0).CellType = gcNumberCell1

Visual Basic

コードのコピー

Dim gcNumberCell1 As New GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType()
' フィールドをクリア
gcNumberCell1.DisplayFields.Clear()
' 表示フィールドのオブジェクトを作成
Dim numberSignDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("\", "\-")
Dim numberIntegerPartDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberIntegerPartDisplayFieldInfo()
Dim numberDecimalSeparatorDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalSeparatorDisplayFieldInfo()
Dim numberDecimalPartDisplayField1 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDecimalPartDisplayFieldInfo()
Dim numberSignDisplayField2 As New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberSignDisplayFieldInfo("（税込）", "（税込）")
' フィールドをコレクションに追加してセルに表示書式を設定
gcNumberCell1.DisplayFields.AddRange(New GrapeCity.Win.Spread.InputMan.CellType.Fields.NumberDisplayFieldInfo() {numberSignDisplayField1, numberIntegerPartDisplayField1, numberDecimalSeparatorDisplayField1, numberDecimalPartDisplayField1, numberSignDisplayField2})
FpSpread1.ActiveSheet.Cells(0, 0).CellType = gcNumberCell1

フィールドオブジェクトをNumberDisplayFieldCollectionコレクションから削除するには、Removeメソッドまたは、RemoveAtメソッドを使用します。

次のサンプルコードは、NumberDisplayFieldCollectionコレクションの先頭のフィールドを削除する例です。

C#	コードのコピー
// コレクションの先頭のオブジェクトを削除 GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType cell = (fpSpread1.ActiveSheet.GetCellType(0, 0) as GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType); cell.DisplayFields.RemoveAt(0);

コードのコピー

// コレクションの先頭のオブジェクトを削除
GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType cell = (fpSpread1.ActiveSheet.GetCellType(0, 0) as GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType);
cell.DisplayFields.RemoveAt(0);

Visual Basic	コードのコピー
' コレクションの先頭のオブジェクトを削除 Dim cell As GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType = TryCast(FpSpread1.ActiveSheet.GetCellType(0, 0), GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType) cell.DisplayFields.RemoveAt(0)

Visual Basic

コードのコピー

' コレクションの先頭のオブジェクトを削除
Dim cell As GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType = TryCast(FpSpread1.ActiveSheet.GetCellType(0, 0), GrapeCity.Win.Spread.InputMan.CellType.GcNumberCellType)
cell.DisplayFields.RemoveAt(0)

入力フィールドオブジェクト

ここでは、GcNumber型セルの入力フィールドに設定可能な4種類のフィールドについて、すべてのフィールドに共通な設定項目と各フィールドに特化した設定項目にわけて解説します。

すべてのフィールドクラスに共通な設定

これらのプロパティは、GcNumber型セルのすべての入力フィールドオブジェクトに共通な設定項目です。

プロパティ	説明
BackColor プロパティ	フィールド背景色を設定します。
Font プロパティ	フィールドに表示される文字列のフォントを設定します。
ForeColor プロパティ	フィールド背景色を設定します。
Margin プロパティ	フィールド領域の外枠の距離を設定します。セルの境界線からの距離や、他のフィールドとの間隔を設定する際に使用します。
Padding プロパティ	フィールド領域からテキストの表示エリアまでの距離を設定します。

接頭語／接尾語フィールド(NumberSignFieldInfo)

接頭語／接尾語フィールド（NumberSignFieldInfo クラス）は、接頭語／接尾語を入力するフィールドです。

プロパティ	説明
NegativePattern プロパティ	数値が負のときに表示する文字列を設定します。
PositivePattern プロパティ	数値が正のときに表示する文字列を設定します。

整数入力フィールド(NumberIntegerPartFieldInfo)

整数入力フィールド（NumberIntegerPartFieldInfo クラス）は、整数を入力するフィールドです。

プロパティ	説明
GroupSeparator プロパティ	整数部の桁区切り記号として表示する文字を設定します。
GroupSizes プロパティ	整数部の桁区切りを行う桁数を取得または設定します。
MaxDigits プロパティ	整数部の最大桁数を取得または設定します。
MinDigits プロパティ	整数部の最小桁数を取得または設定します。
SpinIncrement プロパティ	スピン動作の変化量を取得または設定します。

小数点フィールド(NumberDecimalSeparatorFieldInfo)

小数点フィールド（NumberDecimalSeparatorFieldInfo クラス）は、小数点を表すフィールドです。

プロパティ	説明
DecimalSeparator プロパティ	小数点に表示する文字を設定します。

小数入力フィールド(NumberDecimalPartFieldInfo)

小数入力フィールド（NumberDecimalPartFieldInfo クラス）は、小数を入力するフィールドです。

プロパティ	説明
MaxDigits プロパティ	小数部の最大桁数を取得または設定します。
MinDigits プロパティ	小数部の最小桁数を取得または設定します。
SpinIncrement プロパティ	スピン動作の変化量を取得または設定します。

表示フィールドオブジェクト

ここでは、GcNumber型セルの表示フィールドに設定可能な7種類のフィールドについて、すべてのフィールドに共通な設定項目と各フィールドに特化した設定項目にわけて解説します。

すべてのフィールドクラスに共通な設定

これらのプロパティは、GcNumber型セルのすべての表示フィールドオブジェクトに共通な設定項目です。

プロパティ	説明
BackColor プロパティ	フィールド背景色を設定します。
Font プロパティ	フィールドに表示される文字列のフォントを設定します。
ForeColor プロパティ	フィールド背景色を設定します。
Margin プロパティ	フィールド領域の外枠の距離を設定します。セルの境界線からの距離や、他のフィールドとの間隔を設定する際に使用します。
Padding プロパティ	フィールド領域からテキストの表示エリアまでの距離を設定します。

リテラル文字表示フィールド(NumberLiteralDisplayFieldInfo)

リテラル文字表示フィールド（NumberLiteralDisplayFieldInfo クラス）は、コントロールに表示するリテラル文字を設定します。

プロパティ	説明
Text プロパティ	リテラル文字列を設定します。

接頭語／接尾語の表示フィールド(NumberSignDisplayFieldInfo)

接頭語／接尾語の表示フィールド（NumberSignDisplayFieldInfo クラス）は、接頭語／接尾語を表示するフィールドです。

プロパティ	説明
NegativePattern プロパティ	数値が負のときに表示する文字列を設定します。
PositivePattern プロパティ	数値が正のときに表示する文字列を設定します。

整数表示フィールド(NumberIntegerPartDisplayFieldInfo)

整数表示フィールド（NumberIntegerPartDisplayFieldInfo クラス）は、整数を表示するフィールドです。

プロパティ	説明
GroupSeparator プロパティ	整数部の桁区切り記号として表示する文字を設定します。
GroupSizes プロパティ	整数部の桁区切りを行う桁数を取得または設定します。
MinDigits プロパティ	整数部の最小桁数を取得または設定します。

小数点フィールド(NumberDecimalSeparatorDisplayFieldInfo)

小数点フィールド（NumberDecimalSeparatorDisplayFieldInfo クラス）は、小数点を表示するフィールドです。

プロパティ	説明
DecimalSeparator プロパティ	小数点に表示する文字を設定します。

小数表示フィールド(NumberDecimalPartDisplayFieldInfo)

小数表示フィールド（NumberDecimalPartDisplayFieldInfo クラス）は、小数を表示するフィールドです。

プロパティ	説明
MaxDigits プロパティ	小数部の最大桁数を取得または設定します。
MinDigits プロパティ	小数部の最小桁数を取得または設定します。

漢数字の表示フィールド(NumberDecimalGeneralFormatDisplayFieldInfo)

漢数字の表示フィールド（NumberDecimalGeneralFormatDisplayFieldInfo クラス）は、漢数字を表示するフィールドです。

プロパティ	説明
Pattern プロパティ	漢数字表記の形式を取得または設定します。

下の桁をリテラル文字に置き換えるフィールド(NumberMoneyPatternDisplayFieldInfo)

下の桁をリテラル文字に置き換えるフィールド（NumberMoneyPatternDisplayFieldInfo クラス）は、下３桁を「千」と置き換えるなど、下の桁をリテラル文字に置き換えるフィールドです。

プロパティ	説明
DecimalSeparator プロパティ	小数点記号を取得または設定します。
GroupSeparator プロパティ	整数部の桁区切り記号として表示する文字を取得または設定します。
Pattern プロパティ	書式文字列を取得または設定します。

システム書式表示フィールド (NumberSystemFormatDisplayFieldInfo)

システム書式表示フィールド（NumberSystemFormatDisplayFieldInfo クラス）は、システムで定義された書式指定子を使用して数字の書式を設定します。

プロパティ	説明
Pattern プロパティ	書式を表す書式指定子を設定します。(String型)下表の書式指定子を設定することができます。

◆ Patternプロパティに設定可能な書式指定子

書式指定子	説明
C	通貨（例：\123.456）
D	Decimal (10 進数型) （例：123456）
G	全般（例：-123.456）
N	Number （例：1,234.56）
P	パーセント（例：100.00 %）