VBAクラスモジュールの使い方|PropertyとCollectionの実例

  • クラスモジュールを作ったものの、標準モジュールとの違いが分からない
  • Property と Set をどう使うか迷う

注文1件のデータと処理を一緒に扱う例で、クラスモジュールの基本を説明します。コードはExcel上で未実行なので、実データに使う前にコピーしたブックで確認してください。

VBA全体の学習順を確認したい場合は、Excel VBA入門ガイドから読めます。

全体像:どの方法を使うか

クラスを使うかどうかは、値を1件ずつまとめて扱いたいかで決めます。処理の入口とデータの単位を分けて考えると、コードの置き場所が決まります。

目的から選ぶ

  • 1つのマクロを順に実行する:標準モジュールのSubを使う
  • 注文番号・品名・数量を1件として扱う:クラスモジュールを使う
  • 複数件を順に処理する:COrderを複数作り、Collectionに格納する

クラスモジュールを作る

標準モジュールとの使い分け

標準モジュールには実行の入口となるSubを置きます。クラスモジュールには、注文1件の値と、その注文に対する処理をまとめます。

VBEの[挿入]→[クラス モジュール]で追加し、プロパティウィンドウの(オブジェクト名)を COrder に変更します。以下は COrder 側のコードです。

VB
Option Explicit

Private mItem As String
Private mQuantity As Long

Private Sub Class_Initialize()
    mQuantity = 1
End Sub

Public Property Get ItemName() As String
    ItemName = mItem
End Property

Public Property Let ItemName(ByVal value As String)
    mItem = value
End Property

Public Property Get Quantity() As Long
    Quantity = mQuantity
End Property

Public Property Let Quantity(ByVal value As Long)
    If value < 1 Then Err.Raise 5, "COrder", "数量は1以上にしてください"
    mQuantity = value
End Property

Public Function Label() As String
    Label = mItem & " × " & CStr(mQuantity)
End Function

Private Sub Class_Terminate()
    ' 後片付けが必要な場合だけ記述する
End Sub

Get・Let・メソッドの役割

Getは値の読み取り、Letは文字列や数値の書き込みを担当します。オブジェクトを代入するプロパティにはSetを使います。Labelはクラスのメソッドです。

Class_Initializeはインスタンス作成時、Class_Terminateは参照が解放されるときのイベントです。Terminateの実行時刻を業務処理の条件にはしないでください。

NewとSetで作り、Collectionに入れる

注文を2件作る例

次のコードは標準モジュールに置きます。Sheet1のA列に品名、B列に数量を2行分書きます。既存のA1:B2は上書きされます。

VB
Option Explicit

Public Sub WriteOrders()
    Dim orders As Collection
    Dim order As COrder
    Dim rowNo As Long

    Set orders = New Collection
    Set order = New COrder
    order.ItemName = "ノート"
    order.Quantity = 2
    orders.Add order

    Set order = New COrder
    order.ItemName = "ペン"
    order.Quantity = 3
    orders.Add order

    For rowNo = 1 To orders.Count
        Sheet1.Cells(rowNo, 1).Value = orders(rowNo).ItemName
        Sheet1.Cells(rowNo, 2).Value = orders(rowNo).Quantity
    Next rowNo
End Sub

Newで別の注文を作るたびにSetで参照を代入します。Collectionには注文オブジェクトへの参照が入るため、ループで各注文を取り出せます。

実行時エラー91の確認点

オブジェクト変数がNothingのままプロパティを読むと、実行時エラー91になります。Set order = New COrder の実行前に order.ItemName を読んでいないか確認します。

実務例:注文一覧をクラスへ読み込む

入力表と処理の流れ

先ほどの例は2件をコード内で作りました。実際の一覧では、Sheet1のA列を品名、B列を数量として読み込み、行ごとにCOrderを作る方が入力を変えやすくなります。

最初に最終行を求め、2行目から順に値を読みます。各行で新しいCOrderを作り、値を設定した後でCollectionへ追加します。

空欄の品名は登録しません。数量が1未満なら、クラスのProperty Letでエラーになります。ここでは処理前に数値かどうかを確認し、どの行が問題か分かるようにしています。

一覧から特定の注文を探す段階では、Find・FindNextでセルを検索する方法を使えます。

一覧からラベルを作る通しサンプル

Sheet2のA列へラベルを書き出します。Sheet2のA列に既存データがある場合は消えるので、コピーしたブックで試してください。

VB
Option Explicit

Public Sub BuildOrderLabels()
    Dim orders As Collection
    Dim order As COrder
    Dim rowNo As Long
    Dim outputRow As Long
    Dim lastRow As Long
    Dim quantityValue As Variant
    Set orders = New Collection
    lastRow = Sheet1.Cells(Sheet1.Rows.Count, 1).End(xlUp).Row
    For rowNo = 2 To lastRow
        If Len(Trim(CStr(Sheet1.Cells(rowNo, 1).Value))) > 0 Then
            quantityValue = Sheet1.Cells(rowNo, 2).Value
            If Not IsNumeric(quantityValue) Then
                MsgBox "数量が数値ではありません: " & rowNo & "行目"
                Exit Sub
            End If
            Set order = New COrder
            order.ItemName = CStr(Sheet1.Cells(rowNo, 1).Value)
            order.Quantity = CLng(quantityValue)
            orders.Add order
        End If
    Next rowNo
    Sheet2.Columns(1).ClearContents
    outputRow = 1
    For Each order In orders
        Sheet2.Cells(outputRow, 1).Value = order.Label
        outputRow = outputRow + 1
    Next order
End Sub

COrderの定義は前の節で追加したものを使います。入力値を読み取る役割は標準モジュール、1件の注文を表す役割はクラスモジュールに分かれています。

