既存のリストボックスの値リストにAddItemメソッドでデータを追加する（Excel VBA）

【本日のミッション】

既存のリストボックスの値リストにAddItemメソッドを使って、新しくデータを追加せよ。

1 ミッションの概要
2 ユーザーフォームにテキストボックス・コマンドボタンを追加する
3 リストボックスに値を追加するコードを、コマンドボタンに設定
4 ユーザーフォームを表示して動作を確認
5 AddItemメソッド
6 RowSourceプロパティで作った値リストには、AddItemメソッドでの追加は不可
7 【参考】

ミッションの概要

AddItemメソッドやListプロパティで作ったリストボックスの値リストに、AddItemメソッドを使って、新に項目を追加せよ、というのが今回のミッションです。

後述していますが、RowSourceプロパティで作った値リストには、AddItemメソッドでの項目追加はできません。

↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓

リストボックスにListプロパティを使って配列に格納したセルデータを値リストとして設定する（Excel VBA)で作成したリストボックスの下に、

追加する項目を入力するテキストボックス
テキストボックスに入力した項目を追加するコマンドボタン

の2つを作り、項目が追加される動作を確認します。

ユーザーフォームにテキストボックス・コマンドボタンを追加する

ユーザーフォームを表示させる

画面左のプロジェクトエクスプローラーから、ユーザーフォームをダブルクリックして表示させます。

ツールボックスを表示させる

ツールボックスを、下記方法で表示させます。

ツールボックスを表示する方法1

[表示]－[ツールボックス]

ツールボックスを表示する方法2

標準ツールバーの［ツールボックス］ボタンをクリックします。

標準ツールバーが表示されていない場合は、［表示］－[ツールバー］－[標準］で表示されます。

ユーザーフォームにテキストボックスを配置する

ツールボックスから「テキストボックス」をクリックします。

リストボックスの下にテキストボックスを作成します。
リストボックスやテキストボックスの位置は、程よく調整します。

左のプロパティウインドウで確認すると、テキストボックスのオブジェクト名が「TextBox1」ということが確認できます。

ユーザーフォームにコマンドボタンを配置する

ツールボックスから「コマンドボタン」をクリックします。

テキストボックスの下にコマンドボタンを作成します。
リストボックス・テキストボックス・コマンドボタンの位置は、程よく調整します。

左のプロパティウインドウで確認すると、コマンドボタンのオブジェクト名が「CommandButton1」ということが確認できます。

この「CommandButton1」というオブジェクト名を「追加」、Captionも「追加」に変更します。Captionを変更することで、ボタンの表示名が「CommandButton1」から「追加」に変更されます。

リストボックスに値を追加するコードを、コマンドボタンに設定

［追加］ボタンをダブルクリックすると、コードウィンドウが表示され、下記コードが追加されています。

「Private Sub 〇〇〇_Click()」に書いた処理は、〇〇〇をクリックした時に行われます。

Private Sub 追加_Click()

End Sub

ここに［追加］ボタンをクリックした時の動作を追加します。

「TextBox1」が空欄でなければ、「ListBox1」の3番目の項目の位置に「TextBox1」のテキストを追加します。

後述していますが、追加する位置をコードでは「2」としているのに、「3番目」に追加されるのは、リストボックスの値リスト一番上の値を「0」として数えているからになります。

Private Sub UserForm_Initialize()
    Dim ary_d               'リストに設定するデータ用配列
    ary_d = Worksheets("サザエさん").Range("A2:A9")
    ListBox1.List = ary_d
End Sub
Private Sub 追加_Click()
    If TextBox1.Text <> "" Then
        ListBox1.AddItem TextBox1.Text, 2
    End If
End Sub

■■■スポンサーリンク■■■

ユーザーフォームを表示して動作を確認

このコード内にカーソルを置いたまま、［F5］キーをクリックすると（ユーザーフォームの実行）ユーザーフォームが表示されます。

配列に入れるデータの参照先にシート名が含まれていないと、アクティブになっているシートのセルデータが使用されるので注意が必要です。シート名を参照先に含めていない場合は、参照データのシートをアクティブにしてからマクロを実行してください。

ary_d = Worksheets("サザエさん").Range("A2:A9")

「配列」参照：セル範囲を一気に変数（配列）に入れる～バリアント型(Variant)変数を配列として使用する～（Excel VBA）

メイン画面が表示されるので、追加したいテキストをテキストボックスに入力します。（今回は「海平」）

［追加］ボタンをクリックすると、値リストの3つ目に「海平」が追加されます。
値リストに「海平」は追加されますが、ワークシートのデータのほうには追加されません。

AddItemメソッド

AddItemメソッドを使用すると、リストボックスに値を追加することができます。

AddItemメソッドを使ってリストボックスの値リストを設定する（Excel VBA)のように、一から値リストを作ることもできますし、今回のように既存の値リストの好きな場所に追加することもできます。

リストボックスオブジェクト.AddItem [Item][Index]

引数名	説明	省略
Item	値リストに追加する文字列を指定します。省略すると空の項目が追加されます。	×
Index	新しい項目を挿入する位置を数字で指定します。値リストの一番上の値を「0」として数えます。省略するとリストの末尾に追加されます。	〇

今回はIndexを「2」としていますが、値リストの2番には挿入されません。

If TextBox1.Text <> "" Then
    ListBox1.AddItem TextBox1.Text, 2
End If

このIndexは値リストの一番上（今回の場合はサザエさん）を「0」として数えます。なのでIndex「2」はフネさんの位置になるので、値リストの上から③番目に「海平」さんが追加されます。

RowSourceプロパティで作った値リストには、AddItemメソッドでの追加は不可

RowSourceプロパティで設定した値リストに、AddItemメソッドで値を追加することはできません。AddItemメソッドを使おうとすると下記エラーが表示されます。

実行時エラー ’70’: 書き込みできません。

AddItemメソッドでデータを追加する場合は、元の値リストはAddItemメソッドか、Listプロパティで作っておく必要があります。

【参考】

■■■スポンサーリンク■■■