モジュール内のコードを操作する（CodeModule のメソッド）

2016/01/25

CodeModule オブジェクト

モジュール内のコードの追加、削除、編集等を行う場合に使用します。

【書式】

＜取得＞
object.CodeModule

引数・戻り値

object ・・・対象となる VBComponent オブジェクトを指定します。

CodeModule の主なメソッド

CodeModule.AddFromFile メソッド

指定したファイルの内容を対象のオブジェクト（モジュール）に追加します。
この時、モジュール内にすでにプロシージャが存在する場合は、最も上にあるプロシージャの上に挿入されます。プロシージャが含まれていない場合は、モジュールの最後に追加されます。

【書式】

object.AddFromFile ( filename )

引数・戻り値

object ・・・対象となる CodeModule オブジェクトを指定します。
filename ・・・ object で指定したモジュールに追加するファイルの名前（パス含む）を表す文字列式を指定します。

CodeModule.AddFromString メソッド

指定した文字列を対象のオブジェクト（モジュール）に追加します。
この時、モジュール内にすでにプロシージャが存在する場合は、最も上にあるプロシージャの上に挿入されます。プロシージャが含まれていない場合は、モジュールの最後に追加されます。

【書式】

object.AddFromString ( string )

引数・戻り値

object ・・・対象となる CodeModule オブジェクトを指定します。
string ・・・ object で指定したモジュールに追加する文字列を指定します。

CodeModule.DeleteLines メソッド

モジュールに記載されているコードを削除します。startline に指定した行から count に指定した行数を削除します。

【書式】

object.DeleteLines ( startline [, count ] )

引数・戻り値

object ・・・対象となる CodeModule オブジェクトを指定します。
startline ・・・削除する先頭行を長整数型（Long）の値で指定します。
count ・・・削除する行数を長整数型（Long）の値を指定します。省略した場合は、1 行削除されます。

CodeModule.InsertLines メソッド

指定した行に、文字列（コード）を挿入します。

【書式】

object.InsertLines ( startline, code )

引数・戻り値

object ・・・対象となる CodeModule オブジェクトを指定します。
startline ・・・挿入する行を長整数型（Long）の値で指定します。
code ・・・挿入するコードを文字列型（String）で指定します。文字列に、改行コード（キャリッジリターン、ラインフィード）を含んでいる場合は、連続した行として挿入されます。

CodeModule.ReplaceLine メソッド

既存の指定した行を指定したコードに置き換えます。

【書式】

object.ReplaceLine ( startline, code )

引数・戻り値

object ・・・対象となる CodeModule オブジェクトを指定します。
startline ・・・置換する行を長整数型（Long）の値で指定します。
code ・・・置換するコードを文字列型（String）で指定します。

CodeModule メソッド使用例

AddFromFile メソッド / AddFromString メソッドを使ったサンプル

　
Sub Sample_CodeModule04()
    'AddFromFile メソッド
    'AddFromString メソッド

    Dim FileName As String
    Dim FileCode As String
    Dim w As Workbook
    Dim stdm As Object
    Dim str As String
    
    FileName = "C:\Documents\test01.xlsm"
    FileCode = "C:\Documents\tmp\code.txt"
    
    'ブック（test01.xlsm）をオープン
    Set w = Workbooks.Open(FileName)

    With w.VBProject.VBComponents
        
        '標準モジュール（Module1）に、code.txt の内容（sample_macro01）を追加
        .Item("Module1").CodeModule.AddFromFile (FileCode)
        
        '標準モジュール（Module1）に、テキストを追加
        .Item("Module1").CodeModule.AddFromString "public myValue as integer"

    End With
    
    '追加したマクロ（sample_macro01）を実行
    Application.Run "'" & FileName & "'" & "!sample_macro01"
    
    
    Application.DisplayAlerts = False
    
    '保存して終了
    w.Save
    w.Close
    Set w = Nothing
    
    Application.DisplayAlerts = True

End Sub

Sub Sample_CodeModule04()

'AddFromFile メソッド

'AddFromString メソッド

Dim FileName As String

Dim FileCode As String

Dim w As Workbook

Dim stdm As Object

Dim str As String

FileName = "C:\Documents\test01.xlsm"

FileCode = "C:\Documents\tmp\code.txt"

'ブック（test01.xlsm）をオープン

Set w = Workbooks.Open(FileName)

With w.VBProject.VBComponents

'標準モジュール（Module1）に、code.txt の内容（sample_macro01）を追加

.Item("Module1").CodeModule.AddFromFile (FileCode)

'標準モジュール（Module1）に、テキストを追加

.Item("Module1").CodeModule.AddFromString "public myValue as integer"

End With

'追加したマクロ（sample_macro01）を実行

Application.Run "'" & FileName & "'" & "!sample_macro01"

Application.DisplayAlerts = False

'保存して終了

w.Save

w.Close

Set w = Nothing

Application.DisplayAlerts = True

End Sub

実行結果 1

「AddFromFile メソッド / AddFromString メソッドを使ったサンプル」を実行する前の test01.xlsm の Module1 の内容

