DataGridViewComboBoxCell.DisplayMember プロパティ

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

DataGridViewComboBoxCell.DisplayMember プロパティ

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

ドロップダウン リストに表示する選択項目の収集先を指定する文字列を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Property
 DisplayMember As String

Visual Basic (使用法)

Dim instance As DataGridViewComboBoxCell
Dim value As String

value = instance.DisplayMember

instance.DisplayMember = value

C#

public virtual string DisplayMember { get;
 set; }

C++

public:
virtual 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.Empty で、DisplayMember プロパティが使用されないことを示します。

例外

例外の種類	条件
ArgumentException	DataSource プロパティが null 参照 (Visual Basic では Nothing) ではなく、このプロパティの設定時に指定された値が null 参照 (Visual Basic では Nothing) または String.Empty ではなく、データ ソース内の有効なプロパティまたは列の名前でもありません。

解説

DisplayMember は、コンボ ボックスのドロップダウン リストに表示されるテキスト情報を表します。一方、ValueMember プロパティは、選択項目に対応する値を表します。

DataGridViewComboBoxCell に表示される選択項目のデータが、DataSource の既定でないプロパティまたは列から取得されることが想定される場合は、DataSource の他に DisplayMember も設定する必要があります。

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

コンボ ボックスの選択項目を読み込むためのもう 1 つの方法は、Items プロパティを使用することです。DisplayMember には、選択項目の収集先となるプロパティの名前を格納する必要があります。

使用例

このプロパティに類似している DataGridViewComboBoxColumn.DisplayMember プロパティの使用方法を次のコード例に示します。

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

参照

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