この例は入力チェックの途中で止まると出力列を消しません。ただしQuantityに小数やLongの範囲外の値を渡す場合などは、変換時のエラーが残るため、入力仕様を決めてから使ってください。

Collectionの要素と参照の関係

Collectionへ追加した後に同じ変数orderへNewで別オブジェクトを入れても、先に追加した注文はCollectionに残ります。変数が別の参照を指すだけで、先の注文を上書きしているわけではありません。

一方、Newをせずに同じorderのItemNameだけ変えて何度もAddすると、同じオブジェクトへの参照を複数回入れる形になります。1行ごとにSet order = New COrderを実行する点が重要です。

キーで注文を引きたい場合はCollectionのキーやDictionaryも候補ですが、重複キーの扱いを先に決めます。単に読み込み順を保って繰り返すならCollectionで足ります。

標準モジュール・クラス・配列の比較

置き場所・型主な役割この例で置くもの
標準モジュール処理を始め、シートとやり取りするWriteOrders、BuildOrderLabels
クラスモジュール注文1件の値と、その値に関する処理を持つCOrderのPropertyとLabel
Collection作成した注文を順番に保持するorders.Add order
配列値をまとまった範囲で読み書きする大量行を扱う場合の候補
注文一覧の例での役割分担

コードの行数だけを見るとクラスを使う方が長くなります。1回だけ2列をコピーする処理なら標準モジュールで十分ですが、同じ注文データに複数の処理を加える予定なら、値の条件をCOrderに集める意味があります。

たとえば金額や納期を追加する場合、単なる列番号だけで処理を広げると、どの値がどの注文に属するのか追いづらくなります。COrderにプロパティを追加し、その注文の値として扱えば、処理側には注文の単位が残ります。

反対に、クラスへSheet1への書き込みまで入れると、注文の値を別シートや別ブックで使いたいときに結び付きが強くなります。COrderは値とその値に関係する処理、シートの読み書きは標準モジュールという分担を保ちます。

入力列が増えたときは、最初に一覧の列とプロパティの対応表を作ってください。列を追加しただけでSubの参照先を直し忘れると、型が合っていても違う値を注文へ入れてしまいます。

また、Collectionへ追加する前に必要な値をすべて設定します。途中でエラーが起きた未完成の注文を一覧へ入れないように、品名、数量の確認が終わってからAddする流れにします。

よくあるエラーと対処

実行時エラー91:Set前に使っている

「オブジェクト変数またはWithブロック変数が設定されていません」は、Nothingを指している変数のメンバーを使うと起きます。Newでインスタンスを作ったか、Setで参照を代入したかを順に確認します。

関数からCOrderを返す場合にも、呼び出し側でSetを使います。数値や文字列の代入と違い、オブジェクト参照の代入にはSetが必要です。

クラス名が見つからない

Dim order As COrderでコンパイルエラーが出る場合は、クラスモジュールの(オブジェクト名)がCOrderか確認します。記事のコードを標準モジュールへ全部貼っただけでは、COrderという型は作られません。

クラスのコードと実行用のSubを別々のモジュールに貼り、VBEの[デバッグ]→[VBAProjectのコンパイル]で構文を確認します。表示名やファイル名ではなく、プロパティウィンドウの名前を見ます。

Property Letで値を拒否された

数量に0以下を設定すると例のProperty Letが明示的にエラーを出します。エラーを握りつぶすより、入力行と値を確認して修正する方が安全です。

Initializeで数量の初期値を1にしても、後から不正値を代入できては意味がありません。初期化と入力時の検証を両方置くことで、COrderが持つ値の条件を保ちます。

値が意図せず共有される

複数行を読み込んだのにすべて同じ品名に見える場合は、ループ内で新しいCOrderを作っているかを見ます。同じインスタンスを何度もCollectionへ追加すると、どの要素から見ても最後に変更した値になります。

この問題はSetの書き忘れとは逆で、参照はあるものの各行に別の参照を用意していない状態です。デバッグ時にはCollectionへ追加する直前にorder.ItemNameを見て、次の行でNewが通っているかを追います。

よくある質問

クラスを使わず配列だけでもよいですか?

値を順に読むだけなら配列でも十分です。品名と数量の関係を保ち、入力チェックやラベル生成を1件の処理にまとめたい場合にクラスが役立ちます。

Property Getだけでは値を変更できませんか?

Getは読み取り用です。外から値を設定したいときはLetを用意します。外部から変更させたくない値ならGetだけにする設計もできます。

Property Setを使うのはいつですか?

別のクラスやRangeなど、オブジェクトをプロパティへ代入するときです。文字列やLongのような値にはLetを使います。代入する側でもSetが必要です。

Class_Terminateで保存処理をしてもよいですか?

参照が残ると解放の時刻が読みづらくなります。保存が必要なら、明示的なSaveメソッドを呼ぶ構成を先に検討します。Terminateには必要な後片付けだけを置きます。

NewとSetのどちらが必要ですか?

Newは新しいインスタンスを作り、Setはその参照を変数に代入します。Set order = New COrderは両方を1行で行う書き方です。

まとめ:1件の値と処理をクラスにまとめる

標準モジュールを実行の入口にし、COrderへ1件の注文の値と検証を集めます。Property GetとLetで読み書きを分け、NewとSetで行ごとに別の注文を作ります。

複数件はCollectionへ入れて順に処理できます。エラー91が出たら参照がNothingのままではないかを確認し、入力値の問題は該当行まで戻って調べてください。

関連記事

あわせて読みたい記事

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

普段は主にPython開発をしています。
最近はAI駆動開発にも関わっています。