code.txt の内容（sample_macro01）

「AddFromFile メソッド / AddFromString メソッドを使ったサンプル」を実行

「AddFromFile メソッド / AddFromString メソッドを使ったサンプル」を実行後の test01.xlsm の Module1 の内容

DeleteLines メソッド / ProcBodyLine プロパティ / ProcCountLines プロパティ / Lines プロパティを使ったサンプル

　
Sub Sample_CodeModule05()
    
    '※ Sample_CodeModule04() を実行後に実行
    
    'DeleteLines メソッド
    'ProcBodyLine プロパティ
    'ProcCountLines プロパティ
    'Lines プロパティ

    Dim FileName As String
    Dim FileCode As String
    Dim w As Workbook
    Dim LineS As Integer
    Dim LineE As Integer
    Dim str As String
    
    FileName = "C:\Documents\test01.xlsm"
    FileCode = "C:\Documents\tmp\code.txt"
    
    'ブック（test01.xlsm）をオープン
    Set w = Workbooks.Open(FileName)

    With w.VBProject.VBComponents.Item("Module1").CodeModule
    
        'Sample_CodeModule04で追加したプロシージャ（sample_macro01）を削除
            
        'Module1 のプロシージャ「sample_macro01」の開始行を取得
        LineS = .ProcStartLine("sample_macro01", 0)
        
        'Module1 のプロシージャ「sample_macro01」の行数を取得
        LineE = .ProcCountLines("sample_macro01", 0)
        
        'プロシージャ「sample_macro01」の内容を変数に格納
        str = .LineS(LineS, LineE)
        
        'sample_macro01 を開放（削除）
        .DeleteLines LineS, LineE
        
        
        'Sample_CodeModule04で追加したテキスト（4行目のみ）を削除
        .DeleteLines 4
        
    End With
    
        'sample_macro01（削除済）の内容を表示
        MsgBox str
    

    Application.DisplayAlerts = False
    
    '保存して終了
    w.Save
    w.Close
    Set w = Nothing

    Application.DisplayAlerts = True
    
End Sub

Sub Sample_CodeModule05()

'※ Sample_CodeModule04() を実行後に実行

'DeleteLines メソッド

'ProcBodyLine プロパティ

'ProcCountLines プロパティ

'Lines プロパティ

Dim FileName As String

Dim FileCode As String

Dim w As Workbook

Dim LineS As Integer

Dim LineE As Integer

Dim str As String

FileName = "C:\Documents\test01.xlsm"

FileCode = "C:\Documents\tmp\code.txt"

'ブック（test01.xlsm）をオープン

Set w = Workbooks.Open(FileName)

With w.VBProject.VBComponents.Item("Module1").CodeModule

'Sample_CodeModule04で追加したプロシージャ（sample_macro01）を削除

'Module1 のプロシージャ「sample_macro01」の開始行を取得

LineS = .ProcStartLine("sample_macro01", 0)

'Module1 のプロシージャ「sample_macro01」の行数を取得

LineE = .ProcCountLines("sample_macro01", 0)

'プロシージャ「sample_macro01」の内容を変数に格納

str = .LineS(LineS, LineE)

'sample_macro01 を開放（削除）

.DeleteLines LineS, LineE

'Sample_CodeModule04で追加したテキスト（4行目のみ）を削除

.DeleteLines 4

End With

'sample_macro01（削除済）の内容を表示

MsgBox str

Application.DisplayAlerts = False

'保存して終了

w.Save

w.Close

Set w = Nothing

Application.DisplayAlerts = True

End Sub

実行結果 2

Sample_CodeModule04() を実行後の test01.xlsm の Module1 の内容

「DeleteLines メソッド / ProcBodyLine プロパティ / ProcCountLines プロパティ / Lines プロパティを使ったサンプル」を実行

「DeleteLines メソッド / ProcBodyLine プロパティ / ProcCountLines プロパティ / Lines プロパティを使ったサンプル」を実行後の test01.xlsm の Module1 の内容

InsertLines メソッド / ReplaceLine メソッドを使ったサンプル

　
Sub Sample_CodeModule06()
    
    'InsertLines メソッド
    'ReplaceLine メソッド

    Dim FileName As String
    Dim w As Workbook
    Dim str As String
    
    FileName = "C:\Documents\test02.xlsm"

    'ブック（test02.xlsm）をオープン
    Set w = Workbooks.Open(FileName)

    With w.VBProject.VBComponents.Item("Module1").CodeModule
                
        '文字列を挿入
        .InsertLines 7, "    str=""おはようございます。"""
        
        '文字列置換
        .ReplaceLine 9, "    msgbox str"
        
        'Module1 の内容
        str = .LineS(1, .CountOfLines)
        
    End With
    
        'Module1 の内容を表示
        MsgBox str
    
    Application.DisplayAlerts = False
    
    '保存して終了
    w.Save
    w.Close
    Set w = Nothing
    
    Application.DisplayAlerts = True
    
End Sub