DataGridViewComboBoxColumn.DisplayMember プロパティ

.NET Framework クラス ライブラリ リファレンス

DataGridViewComboBoxColumn.DisplayMember プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

コンボ ボックスに表示する文字列の取得先となるプロパティまたは列を指定する文字列を取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Property DisplayMember As
 String

Visual Basic (使用法)

Dim instance As DataGridViewComboBoxColumn
Dim value As String

value = instance.DisplayMember

instance.DisplayMember = value

C#

public string DisplayMember { get;
 set; }

C++

public:
property String^ DisplayMember {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_DisplayMember ()

/** @property */
public void set_DisplayMember (String value)

JScript

public function get DisplayMember
 () : String

public function set DisplayMember
 (value : String)

プロパティ値
DataSource プロパティで指定されたデータ ソース内のプロパティまたは列の名前を指定する String。既定値は String.Empty です。

例外

例外の種類	条件
InvalidOperationException	CellTemplate プロパティの値が null 参照 (Visual Basic では Nothing) です。

解説

DataGridViewComboBoxCell オブジェクトの列に格納される値のデータは、DataGridView.DataSource から取得されます。このデータを既定でないプロパティまたは列から取得する場合は、DisplayMember プロパティをそのプロパティまたは列の名前に設定する必要があります。

セル値がユーザーに公開されない内部値である場合は、DisplayMember と ValueMember を使用して、その内部値をユーザーに表示できる値に対応付けます。

DataSource プロパティに文字列配列を設定する場合は、有効な表示文字列および有効な基になる値として配列内の各文字列が使用されるため、DisplayMember プロパティを設定する必要はありません。

このプロパティを取得または設定すると、CellTemplate プロパティによって返されるオブジェクトの DisplayMember プロパティを取得または設定できます。このプロパティを設定すると、列に含まれるすべてのセルの DisplayMember プロパティも設定され、列の表示が更新されます。各セルの指定した値をオーバーライドするには、列の値を設定してからセルの値を設定します。

使用例

DataGridViewComboBoxColumn を使用して、タイトル列のデータ入力を円滑化する方法を示すコード例を次に示します。DisplayMember には、ユーザーに表示できるテキストの取得先となるプロパティの名前が設定されます。この例では、マップが不要なため、DisplayMember は ValueMember と同じ値に設定されます。

Visual Basic

Private Function CreateComboBoxColumn() _
    As DataGridViewComboBoxColumn
    Dim column As New DataGridViewComboBoxColumn()

    With column
        .DataPropertyName = ColumnName.TitleOfCourtesy.ToString()
        .HeaderText = ColumnName.TitleOfCourtesy.ToString()
        .DropDownWidth = 160
        .Width = 90
        .MaxDropDownItems = 3
        .FlatStyle = FlatStyle.Flat
    End With
    Return column
End Function

Private Sub SetAlternateChoicesUsingDataSource(
 _
    ByRef comboboxColumn As DataGridViewComboBoxColumn)
    With comboboxColumn
        .DataSource = RetrieveAlternativeTitles()
        .ValueMember = ColumnName.TitleOfCourtesy.ToString()
        .DisplayMember = .ValueMember
    End With
End Sub

Private Function RetrieveAlternativeTitles()
 As DataTable
    Return Populate( _
        "SELECT distinct TitleOfCourtesy FROM Employees")
End Function

Private connectionString As String
 = _
        "Integrated Security=SSPI;Persist Security Info=False;"
 _
        & "Initial Catalog=Northwind;Data Source=localhost"

Private Function Populate(ByVal
 sqlCommand As String) As
 DataTable
    Dim northwindConnection As New
 SqlConnection(connectionString)
    northwindConnection.Open()

    Dim command As New SqlCommand(sqlCommand,
 _
        northwindConnection)
    Dim adapter As New SqlDataAdapter()
    adapter.SelectCommand = command
    Dim table As New DataTable()
    table.Locale = System.Globalization.CultureInfo.InvariantCulture
    adapter.Fill(table)

    Return table
End Function

C#

private DataGridViewComboBoxColumn CreateComboBoxColumn()
{
    DataGridViewComboBoxColumn column =
        new DataGridViewComboBoxColumn();
    {
        column.DataPropertyName = ColumnName.TitleOfCourtesy.ToString();
        column.HeaderText = ColumnName.TitleOfCourtesy.ToString();
        column.DropDownWidth = 160;
        column.Width = 90;
        column.MaxDropDownItems = 3;
        column.FlatStyle = FlatStyle.Flat;
    }
    return column;
}

private void SetAlternateChoicesUsingDataSource(ref
 DataGridViewComboBoxColumn comboboxColumn)
{
    {
        comboboxColumn.DataSource = RetrieveAlternativeTitles();
        comboboxColumn.ValueMember = ColumnName.TitleOfCourtesy.ToString();
        comboboxColumn.DisplayMember = comboboxColumn.ValueMember;
    }
}

private DataTable RetrieveAlternativeTitles()
{
    return Populate("SELECT distinct TitleOfCourtesy FROM
 Employees");
}

string connectionString =
    "Integrated Security=SSPI;Persist Security Info=False;" +
    "Initial Catalog=Northwind;Data Source=localhost";

private DataTable Populate(string sqlCommand)
{
    SqlConnection northwindConnection = new SqlConnection(connectionString);
    northwindConnection.Open();

    SqlCommand command = new SqlCommand(sqlCommand, northwindConnection);
    SqlDataAdapter adapter = new SqlDataAdapter();
    adapter.SelectCommand = command;

    DataTable table = new DataTable();
    table.Locale = System.Globalization.CultureInfo.InvariantCulture;
    adapter.Fill(table);

    return table;
}

C++

private:
    DataGridViewComboBoxColumn^ CreateComboBoxColumn()
    {
        DataGridViewComboBoxColumn^ column =
            gcnew DataGridViewComboBoxColumn();
        {
            column->DataPropertyName = ColumnName::TitleOfCourtesy.ToString();
            column->HeaderText = ColumnName::TitleOfCourtesy.ToString();
            column->DropDownWidth = 160;
            column->Width = 90;
            column->MaxDropDownItems = 3;
            column->FlatStyle = FlatStyle::Flat;
        }
        return column;
    }

private:
    void SetAlternateChoicesUsingDataSource(DataGridViewComboBoxColumn^%
 comboboxColumn)
    {
        {
            comboboxColumn->DataSource = RetrieveAlternativeTitles();
            comboboxColumn->ValueMember = ColumnName::TitleOfCourtesy.ToString();
            comboboxColumn->DisplayMember = comboboxColumn->ValueMember;
        }
    }

private:
    DataTable^ RetrieveAlternativeTitles()
    {
        return Populate("SELECT distinct TitleOfCourtesy FROM
 Employees");
    }

    String^ connectionString;

private:
    DataTable^ Populate(String^ sqlCommand)
    {
        SqlConnection^ northwindConnection = gcnew SqlConnection(connectionString);
        northwindConnection->Open();

        SqlCommand^ command = gcnew SqlCommand(sqlCommand, northwindConnection);
        SqlDataAdapter^ adapter = gcnew SqlDataAdapter();
        adapter->SelectCommand = command;

        DataTable^ table = gcnew DataTable();
        adapter->Fill(table);

        return table;
    }

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataGridViewComboBoxColumn クラス
DataGridViewComboBoxColumn メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataGridView.DataSource プロパティ
DataGridViewComboBoxColumn.DataSource プロパティ
ValueMember
DataGridViewComboBoxColumn.CellTemplate プロパティ
DataGridViewComboBoxCell クラス
DataGridViewComboBoxCell.DisplayMember プロパティ