ValueFormat プロパティ

ヘッダセルのキャプションの生成に使用されるSystem.Stringを取得または設定します。

構文

Visual Basic (宣言)
C#

Public Property ValueFormat As String

public string ValueFormat {get; set;}

プロパティ値

RowHeaderCellのキャプションを表すSystem.String値。既定値はnull 参照 (Visual Basicでは Nothing)です。

例外

例外	解説
System.InvalidOperationException	実行時にこのプロパティが設定されました。

解説

このプロパティは、ヘッダセルのキャプションを特定の書式に基づいて生成する場合に使用します。たとえば、行の1から始まるインデックスをRowHeaderCellに表示したい場合は、このプロパティを"1"に設定します。

有効な書式文字列とその表示結果を次の表に示します。

書式	表示結果
"A"または"a"	連続したアルファベットが大文字または小文字で表示されます（bと指定すると、bから始まり、以下c、d、eと続きます）。
"n"	連続した数字が表示されます（1と指定すると、1から始まり、以下2、3、4と続きます）。
""	キャプションなし。
"A"	指定した静的文字列がキャプションとして表示されます（"A"と指定すると、すべてのキャプションが"A"になります）。
"A and B"	指定した静的および動的文字列がキャプションとして表示されます。"A"と"B"は動的に変更され、"and"はそのまま表示されます（"A and B"と指定すると、"A and B"から始まり、以下"B and C"、"C and D"、"D and E"と続きます）。
"Zz"	文字列が2文字の場合は、指定した書式に従って大文字小文字が決定されます。2文字を超える場合は書式の1文字目が適用されます（"aa"は"Aa"、"aaa"は"AAa"、"aaaa"は"AAAa"と表示されます）。
"zZ"	文字列が2文字の場合は、指定した書式に従って大文字小文字が決定されます。2文字を超える場合は書式の1文字目が適用されます（"aa"は"aA"、"aaa"は"aaA"、"aaaa"は"aaaA"と表示されます）。
"A{n}"	指定した文字で始まる連続したアルファベットが、{n}で指定した数ずつ増えながら表示されます。{n}はステップ数を示します（"A{2}"と指定すると、"A"から始まり、以下"C"、"E"、"G"と続きます）。
"A{-n}"	上記とほぼ同じですが、指定した文字から、{n}で指定した数ずつ減りながら表示される点が異なります。（"B{-1}"と指定すると、"B"から始まり、以下"A"、"-A"、"-B"と続きます）。
"1991{n}"	数字が表示されます。{n}は、直前に指定された数字の増分を示します（"1991{2}"と指定すると、"1991"から始まり、以下"1993"、"1995"、"1997"と続きます）。
"1991{-n}"	数字が表示されます。{-n}は、直前に指定された数字の減分を示します（"1991{-2}"と指定すると、"1991"から始まり、以下"1989"、"1987"、"1985"と続きます）。
"\%"	特殊文字（予約されている文字）を表示するには、前に円記号（\）を付けます（"\%"と指定すると、"%"と表示されます）。
"%%"	キャプションなし（""と同じ）。
"\{"	中カッコ（{）を表示するには、前に円記号（\）を付けます（"\{"と指定すると、"{"と表示されます）。
"\\"	円記号（\）を表示するには、前にもう1つ円記号を付けます（"\\"と指定すると、"\"と表示されます）。

RowHeaderCellのCell.Valueがnull 参照 (Visual Basicでは Nothing)でない場合、このプロパティは無効です。

オーナーGcMultiRowがデータバインディング状態にあり、RowHeaderCellのCell.DataFieldプロパティがString.Emptyでない場合、このプロパティは無効です。

使用例

次のサンプルコードは、RowHeaderCellの持ついくつかの重要なプロパティを示します。このRowHeaderCellの外観は、FlatAppearanceを使用して描画されます。ShowIndicatorがfalseなので、編集アイコンと新規行アイコンは表示されません。Row.ErrorTextは設定されていますが、ShowRowErrorがfalseなので、RowHeaderCellにエラーアイコンは表示されません。このサンプルコードは、RowHeaderCellクラスに示されている詳細なコード例の一部を抜粋したものです。

C#
Visual Basic

private void Form1_Load(object sender, EventArgs e)
{
    Template template1 = Template.CreateGridTemplate(10, 80, 21, Int32.MaxValue, AutoGenerateGridTemplateStyles.RowHeader, 50);
    //Set this property, one error icon glyph will be displayed on the RowHeaderCell, if RowHeaderCell.ShowRowError is false, no icon shown.
    template1.Row.ErrorText = "Row Error";

    RowHeaderCell rowHeaderCell1 = template1.Row.Cells[10] as RowHeaderCell;
    //Click the RowHeaderCell, the current row will be selected.
    rowHeaderCell1.SelectionMode = MultiRowSelectionMode.Row;
    //Set FlatStyle to Flat, and customize some appearances.
    rowHeaderCell1.FlatStyle = FlatStyle.Flat;
    rowHeaderCell1.FlatAppearance.BorderColor = Color.Black;
    rowHeaderCell1.FlatAppearance.BorderSize = 1;
    rowHeaderCell1.FlatAppearance.MouseDownBackColor = Color.Khaki;
    rowHeaderCell1.FlatAppearance.MouseOverBackColor = Color.Orange;

    rowHeaderCell1.Style.BackColor = Color.DarkKhaki;
    rowHeaderCell1.Style.SelectionBackColor = Color.LightBlue;

    //The editing icon and new row icon will not display.
    rowHeaderCell1.ShowIndicator = false;
    //Set ShowRowError to false to hide the row's error icon.
    rowHeaderCell1.ShowRowError = false;
    //Set the RowHeaderCell's caption. it will display "A1, A2, A3, ...".
    rowHeaderCell1.ValueFormat = "A1";

    gcMultiRow1.Template = template1;
    gcMultiRow1.RowCount = 100;
}

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    Dim template1 As Template = Template.CreateGridTemplate(10, 80, 21, Int32.MaxValue, AutoGenerateGridTemplateStyles.RowHeader, 50)
    'Set this property, one error icon glyph will be displayed on the RowHeaderCell, if RowHeaderCell.ShowRowError is false, no icon shown.
    template1.Row.ErrorText = "Row Error"

    Dim rowHeaderCell1 As RowHeaderCell = TryCast(template1.Row.Cells(10), RowHeaderCell)
    'Click the RowHeaderCell, the current row will be selected.
    rowHeaderCell1.SelectionMode = MultiRowSelectionMode.Row
    'Set FlatStyle to Flat, and customize some appearances.
    rowHeaderCell1.FlatStyle = FlatStyle.Flat
    rowHeaderCell1.FlatAppearance.BorderColor = Color.Black
    rowHeaderCell1.FlatAppearance.BorderSize = 1
    rowHeaderCell1.FlatAppearance.MouseDownBackColor = Color.Khaki
    rowHeaderCell1.FlatAppearance.MouseOverBackColor = Color.Orange

    rowHeaderCell1.Style.BackColor = Color.DarkKhaki
    rowHeaderCell1.Style.SelectionBackColor = Color.LightBlue

    'The editing icon and new row icon will not display.
    rowHeaderCell1.ShowIndicator = False
    'Set ShowRowError to false to hide the row's error icon.
    rowHeaderCell1.ShowRowError = False
    'Set the RowHeaderCell's caption. it will display "A1, A2, A3, ...".
    rowHeaderCell1.ValueFormat = "A1"

    gcMultiRow1.Template = template1
    gcMultiRow1.RowCount = 100
End Sub

参照

RowHeaderCell クラス
 RowHeaderCell メンバ