.NET TIPS

DataGridViewコントロールでオートコンプリート機能を使うには?[2.0のみ、C#、VB]

デジタルアドバンテージ 遠藤 孝信
2006/12/15

 DataGridViewコントロールのテキストボックス列(既定の列)では、セルの編集時や新しい行の追加時に、(セルに埋め込まれた)テキストボックスが使用される。このため、そのテキストボックスに対して、「TIPS:テキストボックスでオートコンプリート機能を使用するには?」で解説しているオートコンプリート機能を有効にすれば、DataGridViveコントロール内でもオートコンプリート機能が利用できるようになる。

 以下の画面は、DataGridViewコントロールのセルの編集時にオートコンプリート機能を使用しているところだ。


セルの編集時にオートコンプリート機能を使用したDataGridViewコントロール

 セルの編集時にオートコンプリート機能を利用するには、セルが編集状態になったときに発生するEditingControlShowingイベントのタイミングで、表示されているテキストボックスのオブジェクトを取得し、それに対してオートコンプリート機能に必要なプロパティを設定すればよい。

 このようなEditingControlShowingイベント・ハンドラのコードは次のようになる。

// DataGridViewのEditingControlShowingイベント・ハンドラ
void dgv_EditingControlShowing(object sender, DataGridViewEditingControlShowingEventArgs e) {

  TextBox tb = e.Control as TextBox;
  if (tb == null) {
    // テキストボックスでなければ何もしない
    return;
  }
  tb.AutoCompleteMode = AutoCompleteMode.SuggestAppend;
  tb.AutoCompleteSource = AutoCompleteSource.AllUrl;
}
' DataGridViewのEditingControlShowingイベント・ハンドラ
Sub dgv_EditingControlShowing(sender As Object, e As DataGridViewEditingControlShowingEventArgs) Handles dgv.EditingControlShowing

  Dim tb As TextBox = TryCast(e.Control, TextBox)
  If tb Is Nothing Then
    ' テキストボックスでなければ何もしない
    Return
  End If
  tb.AutoCompleteMode = AutoCompleteMode.SuggestAppend
  tb.AutoCompleteSource = AutoCompleteSource.AllUrl
End Sub
EditingControlShowingイベント・ハンドラの実装例(上:C#、下:VB)
このコードでは、すべてのテキストボックス列のセルでオートコンプリート機能が働く。AutoCompleteModeプロパティとAutoCompleteSourceプロパティの設定については「TIPS:テキストボックスでオートコンプリート機能を使用するには?」を参照していただきたい。

 このコードでは、DataGridViewEditingControlShowingEventArgsオブジェクトのControlプロパティ(=e.Control)で参照されるオブジェクトが、DataGridViewコントロール内に表示されたテキストボックスとなる(編集しているセルがテキストボックス列のセルである場合)。

 実際には、このテキストボックスはDataGridViewTextBoxEditingControlクラス(System.Windows.Forms名前空間)のインスタンスであるが、これはTextBoxクラス(System.Windows.Forms名前空間)の派生クラスであるため、TextBox型にキャストできる。

 なお上記のコードでは、表示されるすべてのテキストボックスに対してオートコンプリート機能を設定しているため、どの列のセルでもオートコンプリート機能が働いてしまう。特定の列のみでオートコンプリート機能を有効にするには、現在編集中のセルの列をチェックすればよい。これを行っているサンプル・プログラムを次に示す。

 このサンプル・プログラムでは3つのテキストボックス列を使用しているが、2列目に対してのみオートコンプリート機能を有効にしている。上記のDataGridViewコントロールの画面は、このプログラムを実行したときのものだ。

// dgvautocomp.cs

using System;
using System.Drawing;
using System.Windows.Forms;

public class MyForm : Form {

  DataGridView dgv;

  // DataGridViewのEditingControlShowingイベント・ハンドラ
  void dgv_EditingControlShowing(object sender, DataGridViewEditingControlShowingEventArgs e) {

    TextBox tb = e.Control as TextBox;
    if (tb == null) {
      // テキストボックスでなければ何もしない
      return;
    }

    if (dgv.CurrentCell.ColumnIndex == 1) {
      // 2列目の場合にはオートコンプリート
      tb.AutoCompleteMode = AutoCompleteMode.SuggestAppend;
      tb.AutoCompleteSource = AutoCompleteSource.AllUrl;
    } else {
      // 2列目以外ではオートコンプリートをオフ
      tb.AutoCompleteMode = AutoCompleteMode.None;
    }
  }

  // フォームのコンストラクタ
  public MyForm() {
    dgv = new DataGridView();
    dgv.Dock = DockStyle.Fill;
    dgv.ColumnCount = 3;
    dgv.EditingControlShowing +=
      new DataGridViewEditingControlShowingEventHandler(
        dgv_EditingControlShowing);
    this.Controls.Add(dgv);
    this.Size = new Size(480, 240);
  }
}

class Program {
  [STAThread]
  static void Main() {
    Application.Run(new MyForm());
  }
}

// コンパイル方法:csc dgvautocomp.cs
セルでオートコンプリートを行うC#のサンプル・プログラム(dgvautocomp.cs)

' dgvlinenum.vb

Imports System
Imports System.Drawing
Imports System.Windows.Forms

Public Class MyForm
    Inherits Form

  WithEvents dgv As DataGridView

  ' DataGridViewのEditingControlShowingイベント・ハンドラ
  Sub dgv_EditingControlShowing(sender As Object, e As DataGridViewEditingControlShowingEventArgs) Handles dgv.EditingControlShowing

    Dim tb As TextBox = TryCast(e.Control, TextBox)
    If tb Is Nothing Then
      ' テキストボックスでなければ何もしない
      Return
    End If

    If dgv.CurrentCell.ColumnIndex = 1 Then
      ' 2列目の場合にはオートコンプリート
      tb.AutoCompleteMode = AutoCompleteMode.SuggestAppend
      tb.AutoCompleteSource = AutoCompleteSource.AllUrl
    Else
      ' 2列目以外ではオートコンプリートをオフ
      tb.AutoCompleteMode = AutoCompleteMode.None
    End If
  End Sub

  ' フォームのコンストラクタ
  Public Sub New()
    dgv = New DataGridView()
    dgv.Dock = DockStyle.Fill
    dgv.ColumnCount = 3
    Me.Controls.Add(dgv)
    Me.Size = new Size(480, 240)
  End Sub
End Class

' コンパイル方法:vbc /main:MyForm dgvlinenum.vb
セルでオートコンプリートを行うVBのサンプル・プログラム(dgvautocomp.vb)

 このサンプル・プログラムでは、現在のセルが2列目であればオートコンプリート機能を有効にし、それ以外の列であればオートコンプリート機能をオフにしている。

 後者のオフにするという処理は不要に思えるかもしれないが、これを行わないとすべての列でオートコンプリート機能が有効になってしまう。どうやらセルの編集時に毎回テキストボックスが作成されるわけではなく、テキストボックス列全体で単一のテキストボックスのインスタンスが使い回されているようである。End of Article

利用可能バージョン:.NET Framework 2.0のみ
カテゴリ:Windowsフォーム 処理対象:DataGridViewコントロール
使用ライブラリ:DataGridViewコントロール
使用ライブラリ:EncoderParameterクラス(System.Drawing.Imaging名前空間)
使用ライブラリ:TextBoxコントロール(System.Windows.Forms名前空間)
使用ライブラリ:DataGridViewTextBoxEditingControl(System.Windows.Forms名前空間)
関連TIPS:テキストボックスでオートコンプリート機能を使用するには?

この記事と関連性の高い別の.NET TIPS
テキストボックスでオートコンプリート機能を使用するには?
DataGridViewコントロールで特定の値のセルを強調表示するには?
[ASP.NET]DataGridコントロールの同一列内のセルを結合するには?
オートコンプリート機能で独自の補完候補を使用するには?
[ASP.NET]DataGridコントロールのヘッダーを結合するには?
このリストは、(株)デジタルアドバンテージが開発した
自動関連記事探索システム Jigsaw(ジグソー) により自動抽出したものです。
generated by

「.NET TIPS」


Insider.NET フォーラム 新着記事
  • 第2回 簡潔なコーディングのために (2017/7/26)
     ラムダ式で記述できるメンバの増加、throw式、out変数、タプルなど、C# 7には以前よりもコードを簡潔に記述できるような機能が導入されている
  • 第1回 Visual Studio Codeデバッグの基礎知識 (2017/7/21)
     Node.jsプログラムをデバッグしながら、Visual Studio Codeに統合されているデバッグ機能の基本の「キ」をマスターしよう
  • 第1回 明瞭なコーディングのために (2017/7/19)
     C# 7で追加された新機能の中から、「数値リテラル構文の改善」と「ローカル関数」を紹介する。これらは分かりやすいコードを記述するのに使える
  • Presentation Translator (2017/7/18)
     Presentation TranslatorはPowerPoint用のアドイン。プレゼンテーション時の字幕の付加や、多言語での質疑応答、スライドの翻訳を行える
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)
- PR -

注目のテーマ

Insider.NET 記事ランキング

本日 月間
ソリューションFLASH