おやじプログラマー日記 : VB.NET:コンボボックスへの項目設定、設定値の取り扱うクラスを作成してみました

標準コントロールのコンボボックス(ComboBox)ですが、このコントロールへの設定値は Items で行います。フォームのデザイナ上でプロパティウインドウの中から設定してもいいのですが、今回は Items に設定する項目をクラスとして定義し、それを指定のコンボボックスに設定するクラスを作成してみました。

Items に設定できるデータ型は Object 型の配列として宣言されていますので、クラスの値の配列を設定が可能です。

以下のソースでは、全体のクラス名を ClsCombo として宣言し、コンボの Items に設定されるデータを ComboItem として宣言しています。
このクラスを使用する場合は、 ComboItem で項目値を配列として宣言し、 ClsCombo のコンストラクタに渡す様にします。

■プロパティ

プロパティ名	内容
`ComboDivision`	選択区分値(数値)を取得
`ComboDivString`	選択区分値(文字列)を取得
`ComboText`	選択区分名(Text)を取得

■メソッド

メソッド名	引数	内容
`SetComboSeletedIndex`	区分値(Long)	区分値を選択状態に設定
`SetComboSeletedIndex`	区分値(文字列)	区分値を選択状態に設定

Public Class ClsCombo ''' <summary>コンボボックスのItemsに設定されるクラス</summary> Public Class ComboItem Public Text As String Public Number As Long Public NumberStr As String 'ComboBoxには、ToString()メソッドの内容が表示される Public Overrides Function ToString() As String Return Text End Function 'コンストラクタ(区分値が数値) Public Sub New(ByVal setText As String, ByVal setNumber As Long) Text = setText Number = setNumber End Sub 'コンストラクタ(区分値が文字列) Public Sub New(ByVal setText As String, ByVal setNumber As String) Text = setText NumberStr = setNumber End Sub End Class 'コンボボックス退避 Private _Combo As ComboBox ''' <summary>コンストラクタ</summary> ''' <param name="Combo">コンボボックス</param> ''' <param name="ComboItems">ComboItemクラスの配列</param> Sub New(ByRef Combo As ComboBox, ByVal ComboItems() As ComboItem) Me._Combo = Combo With _Combo .DropDownStyle = ComboBoxStyle.DropDownList .Items.Clear() .Items.AddRange(ComboItems) .SelectedIndex = -1 .Font = New Font("ＭＳゴシック", 12) End With End Sub ''' <summary>コンボボックスの選択区分値(Number)を取得</summary> Public ReadOnly Property ComboDivision As Long Get '戻り値初期化 ComboDivision = -1 If Me._Combo.SelectedIndex >= 0 Then '項目のNumberを返す ComboDivision = DirectCast(Me._Combo.SelectedItem, ComboItem).Number End If End Get End Property ''' <summary>コンボボックスの選択区分値(String)を取得</summary> Public ReadOnly Property ComboDivString As String Get '戻り値初期化 ComboDivString = "" If Me._Combo.SelectedIndex >= 0 Then '項目のNumberStrを返す ComboDivString = DirectCast(Me._Combo.SelectedItem, ComboItem).NumberStr End If End Get End Property ''' <summary>コンボボックスの選択区分名(Text)を取得</summary> ''' <returns>区分名(Text)</returns> Public ReadOnly Property ComboText As String Get '戻り値初期化 ComboText = "" If Me._Combo.SelectedIndex >= 0 Then '項目のStringを返す ComboText = DirectCast(Me._Combo.SelectedItem, ComboItem).Text End If End Get End Property ''' <summary>指定された区分値を選択状態に設定</summary> ''' <param name="number">区分値(Long)</param> Public Sub SetComboSeletedIndex(ByVal number As Long) With Me._Combo 'コンボに設定済Items分処理する For i As Integer = 0 To .Items.Count - 1 If number = DirectCast(.Items(i), ComboItem).Number Then '指定の値がコンボのNumberと等しい場合、選択済み設定 .SelectedIndex = i Exit For End If Next End With End Sub ''' <summary>指定された区分値を選択状態に設定</summary> ''' <param name="numberStr">区分値(String)</param> Public Sub SetComboSeletedIndex(ByVal numberStr As String) With Me._Combo 'コンボに設定済Items分処理する For i As Integer = 0 To .Items.Count - 1 If numberStr = DirectCast(.Items(i), ComboItem).NumberStr Then '指定の値がコンボのNumberStrと等しい場合、選択済み設定 .SelectedIndex = i Exit For End If Next End With End Sub End Class
このクラスを使う例として以下のソースを示します。
Public Class Form1 'コンボボックス１の為のクラスと設定値 Private Cbo1 As ClsCombo Private Cbo1Items() As ClsCombo.ComboItem = _ {New ClsCombo.ComboItem("0:無効", 0), New ClsCombo.ComboItem("1:有効", 1)} 'コンボボックス２の為のクラスと設定値 Private Cbo2 As ClsCombo Private Cbo2Items() As ClsCombo.ComboItem = _ {New ClsCombo.ComboItem("区分１", "001"), New ClsCombo.ComboItem("区分２", "002"), _ New ClsCombo.ComboItem("区分３", "003")} 'フォームロード時イベント処理 Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load Cbo1 = New ClsCombo(Me.ComboBox1, Cbo1Items) Cbo1.SetComboSeletedIndex(0) Cbo2 = New ClsCombo(Me.ComboBox2, Cbo2Items) Cbo2.SetComboSeletedIndex("002") End Sub 'ボタンクリック時イベント処理 Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click Dim str As String = "" str &= "コンボ1: Division = " & Cbo1.ComboDivision & " , Text = " & Cbo1.ComboText & vbCrLf str &= "コンボ2: Division = " & Cbo2.ComboDivString & " , Text = " & Cbo2.ComboText MsgBox(str, MsgBoxStyle.OkOnly, "コンボテスト") End Sub End Class
プライベート変数で今回のクラスの変数と、コンボに設定する項目値の配列を宣言します。その後、フォームロード時イベントでクラス変数の生成を行い、初期選択値を設定します。